Chart.js

# 接口: Tooltip

# 层次结构

# 属性

# defaults

• Optional defaults: Partial<AnyObject>

插件中使用的默认选项

# 继承自

Plugin.defaults

# 定义于

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

# events

• Optional events: keyof HTMLElementEventMap[]

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

默认

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

# 继承自

Plugin.events

# 定义于

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

# id

• id: string

# 继承自

Plugin.id

# 定义于

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

# positioners

• Readonly positioners: TooltipPositionerMap

# 定义于

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

# 方法

# afterBuildTicks

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

描述

在刻度构建完成后调用。此钩子针对图表中的每个刻度分别调用。

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args Object 调用参数。
args.scale Scale<CoreScaleOptions> 刻度。
options AnyObject 插件选项。

# 返回值

void

# 继承自

Plugin.afterBuildTicks

# 定义于

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

# afterDataLimits

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

描述

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

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args Object 调用参数。
args.scale Scale<CoreScaleOptions> 刻度。
options AnyObject 插件选项。

# 返回值

void

# 继承自

Plugin.afterDataLimits

# 定义于

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

# afterDatasetDraw

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

描述

在给定 args.index 的 chart 数据集绘制完成后调用（数据集以逆序绘制）。请注意，如果数据集绘制之前已取消，则不会调用此钩子。

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args Object 调用参数。
args.index number 数据集索引。
args.meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> 数据集元数据。
options AnyObject 插件选项。

# 返回值

void

# 继承自

Plugin.afterDatasetDraw

# 定义于

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

# afterDatasetUpdate

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

描述

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

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args Object 调用参数。
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 AnyObject 插件选项。

# 返回值

void

# 继承自

Plugin.afterDatasetUpdate

# 定义于

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

# afterDatasetsDraw

▸ Optional afterDatasetsDraw(chart, args, options, cancelable): void

描述

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

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args EmptyObject 调用参数。
options AnyObject 插件选项。
cancelable false -

# 返回

void

# 继承自

Plugin.afterDatasetsDraw

# 定义在

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

# afterDatasetsUpdate

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

描述

在 chart 数据集更新完成后调用。请注意，如果数据集更新已被取消，则不会调用此钩子。

从

版本 2.1.5

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args Object 调用参数。
args.cancelable true -
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" 更新模式。
options AnyObject 插件选项。

# 返回

void

# 继承自

Plugin.afterDatasetsUpdate

# 定义在

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

# afterDestroy

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

在图表销毁后调用。

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args EmptyObject 调用参数。
options AnyObject 插件选项。

# 返回

void

# 继承自

Plugin.afterDestroy

# 定义在

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

# afterDraw

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

描述

在 chart 绘制完成后调用。请注意，如果绘制已被取消，则不会调用此钩子。

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args EmptyObject 调用参数。
options AnyObject 插件选项。

# 返回

void

# 继承自

Plugin.afterDraw

# 定义在

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

# afterEvent

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

描述

在 event 被使用后调用。请注意，如果 event 被丢弃，则不会调用此钩子。

# 参数

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

# 返回

void

# 继承自

Plugin.afterEvent

# 定义在

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

# afterInit

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

描述

在 chart 初始化后并首次更新之前调用。

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args EmptyObject 调用参数。
options AnyObject 插件选项。

# 返回

void

# 继承自

Plugin.afterInit

# 定义在

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

# afterLayout

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

描述

在 chart 布局完成后调用。请注意，如果布局更新已被取消，则不会调用此钩子。

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args EmptyObject 调用参数。
options AnyObject 插件选项。

# 返回

void

# 继承自

Plugin.afterLayout

# 定义在

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

# afterRender

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

描述

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

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args EmptyObject 调用参数。
options AnyObject 插件选项。

# 返回

void

# 继承自

Plugin.afterRender

# 定义在

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

# afterTooltipDraw

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

描述

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

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args Object 调用参数。
args.tooltip TooltipModel<keyof ChartTypeRegistry> 提示。
options AnyObject 插件选项。

# 返回

void

# 继承自

Plugin.afterTooltipDraw

# 定义在

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

# afterUpdate

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

描述

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

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args Object 调用参数。
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" 更新模式
options AnyObject 插件选项。

# 返回

void

# 继承自

Plugin.afterUpdate

# 定义在

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

# beforeBuildTicks

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

描述

在刻度尺构建其刻度之前调用。此钩子针对图表中的每个刻度尺单独调用。

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args Object 调用参数。
args.scale Scale<CoreScaleOptions> 刻度。
options AnyObject 插件选项。

# 返回

void

# 继承自

Plugin.beforeBuildTicks

# 定义在

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

# beforeDataLimits

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

描述

在刻度尺数据限制计算之前调用。此钩子针对图表中的每个刻度尺单独调用。

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args Object 调用参数。
args.scale Scale<CoreScaleOptions> 刻度。
options AnyObject 插件选项。

# 返回

void

# 继承自

Plugin.beforeDataLimits

# 定义在

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

# beforeDatasetDraw

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

描述

