echarts

ECharts 模块直接暴露的 APIs。

查看源码

官方 APIs 文档

扩展

use()

提示

use() 方法在官方文档中的描述比较简单，主要用例是做_按需加载_，实际上这是 ECharts 的核心扩展机制。对于 ECharts 能力的定制和扩展，官方的解决方案就是基于 use() API 实现。

use(ext: EChartsExtensionInstaller | EChartsExtension | (EChartsExtensionInstaller | EChartsExtension)[])

查看源码 (v5.0.1+)

官方 APIs 文档

ECharts 的扩展 API。

参数

名称	类型	默认值	描述
ext	EChartsExtensionInstaller | EChartsExtension | (EChartsExtensionInstaller | EChartsExtension)[]		扩展（插件）

示例

echarts.use((extensionRegisters: EChartsExtensionInstallRegisters) => {
  // TODO
});

extensionRegisters

这是 use() API 用来注册一系列扩展功能的接口。

查看源码 (v5.0.1+)

registerPreprocessor()

提示

注册的预处理函数执行时机为每次 ecIns.setOption() 时。

registerPreprocessor(preprocessorFunc: OptionPreprocessor)

查看源码 (v5.0.1+)

注册配置项的预处理器。

参数

名称	类型	默认值	描述
preprocessorFunc	OptionPreprocessor		配置项预处理函数

示例

echarts.use((extensionRegisters: EChartsExtensionInstallRegisters) => {
  extensionRegisters.registerPreprocessor((option, isNew) => {
    // TODO
  });
});

registerAction()

信息

与注册（定义）交互行为动作相对应的，可以通过 ecIns.dispatchAction() API 调用来执行一系列交互行为动作。

registerAction(actionInfo: string | ActionInfo, eventName: string | ActionHandler, action?: ActionHandler)

查看源码 (v5.0.1+)

注册一个交互行为动作。

参数

名称	类型	默认值	描述
actionInfo	string | ActionInfo		动作信息
eventName	string | ActionHandler		事件名称
action	ActionHandler	undefined	实际执行交互行为动作的函数

示例

echarts.use((extensionRegisters: EChartsExtensionInstallRegisters) => {
  extensionRegisters.registerAction(
    'testaction',
    (payload: Payload, ecModel: GlobalModel, api: ExtensionAPI) => {
      // TODO
    }
  );
});

ecIns.dispatchAction({ type: 'testaction' /* ...rest payload data */ });

registerUpdateLifecycle()

registerUpdateLifecycle<T extends keyof LifecycleEvents>(name: T, cb: (...args: LifecycleEvents[T]) => void)

查看源码 (v5.0.1+)

注册程序更新的生命周期 Hook。

参数

名称	类型	默认值	描述
name	keyof LifecycleEvents		程序更新生命周期 hook 名称
cb	LifecycleEvents[keyof LifecycleEvents]		回调函数

示例

echarts.use((extensionRegisters: EChartsExtensionInstallRegisters) => {
  extensionRegisters.registerUpdateLifecycle(
    'series:afterupdate',
    (
      ecModel: GlobalModel,
      api: ExtensionAPI,
      params: UpdateLifecycleParams
    ) => {
      // TODO
    }
  );
});

相关

• registerPostInit()
• registerPostUpdate()

registerPostInit()

registerPostInit(postInitFunc: PostIniter)

查看源码 (v5.0.1+)

注册程序完成初始化的 Hook。

参数

名称	类型	默认值	描述
postInitFunc	PostIniter		回调函数

示例

echarts.use((extensionRegisters: EChartsExtensionInstallRegisters) => {
  extensionRegisters.registerPostInit((chart: EChartsType) => {
    // TODO
  });

  // 等同于
  extensionRegisters.registerUpdateLifecycle(
    'afterinit',
    (chart: EChartsType) => {
      // TODO
    }
  );
});

相关

• registerUpdateLifecycle()

registerPostUpdate()

registerPostUpdate(postUpdateFunc: PostUpdater)

查看源码 (v5.0.1+)

注册程序完成更新的 Hook。

参数

名称	类型	默认值	描述
postUpdateFunc	PostUpdater		回调函数

示例

echarts.use((extensionRegisters: EChartsExtensionInstallRegisters) => {
  extensionRegisters.registerPostUpdate(
    (ecModel: GlobalModel, api: ExtensionAPI) => {
      // TODO
    }
  );

  // 等同于
  extensionRegisters.registerUpdateLifecycle(
    'afterupdate',
    (ecModel: GlobalModel, api: ExtensionAPI) => {
      // TODO
    }
  );
});

相关

• registerUpdateLifecycle()

api

这是用来在 use() API 注册的一系列扩展的回调函数中获取部分 ECharts 实例信息的接口。

查看源码 (v5.0.1+)