ECharts のよく使われる API(ECharts と EChartsInstance)
Echarts でよく使われる API は主に echarts と echartsInstance の 2 つのオブジェクトです。
- echartsオブジェクト
- echarts.init(dom, theme, opts) は、dom ノード、テーマ、および構成項目を受け取って ECharts インスタンスを初期化します。
- echarts.version:ECharts の バージョン番号を取得します。
- echarts.registerMap(マップ名, geoJson, 特殊地区):カスタムマップを登録する
- echarts.getMap(mapName) で、地図の GeoJSON データを取得します。
- echarts.registerTheme(themeName, theme)で独自のテーマを登録します。
- echarts.getTheme(themeName):テーマのデータを取得します。
- echarts.dispose(dom)で、EChartsインスタンスを破棄して、リソースを解放できます。
- echartsInstanceオブジェクト:
- setOption(option, notMerge, lazyUpdate): グラフの設定項目とデータを設定。パラメータをマージしないかどうかを示す notMerge は、デフォルトが false です。更新を遅延するかどうかを示す lazyUpdate は、デフォルトが false です。
- getWidth():グラフの幅を取得します。
- getHeight():チャートの高さを取得します。
- getDom():チャートが配置されているDOMノードを取得します。
- getOption():グラフの設定を取得します。
- resize():グラフのサイズを変更します。
- dispatchAction(ペイロード): 特定の行動の説明であるペイロードをパラメーターとして、チャートの行動(例: 特定のシリーズのアイконをクリックする)をトリガーします。
- on(eventName, handler): イベント処理関数をバインドします(click、legendselectchanged など)
- off(eventName, handler):イベントハンドラを解除します。
echarts.init()メソッドで作成したechartsインスタンスオブジェクト経由で、これらのAPIを利用できます。例えば:
var myChart = echarts.init(dom);
myChart.setOption(option);
optionはチャートのスタイルやデータ、シリーズなどを記述する設定項目です。