在绘制给定 args.index 的 chart 数据集之前调用（数据集按反序绘制）。如果任何插件返回 false，则数据集绘制将被取消，直到另一个 render 被触发。

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args Object 调用参数。
args.index number 数据集索引。
args.meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> 数据集元数据。
options AnyObject 插件选项。

# 返回

boolean | void

false 取消图表数据集的绘制。

# 继承自

Plugin.beforeDatasetDraw

# 定义在

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

# beforeDatasetUpdate

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

描述

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

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args Object 调用参数。
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 AnyObject 插件选项。

# 返回

boolean | void

false 取消图表数据集的绘制。

# 继承自

Plugin.beforeDatasetUpdate

# 定义在

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

# beforeDatasetsDraw

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

描述

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

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args Object 调用参数。
args.cancelable true -
options AnyObject 插件选项。

# 返回

boolean | void

false 取消图表数据集的绘制。

# 继承自

Plugin.beforeDatasetsDraw

# 定义在

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

# beforeDatasetsUpdate

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

描述

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

从

版本 2.1.5

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args Object 调用参数。
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" 更新模式。
options AnyObject 插件选项。

# 返回

boolean | void

false 取消数据集的更新。

# 继承自

Plugin.beforeDatasetsUpdate

# 定义在

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

# beforeDestroy

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

在图表被销毁之前调用。

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args EmptyObject 调用参数。
options AnyObject 插件选项。

# 返回

void

# 继承自

Plugin.beforeDestroy

# 定义在

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

# beforeDraw

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

描述

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

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args Object 调用参数。
args.cancelable true -
options AnyObject 插件选项。

# 返回

boolean | void

false 取消图表绘制。

# 继承自

Plugin.beforeDraw

# 定义在

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

# beforeElementsUpdate

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

描述

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

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args EmptyObject 调用参数。
options AnyObject 插件选项。

# 返回

void

# 继承自

Plugin.beforeElementsUpdate

# 定义在

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

# beforeEvent

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

描述

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

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args Object 调用参数。
args.cancelable true -
args.event ChartEvent 事件对象。
args.inChartArea boolean 事件位置在 chartArea 内部
args.replay boolean 如果此事件是 Chart.update 中重播的，则为 true
options AnyObject 插件选项。

# 返回

boolean | void

# 继承自

Plugin.beforeEvent

# 定义在

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

# beforeInit

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

描述

在初始化 chart 之前调用。

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args EmptyObject 调用参数。
options AnyObject 插件选项。

# 返回

void

# 继承自

Plugin.beforeInit

# 定义在

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

# beforeLayout

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

描述

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

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args Object 调用参数。
args.cancelable true -
options AnyObject 插件选项。

# 返回

boolean | void

false 取消图表布局。

# 继承自

Plugin.beforeLayout

# 定义在

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

# beforeRender

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

描述

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

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args Object 调用参数。
args.cancelable true -
options AnyObject 插件选项。

# 返回

boolean | void

false 取消图表渲染。

# 继承自

Plugin.beforeRender

# 定义在

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

# beforeTooltipDraw

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

描述

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

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args Object 调用参数。
args.cancelable true -
args.tooltip TooltipModel<keyof ChartTypeRegistry> 提示。
options AnyObject 插件选项。

# 返回

boolean | void

false 取消图表 tooltip 绘制。

# 继承自

Plugin.beforeTooltipDraw

# 定义在

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

# beforeUpdate

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

描述

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

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args Object 调用参数。
args.cancelable true -
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" 更新模式
options AnyObject 插件选项。

# 返回值

boolean | void

false表示取消图表更新。

# 继承自

Plugin.beforeUpdate

# 定义于

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

# install

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

描述

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

从

3.0.0

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args EmptyObject 调用参数。
options AnyObject 插件选项。

# 返回值

void

# 继承自

Plugin.install

# 定义于

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

# reset

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

描述

在图表重置期间调用

从

版本 3.0.0

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args EmptyObject 调用参数。
options AnyObject 插件选项。

# 返回值

void

# 继承自

Plugin.reset

# 定义于

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

# resize

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

描述

在图表调整大小后调用。

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args Object 调用参数。
args.size Object 新的画布显示大小（等于 canvas.style 宽度和高度）。
args.size.height number -
args.size.width number -
options AnyObject 插件选项。

# 返回值

void

# 继承自

Plugin.resize

# 定义于

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

# start

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

描述

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

从

3.0.0

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args EmptyObject 调用参数。
options AnyObject 插件选项。

# 返回值

void

# 继承自

Plugin.start

# 定义于

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

# stop

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

描述

当插件停止时调用。当图表被销毁或插件被禁用时发生。

从

3.0.0

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args EmptyObject 调用参数。
options AnyObject 插件选项。

# 返回值

void

# 继承自

Plugin.stop

# 定义于

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

# uninstall

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

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

从

3.0.0

# 参数

名称 类型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 图表实例。
args EmptyObject 调用参数。
options AnyObject 插件选项。

# 返回值

void

# 继承自

Plugin.uninstall

# 定义于

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

← TooltipCallbacks →