Chart.js

# 接口: Plugin<TType, O>

# 类型参数

名称 类型
TType 扩展 ChartType = ChartType
O AnyObject

# 层次结构

# 属性

# 默认值

• 可选 defaults: Partial<O>

插件中使用的默认选项

# 定义于

types/index.d.ts:1122 (新窗口打开)

# 事件

• 可选 events: keyof HTMLElementEventMap[]

events 选项定义了插件应该监听的浏览器事件。

默认

['mousemove', 'mouseout', 'click', 'touchstart', 'touchmove']

# 定义于

types/index.d.ts:823 (新窗口打开)

# id

• id: string

# 定义于

types/index.d.ts:817 (新窗口打开)

# 方法

# afterBuildTicks

▸ 可选 afterBuildTicks(chart, args, options): void

描述

在比例尺构建其刻度后调用。此钩子针对图表中的每个比例尺分别调用。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args 对象 调用参数。
args.scale Scale<CoreScaleOptions> 比例尺。
options O 插件选项。

# 返回

void

# 定义于

types/index.d.ts:982 (新窗口打开)

# afterDataLimits

▸ 可选 afterDataLimits(chart, args, options): void

描述

在计算比例尺数据限制后调用。此钩子针对图表中的每个比例尺分别调用。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args 对象 调用参数。
args.scale Scale<CoreScaleOptions> 比例尺。
options O 插件选项。

# 返回

void

# 定义于

types/index.d.ts:966 (新窗口打开)

# afterDatasetDraw

▸ 可选 afterDatasetDraw(chart, args, options): void

描述

在绘制给定 args.index 的 chart 数据集后调用（数据集按相反顺序绘制）。请注意，如果数据集绘制先前被取消，则不会调用此钩子。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args 对象 调用参数。
args.index number 数据集索引。
args.meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> 数据集元数据。
options O 插件选项。

# 返回

void

# 定义于

types/index.d.ts:1064 (新窗口打开)

# afterDatasetUpdate

▸ 可选 afterDatasetUpdate(chart, args, options): void

描述

在更新给定 args.index 的 chart 数据集后调用。请注意，如果数据集更新先前被取消，则不会调用此钩子。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args 对象 调用参数。
args.cancelable false -
args.index number 数据集索引。
args.meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> 数据集元数据。
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" 更新模式。
options O 插件选项。

# 返回

void

# 定义于

types/index.d.ts:941 (新窗口打开)

# afterDatasetsDraw

▸ 可选 afterDatasetsDraw(chart, args, options, cancelable): void

描述

在绘制 chart 数据集后调用。请注意，如果数据集绘制先前被取消，则不会调用此钩子。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args EmptyObject 调用参数。
options O 插件选项。
cancelable false -

# 返回

void

# 定义于

types/index.d.ts:1041 (新窗口打开)

# afterDatasetsUpdate

▸ 可选 afterDatasetsUpdate(图表, 参数, 选项): void

描述

在 图表 数据集更新后调用。请注意，如果数据集更新之前已被取消，则不会调用此钩子。

从

版本 2.1.5

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args 对象 调用参数。
args.cancelable true -
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" 更新模式。
options O 插件选项。

# 返回值

void

# 定义于

types/index.d.ts:918 (opens new window)

# afterDestroy

▸ 可选 afterDestroy(图表, 参数, 选项): void

在图表被销毁后调用。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args EmptyObject 调用参数。
options O 插件选项。

# 返回值

void

# 定义于

types/index.d.ts:1109 (opens new window)

# afterDraw

▸ 可选 afterDraw(图表, 参数, 选项): void

描述

在 图表 绘制后调用。请注意，如果绘制之前已被取消，则不会调用此钩子。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args EmptyObject 调用参数。
options O 插件选项。

# 返回值

void

# 定义于

types/index.d.ts:1024 (opens new window)

# afterEvent

▸ 可选 afterEvent(图表, 参数, 选项): void

描述

在 事件 被消耗后调用。请注意，如果 事件 之前已被丢弃，则不会调用此钩子。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args 对象 调用参数。
args.cancelable false -
args.changed? boolean 如果插件需要渲染，则设置为 true。应该只更改为 true，因为此参数对象将传递给所有插件。
args.event ChartEvent 事件对象。
args.inChartArea boolean 事件位置在图表区域内
args.replay boolean 如果此事件是从 Chart.update 中重播的，则为 true
options O 插件选项。

# 返回值

void

# 定义于

types/index.d.ts:1087 (opens new window)

# afterInit

▸ 可选 afterInit(图表, 参数, 选项): void

描述

在 图表 初始化后且首次更新前调用。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args EmptyObject 调用参数。
options O 插件选项。

# 返回值

void

# 定义于

types/index.d.ts:862 (opens new window)

# afterLayout

▸ 可选 afterLayout(图表, 参数, 选项): void

描述

在 图表 布局后调用。请注意，如果布局更新之前已被取消，则不会调用此钩子。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args EmptyObject 调用参数。
options O 插件选项。

