---
title: API
order: 3
---
<br/>

| 参数名         | 说明              | 必填 | 类型                                                          | 默认值 | 备注 |
|----------------|-----------------|------|---------------------------------------------------------------|--------|------|
| options        | g2 options配置    | Y    | [ChartCfg ](#chartcfg)                                        | -      |      |
| config         | g2 构造方法的入参 | Y    | [Options](#options)                                           | -      |      |
| className      | 类名              | N    | String                                                        | -      |      |
| title          | 图表标题          | N    | React.ReactNode                                               | -      |      |
| titleOptions   | 标题配置          | N    | [ITitle](../?demo=Text_Title)                                 | -      |      |
| universalStyle | 通用样式          | N    | [UniversalStyle](../?demo=Chart_MiniLineChart#universalstyle) | -      |      |
| onInit         | 初始化回调        | N    | (chart: ECharts) => void;                                     | -      |      |


### ChartCfg

```typescript
interface ChartCfg extends Omit<ViewCfg, 'parent' | 'canvas' | 'foregroundGroup' | 'middleGroup' | 'backgroundGroup' | 'region'> {
    /** 指定 chart 绘制的 DOM，可以传入 DOM id，也可以直接传入 dom 实例。 */
    readonly container: string | HTMLElement;
    /** 图表宽度。 */
    readonly width?: number;
    /** 图表高度。 */
    readonly height?: number;
    /**
     * 图表是否自适应容器宽高，默认为 false，用户需要手动设置 width 和 height。
     * 当 `autoFit: true` 时，会自动取图表容器的宽高，如果用户设置了 height，那么会以用户设置的 height 为准。
     */
    readonly autoFit?: boolean;
    /** 指定渲染引擎，默认使用 canvas。 */
    readonly renderer?: Renderer;
    /** 设置设备像素比，默认取浏览器的值 `window.devicePixelRatio`。 */
    readonly pixelRatio?: number;
    /**
     * 是否开启局部刷新，默认开启。
     */
    readonly localRefresh?: boolean;
    /** 支持 CSS transform，开启后图表的交互以及事件将在页面设置了 css transform 属性时生效，默认关闭。 */
    readonly supportCSSTransform?: boolean;
    /**
     * 配置图表默认交互，仅支持字符串形式。
     */
    readonly defaultInteractions?: string[];
}
```

### Options

```typescript
interface Options {
    /** 数据源配置。 */
    readonly data?: Data;
    /** 设置数据过滤条件，以 data 中的数据属性为 key。 */
    readonly filters?: Record<string, FilterCondition>;
    /** 坐标轴配置，以 data 中的数据属性为 key。 */
    readonly axes?: Record<string, AxisOption> | boolean;
    /** 图例配置，以 data 中的数据属性为 key。 */
    readonly legends?: AllLegendsOptions;
    /** 列定义配置，用于配置数值的类型等，以 data 中的数据属性为 key。 */
    readonly scales?: Record<string, ScaleOption>;
    /** Tooltip 配置。 */
    readonly tooltip?: TooltipOption;
    /** 坐标系配置。 */
    readonly coordinate?: CoordinateOption;
    /** 静态辅助元素声明。 */
    readonly annotations?: (ArcOption | RegionFilterOption | ImageOption | LineOption | TextOption | RegionOption | DataMarkerOption | DataRegionOption)[];
    /** Geometry 配置 */
    readonly geometries?: GeometryOption[];
    /** 开启/关闭动画，默认开启 */
    readonly animate?: boolean;
    /** 配置需要使用的交互行为 */
    readonly interactions?: InteractionOption[];
    /** 事件配置 */
    readonly events?: EventCfg;
    /** 缩略轴的配置 */
    readonly slider?: SliderOption;
    /** 滚动条配置 */
    readonly scrollbar?: ScrollbarOption;
    /** 子 View */
    readonly views?: ViewOption[];
    /** 分面 */
    readonly facets?: (RectCfg | MirrorCfg | CircleCfg | ListCfg | TreeCfg)[];
    /** 其他自定义的 option */
    readonly [name: string]: any;
}
```