跳到主要内容

.GlobalModel

ECharts 的 GlobalModel 类,继承自 Model 类。

查看源码

配置项

getOption()

getOption(): ECUnitOption

查看源码 (v5.0.0+)

获取当前 ECharts 实例的所有配置项。

返回值

名称类型描述
optionECUnitOptionecharts 实例的所有配置项

getTheme()

getTheme(): Model

查看源码 (v5.0.0+)

获取当前 ECharts 实例配置的主题模型实例。

组件实例

getComponent()

getComponent(mainType: ComponentMainType, idx?: number): ComponentModel

查看源码 (v5.0.0+)

获取指定主要类型的指定索引的组件 Model 实例。

参数

名称类型默认值描述
mainTypeComponentMainType组件的主要类型,例如 tooltipseries
idxnumber0索引

返回值

名称类型描述
componentModelComponentModel组件的 Model 实例,ComponentModel 只是基类

示例

const result = ecModel.getComponent('tooltip', 0);

queryComponents()

queryComponents(condition: QueryConditionKindB): ComponentModel[]

查看源码 (v5.0.0+)

获取符合条件的所有组件 Model 实例。

参数

名称类型默认值描述
conditionQueryConditionKindB多个查询条件

返回值

名称类型描述
componentModelsComponentModel[]组件的 Model 实例数组,ComponentModel 只是基类

示例

const result = ecModel.queryComponents({
mainType: 'series',
subType: 'bar',
});

findComponents()

findComponents(condition: QueryConditionKindA): ComponentModel[]

查看源码 (v5.0.0+)

查找过滤符合条件的所有组件 Model 实例。

参数

名称类型默认值描述
conditionQueryConditionKindA多个查询条件

返回值

名称类型描述
componentModelsComponentModel[]组件的 Model 实例数组,ComponentModel 只是基类

示例

let result = ecModel.findComponents(
{ mainType: 'dataZoom', query: { dataZoomId: 'abc' } }
);
let result = ecModel.findComponents(
{ mainType: 'series', subType: 'pie', query: { seriesName: 'uio' } }
);
let result = ecModel.findComponents(
{ mainType: 'series', filter: function (model, index) {...} }
);

eachComponent()

eachComponent<T>(mainType: string | QueryConditionKindA | EachComponentAllCallback, cb?: EachComponentInMainTypeCallback | T, context?: T)

查看源码 (v5.0.0+)

遍历所以(或者符合条件的) Model 实例。

参数

名称类型默认值描述
mainTypestring | QueryConditionKindA | EachComponentAllCallback组件的主要类型、或者查询条件集合、或者回调函数
cbEachComponentAllCallbackundefined回调函数
contextunknownundefined回调函数的执行上下文

示例

let result = ecModel.eachComponent('legend', function (legendModel, index) {
// TODO
});
let result = ecModel.eachComponent(function (componentType, model, index) {
// componentType does not include subType
// (componentType is 'a' but not 'a.b')
});
let result = ecModel.eachComponent(
{ mainType: 'dataZoom', query: { dataZoomId: 'abc' } },
function (model, index) {
// TODO
}
);
let result = ecModel.eachComponent(
{ mainType: 'series', subType: 'pie', query: { seriesName: 'uio' } },
function (model, index) {
// TODO
}
);

系列实例

getSeries()

getSeries(): SeriesModel[]

查看源码 (v5.0.0+)

获取所有系列组件的 Model 实例。

返回值

名称类型描述
seriesModelsSeriesModel[]系列组件的 Model 实例数组,SeriesModel 只是基类

getSeriesByType()

getSeriesByType(subType: ComponentSubType): SeriesModel[]

查看源码 (v5.0.0+)

获取指定类型的所有系列组件的 Model 实例。

参数

名称类型默认值描述
subTypeComponentSubType系列类型,例如 barline

返回值

名称类型描述
seriesModelsSeriesModel[]系列组件的 Model 实例数组,SeriesModel 只是基类

eachSeries()

eachSeries<T>(cb: (series: SeriesModel, rawSeriesIndex: number) => void, context?: T)

查看源码 (v5.0.0+)

遍历所有系列组件的 Model 实例。

参数

名称类型默认值描述
cb(series: SeriesModel, rawSeriesIndex: number) => void回调函数
contextunknownundefined回调函数的执行上下文

eachSeriesByType()

eachSeriesByType<T>(subType: ComponentSubType, cb: (series: SeriesModel, rawSeriesIndex: number) => void, context?: T)

查看源码 (v5.0.0+)

遍历指定类型的所有系列组件的 Model 实例。

参数

名称类型默认值描述
subTypeComponentSubType系列类型,例如 barline
cb(series: SeriesModel, rawSeriesIndex: number) => void回调函数
contextunknownundefined回调函数的执行上下文