# 返回值

void

# 定义于

types/index.d.ts:990 (opens new window)

# afterRender

▸ 可选 afterRender(图表, 参数, 选项): void

描述

在 图表 完全渲染（动画完成）后调用。请注意，如果渲染之前已被取消，则不会调用此钩子。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args EmptyObject 调用参数。
options O 插件选项。

# 返回值

void

# 定义于

types/index.d.ts:1007 (opens new window)

# afterTooltipDraw

▸ 可选 afterTooltipDraw(图表, 参数, 选项): void

描述

在绘制 工具提示 后调用。请注意，如果工具提示绘制之前已被取消，则不会调用此钩子。

# 参数

名称 类型 描述
chart 图表<keyof 图表类型注册表, (number | [number, number] | 点 | 气泡数据点)[], unknown> 图表实例。
args 对象 调用参数。
args.tooltip 工具提示模型<TType> 工具提示。
options O 插件选项。

# 返回值

void

# 继承自

扩展插件.afterTooltipDraw

# 定义于

types/index.d.ts:2705 (opens new window)

# afterUpdate

▸ 可选 afterUpdate(图表, 参数, 选项): void

描述

在 图表 更新后且渲染前调用。请注意，如果图表更新之前已被取消，则不会调用此钩子。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args 对象 调用参数。
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" 更新模式
options O 插件选项。

# 返回值

void

# 定义于

types/index.d.ts:881 (opens new window)

# beforeBuildTicks

▸ 可选 beforeBuildTicks(图表, 参数, 选项): void

描述

在刻度尺构建其刻度之前调用。此钩子为图表中的每个刻度尺分别调用。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args 对象 调用参数。
args.scale Scale<CoreScaleOptions> 比例尺。
options O 插件选项。

# 返回值

void

# 定义于

types/index.d.ts:974 (opens new window)

# beforeDataLimits

▸ 可选 beforeDataLimits(图表, 参数, 选项): void

描述

在计算刻度尺数据限制之前调用。此钩子为图表中的每个刻度尺分别调用。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args 对象 调用参数。
args.scale Scale<CoreScaleOptions> 比例尺。
options O 插件选项。

# 返回值

void

# 定义于

types/index.d.ts:958 (opens new window)

# beforeDatasetDraw

▸ 可选 beforeDatasetDraw(图表, 参数, 选项): boolean | void

描述

在绘制 图表 数据集（在给定 args.index 位置，数据集以相反顺序绘制）之前调用。如果任何插件返回 false，则数据集绘制将被取消，直到另一个 渲染 被触发。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args 对象 调用参数。
args.index number 数据集索引。
args.meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> 数据集元数据。
options O 插件选项。

# 返回值

boolean | void

false 取消图表数据集绘制。

# 定义于

types/index.d.ts:1053 (opens new window)

# beforeDatasetUpdate

▸ 可选 beforeDatasetUpdate(图表, 参数, 选项): boolean | void

描述

在更新 图表 数据集（在给定 args.index 位置）之前调用。如果任何插件返回 false，则数据集更新将被取消，直到另一个 更新 被触发。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args 对象 调用参数。
args.cancelable true -
args.index number 数据集索引。
args.meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> 数据集元数据。
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" 更新模式。
options O 插件选项。

# 返回值

boolean | void

false 取消图表数据集绘制。

# 定义于

types/index.d.ts:930 (opens new window)

# beforeDatasetsDraw

▸ 可选 beforeDatasetsDraw(图表, 参数, 选项): boolean | void

描述

在绘制 图表 数据集之前调用。如果任何插件返回 false，则数据集绘制将被取消，直到另一个 渲染 被触发。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args 对象 调用参数。
args.cancelable true -
options O 插件选项。

# 返回值

boolean | void

false 取消图表数据集绘制。

# 定义于

types/index.d.ts:1033 (opens new window)

# beforeDatasetsUpdate

▸ Optional beforeDatasetsUpdate(chart, args, options): boolean | void

描述

在更新 chart 数据集之前调用。如果任何插件返回 false，数据集更新将被取消，直到另一个 update 被触发。

从

版本 2.1.5

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args 对象 调用参数。
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" 更新模式。
options O 插件选项。

# 返回值

boolean | void

false 以取消数据集更新。

# 定义于

types/index.d.ts:908 (opens new window)

# beforeDestroy

▸ Optional beforeDestroy(chart, args, options): void

在图表被销毁之前调用。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args EmptyObject 调用参数。
options O 插件选项。

# 返回值

void

# 定义于

types/index.d.ts:1102 (opens new window)

# beforeDraw

▸ Optional beforeDraw(chart, args, options): boolean | void

描述

在每个动画帧绘制 chart 之前调用。如果任何插件返回 false，帧绘制将被取消，直到另一个 render 被触发。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args 对象 调用参数。
args.cancelable true -
options O 插件选项。

# 返回值

boolean | void

false 以取消图表绘制。

# 定义于

