interval.d.ts 1.6 KB

123456789101112131415161718192021222324252627282930313233343536
  1. import { ShapeAttrs } from '@antv/g2';
  2. import { Params } from '../../core/adaptor';
  3. import { GeometryOptions, MappingOptions } from './base';
  4. export interface IntervalGeometryOptions extends GeometryOptions {
  5. /** x 轴字段 */
  6. readonly xField: string;
  7. /** y 轴字段 */
  8. readonly yField: string;
  9. /** 拆分字段,在分组柱状图下同 groupField、colorField,在堆积柱状图下同 stackField、colorField */
  10. readonly seriesField?: string;
  11. /** 是否分组柱形图 */
  12. readonly isGroup?: boolean;
  13. /** 是否堆积柱状图 */
  14. readonly isStack?: boolean;
  15. /** 柱状图宽度占比 [0-1] */
  16. readonly widthRatio?: number;
  17. /** 分组间柱子之间的组间间距(像素级),仅对分组柱状图适用 */
  18. readonly intervalPadding?: number;
  19. /** 分组中柱子之间的间距 [0-1],仅对分组柱状图适用 */
  20. readonly marginRatio?: number;
  21. /** 分组中柱子之间的组内间距(像素级),仅对分组柱状图适用 */
  22. readonly dodgePadding?: number;
  23. /** 柱状图最小宽度(像素) */
  24. readonly minColumnWidth?: number;
  25. /** 柱状图最大宽度(像素) */
  26. readonly maxColumnWidth?: number;
  27. /** 柱子的背景样式设置 */
  28. readonly columnBackground?: {
  29. style: ShapeAttrs;
  30. };
  31. /** 柱子视觉通道配置(含 color、shape、size、style、tooltip) */
  32. readonly interval?: MappingOptions;
  33. /** 分组字段,优先级高于 seriesField , isGroup: true 时会根据 groupField 进行分组。*/
  34. readonly groupField?: string;
  35. }
  36. export declare function interval<O extends IntervalGeometryOptions>(params: Params<O>): Params<O>;