echarts(Object)

Global echarts object, which can be accessed after including echarts.js in script tag or through require('echarts') in AMD environment.

init(Function)

(dom: HTMLDivElement|HTMLCanvasElement, theme?: Object|string, opts?: {
    devicePixelRatio?: number,
    renderer?: string,
    useDirtyRect?: boolean, // Since `5.0.0`
    width?: number|string,
    height?: number|string,
    locale?: string
}) => ECharts

Creates an ECharts instance, and returns an echartsInstance. You shall not initialize multiple ECharts instances on a single container.

Parameters

dom
Instance container, usually is a div element with height and width defined.
**Attention: **If div is hidden, ECharts initialization tends to fail due to the lack of width and height information. In this case, you can explicitly specify style.width and style.height of div, or manually call echartsInstance.resize after showing div.
ECharts 3 supports using canvas element as container directly, thus the canvas can be used somewhere else as image directly after rendering the chart. For example, canvas can be used as a texture in WebGL, which enables updating charts in real-time, as compared to using images generated with echartsInstance.getDataURL.
theme
Theme to be applied. This can be a configuring object of a theme, or a theme name registered through echarts.registerTheme. See Overview of Style Customization.
opts
Optional chart configurations; which may contain:
- devicePixelRatio Ratio of one physical pixel to the size of one device independent pixels. Browser's window.devicePixelRatio is used by default.
- renderer Supports 'canvas' or 'svg'. See Render by Canvas or SVG.
- useDirtyRect Enable dirty rectangle rendering or not, false by default. See New features in ECharts 5.
- width Specify width explicitly, in pixel. If setting to null/undefined/'auto', width of dom (instance container) will be used.
- height Specify height explicitly, in pixel. If setting to null/undefined/'auto', height of dom (instance container) will be used.
- locale Specify the locale. There are two builtins: 'ZH' and 'EN'. Or you can use echarts.registerLocale to register a new locale. Or supported locales can be referenced in src/i18n.
If no need to specify a theme, a null should be passed before opts . Example:
```
const chart = echarts.init(dom, null, {renderer: 'svg'});
```

connect(Function)

(group:string|Array)

Connects interaction of multiple chart series.

Parameters

group Group id, or array of chart instance.

**For example: **

// set group id of each instance respectively.
chart1.group = 'group1';
chart2.group = 'group1';
echarts.connect('group1');
// or incoming instance array that need to be linked.
echarts.connect([chart1, chart2]);

disconnect(Function)

(group:string)

Disconnects interaction of multiple chart series. To have one single instance to be removed, you can set group of chart instance to be null.

Parameters

group
group id.

dispose(Function)

(target: ECharts|HTMLDivElement|HTMLCanvasElement)

Destroys chart instance, after which the instance cannot be used any more.

getInstanceByDom(Function)

(target: HTMLDivElement|HTMLCanvasElement) => ECharts

Returns chart instance of dom container.

use(Function)

Since 5.0.1

Use components. Used with the new tree-shaking API.

NOTE: echarts.use must be used before eharts.init

// Import the echarts core module, which provides the necessary interfaces for using echarts.
import * as echarts from 'echarts/core';
// Import bar charts, all with Chart suffix
import {
    BarChart
} from 'echarts/charts';
// import rectangular coordinate system component, all suffixed with Component
import {
    GridComponent
} from 'echarts/components';
// Import the Canvas renderer, note that introducing the CanvasRenderer or SVGRenderer is a required step
import {
    CanvasRenderer
} from 'echarts/renderers';

// Register the required components
echarts.use(
    [GridComponent, BarChart, CanvasRenderer]
);

See Use ECharts with bundler and NPM for more detailed explaination.

registerMap(Function)

(
    mapName: string,
    opt: {
        geoJSON: Object | string;
        specialAreas?: Object;
    }
)
| (
    mapName: string,
    opt: {
        svg: Object | string;
    }
)
| (
    mapName: string,
    geoJSON: Object | string,
    specialAreas?: Object
)

Registers available maps. This can only be used after including geo component or chart series of map.

Please refer to option.geo for usage.

Parameters

mapName
Map name, referring to map value set in geo component or map.

opt

geoJSON
Optional; Data in GeoJson format. See https://geojson.org/ for more format information. Can be a JSON string or a parsed object. This key can also be geoJson.
svg
Optional; Data in SVG format. Can be a SVG string or a parsed SVG DOM object. See more info in SVG_a_a_a_a_a.

specialAreas

Optional; zoomed part of a specific area in the map for better visual effect.

Only work for geoJSON, not work for svg.

**For example USA Population Estimates: **

echarts.registerMap('USA', usaJson, {
    // Move Alaska to the bottom left of United States
    Alaska: {
        // Upper left longitude
        left: -131,
        // Upper left latitude
        top: 25,
        // Range of longitude
        width: 15
    },
    // Hawaii
    Hawaii: {
        left: -110,
        top: 28,
        width: 5
    },
    // Puerto Rico
    'Puerto Rico': {
        left: -76,
        top: 26,
        width: 2
    }
});

getMap(Function)

(mapName: string)

Get a registered map in the following format:

{
    // geoJSON data of the map
    geoJSON: Object,
    // special area, see registerMap() for more information
    specialAreas: Object
}

Note:

geoJSON can also be geoJson, they have the same reference.
SVG registered by registerMap can not be obtained by this method yet.

registerTheme(Function)

(themeName: string, theme: Object)

Registers a theme, should be specified when initialize the chart instance.

registerLocale(Function)

Since 5.0.0

(locale: string, localeCfg: Object)

Registers a locale, should be specified when initialize the chart instance. See the format in src/i18n/langEN.ts