types/index.d.ts:1016 (opens new window)

# beforeElementsUpdate

▸ Optional beforeElementsUpdate(chart, args, options): void

描述

在更新过程中调用，在任何图表元素被创建之前。这可以用于通过更改数据集内的 data 数组来进行数据降采样。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args EmptyObject 调用参数。
options O 插件选项。

# 返回值

void

# 定义于

types/index.d.ts:889 (opens new window)

# beforeEvent

▸ Optional beforeEvent(chart, args, options): boolean | void

描述

在处理指定的 event 之前调用。如果任何插件返回 false，该事件将被丢弃。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args 对象 调用参数。
args.cancelable true -
args.event ChartEvent 事件对象。
args.inChartArea boolean 事件位置在图表区域内
args.replay boolean 如果此事件是从 Chart.update 中重播的，则为 true
options O 插件选项。

# 返回值

boolean | void

# 定义于

types/index.d.ts:1075 (opens new window)

# beforeInit

▸ Optional beforeInit(chart, args, options): void

描述

在初始化 chart 之前调用。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args EmptyObject 调用参数。
options O 插件选项。

# 返回值

void

# 定义于

types/index.d.ts:855 (opens new window)

# beforeLayout

▸ Optional beforeLayout(chart, args, options): boolean | void

描述

在布局 chart 之前调用。如果任何插件返回 false，布局更新将被取消，直到另一个 update 被触发。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args 对象 调用参数。
args.cancelable true -
options O 插件选项。

# 返回值

boolean | void

false 以取消图表布局。

# 定义于

types/index.d.ts:950 (opens new window)

# beforeRender

▸ Optional beforeRender(chart, args, options): boolean | void

描述

在渲染 chart 之前调用。如果任何插件返回 false，渲染将被取消，直到另一个 render 被触发。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args 对象 调用参数。
args.cancelable true -
options O 插件选项。

# 返回值

boolean | void

false 以取消图表渲染。

# 定义于

types/index.d.ts:999 (opens new window)

# beforeTooltipDraw

▸ Optional beforeTooltipDraw(chart, args, options): boolean | void

描述

在绘制 tooltip 之前调用。如果任何插件返回 false，工具提示绘制将被取消，直到另一个 render 被触发。

# 参数

名称 类型 描述
chart 图表<keyof 图表类型注册表, (number | [number, number] | 点 | 气泡数据点)[], unknown> 图表实例。
args 对象 调用参数。
args.cancelable true -
args.tooltip 工具提示模型<TType> 工具提示。
options O 插件选项。

# 返回值

boolean | void

false 以取消图表工具提示绘制。

# 继承自

ExtendedPlugin.beforeTooltipDraw

# 定义于

types/index.d.ts:2696 (opens new window)

# beforeUpdate

▸ Optional beforeUpdate(chart, args, options): boolean | void

描述

在更新 chart 之前调用。如果任何插件返回 false，更新将被取消（以及随后的渲染），直到另一个 update 被触发。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args 对象 调用参数。
args.cancelable true -
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" 更新模式
options O 插件选项。

# 返回值

boolean | void

false 以取消图表更新。

# 定义于

types/index.d.ts:872 (opens new window)

# install

▸ Optional install(chart, args, options): void

描述

当插件为该图表实例安装时调用。此钩子也为禁用的插件调用（options === false）。

从

3.0.0

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args EmptyObject 调用参数。
options O 插件选项。

# 返回值

void

# 定义于

types/index.d.ts:832 (opens new window)

# reset

▸ Optional reset(chart, args, options): void

描述

在图表重置时调用

从

version 3.0.0

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args EmptyObject 调用参数。
options O 插件选项。

# 返回值

void

# 定义于

types/index.d.ts:897 (opens new window)

# resize

▸ Optional resize(chart, args, options): void

描述

在图表被调整大小后调用。

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args 对象 调用参数。
args.size 对象 新的画布显示大小（例如 canvas.style width & height）。
args.size.height number -
args.size.width number -
options O 插件选项。

# 返回值

void

# 定义于

types/index.d.ts:1095 (opens new window)

# start

▸ Optional start(chart, args, options): void

描述

当插件启动时调用。这发生在图表创建或插件启用时。

从

3.0.0

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args EmptyObject 调用参数。
options O 插件选项。

# 返回值

void

# 定义于

types/index.d.ts:840 (opens new window)

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args EmptyObject 调用参数。
options O 插件选项。

# 返回值

void

# 定义在

types/index.d.ts:848 (在新窗口中打开)

# uninstall

▸ 可选 uninstall(图表, 参数, 选项): void

在图表被销毁后，对所有安装到该图表的插件调用。 此钩子也会对禁用的插件调用（options === false）。

从

3.0.0

# 参数

名称 类型 描述
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> 图表实例。
args EmptyObject 调用参数。
options O 插件选项。

# 返回值

void

# 定义在

types/index.d.ts:1117 (在新窗口中打开)

← PluginChartOptions →