UNPKG

1.25 kBTypeScriptView Raw
1import React from 'react';
2import { Plot } from '@antv/g2plot/lib/core/plot';
3interface VisibleText {
4 visible?: boolean;
5 text: string;
6}
7interface BasePlotOptions {
8 /**
9 * 获取g2Plot实例的勾子函数
10 */
11 onGetG2Instance?: (chart: Plot<any>) => void;
12 errorContent?: React.ReactNode;
13 /**
14 * 图表事件
15 */
16 events?: Record<string, Function>;
17 /**
18 * 图表标题。如需绑定事件请直接使用ReactNode。
19 */
20 readonly title?: React.ReactNode | VisibleText;
21 /**
22 * 图表副标题。如需绑定事件请直接使用ReactNode。
23 */
24 readonly description?: React.ReactNode | VisibleText;
25 /**
26 * 请使用autoFit替代forceFit
27 */
28 forceFit?: boolean;
29 /**
30 * 是否是物料组件,因搭建引擎消费ref和原来的组件吐的react实例不兼容。
31 * 该属性会影响ref的消费,为ali-lowcode-engine消费而生。
32 */
33 isMaterial?: boolean;
34}
35export { BasePlotOptions };
36declare function createPlot<IPlotConfig extends Record<string, any>>(PlotClass: any, name: string, transCfg?: Function): React.ForwardRefExoticComponent<React.PropsWithoutRef<IPlotConfig> & React.RefAttributes<any>>;
37export default createPlot;