Chart.js

# 介面： Tooltip

# 階層

# 屬性

# defaults

• 可選 defaults: Partial<AnyObject>

外掛程式中使用的預設選項

# 繼承自

Plugin.defaults

# 定義於

types/index.d.ts:1122 (在新視窗開啟)

# events

• 可選 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

• 唯讀 positioners: TooltipPositionerMap

# 定義於

types/index.d.ts:2653 (在新視窗開啟)

# 方法

# afterBuildTicks

▸ 可選 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

▸ 可選 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

▸ 可選 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 資料集更新後呼叫。請注意，如果資料集更新先前已取消，則不會呼叫此 Hook。

# 參數

名稱 類型 描述
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 (開啟新視窗)

# afterDatasetsDraw

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

描述

在 chart 資料集繪製完成後呼叫。請注意，如果資料集繪製先前已取消，則不會呼叫此 Hook。

# 參數

名稱 類型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 圖表實例。
args EmptyObject 呼叫參數。
options AnyObject 外掛程式選項。
cancelable false -

# 回傳

void

# 繼承自

Plugin.afterDatasetsDraw

# 定義於

types/index.d.ts:1041 (開啟新視窗)

# afterDatasetsUpdate

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

描述

在 chart 資料集更新後呼叫。請注意，如果資料集更新先前已取消，則不會呼叫此 Hook。

自

版本 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 (開啟新視窗)

# 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 (開啟新視窗)

# afterDraw

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

描述

在 chart 繪製完成後呼叫。請注意，如果繪圖先前已取消，則不會呼叫此 Hook。

# 參數

名稱 類型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 圖表實例。
args EmptyObject 呼叫參數。
options AnyObject 外掛程式選項。

# 回傳

void

# 繼承自

Plugin.afterDraw

# 定義於

types/index.d.ts:1024 (開啟新視窗)

# afterEvent

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

描述

在 event 被消耗後呼叫。請注意，如果 event 先前已捨棄，則不會呼叫此 Hook。

# 參數

名稱 類型 描述
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 (開啟新視窗)

# 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 (開啟新視窗)

# afterLayout

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

描述

在 chart 排版完成後呼叫。請注意，如果版面配置更新先前已取消，則不會呼叫此 Hook。

# 參數

名稱 類型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 圖表實例。
args EmptyObject 呼叫參數。
options AnyObject 外掛程式選項。

# 回傳

void

# 繼承自

Plugin.afterLayout

# 定義於

types/index.d.ts:990 (開啟新視窗)

# afterRender

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

描述

在 chart 完全渲染 (和動畫完成) 後呼叫。請注意，如果渲染先前已取消，則不會呼叫此 Hook。

# 參數

名稱 類型 描述
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> 圖表實例。
args EmptyObject 呼叫參數。
options AnyObject 外掛程式選項。

# 回傳

void

# 繼承自

Plugin.afterRender

# 定義於

types/index.d.ts:1007 (開啟新視窗)

# afterTooltipDraw

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

描述

在繪製 tooltip 後呼叫。請注意，如果工具提示繪製先前已取消，則不會呼叫此 Hook。

# 參數

名稱 類型 描述
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 (開啟新視窗)

# afterUpdate

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

描述

在 chart 更新後和渲染之前呼叫。請注意，如果圖表更新先前已取消，則不會呼叫此 Hook。

# 參數

名稱 類型 描述
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 (開啟新視窗)

# 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 (開啟新視窗)

# 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 (開啟新視窗)

# 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 (開啟新視窗)

# 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 (開啟新視窗)

# 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 (開啟新視窗)

# 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 (開啟新視窗)

# 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 (開啟新視窗)

# 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 (開啟新視窗)

# 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 (開啟新視窗)

# 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 (在新視窗開啟)

# 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 (在新視窗開啟)

# 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 (在新視窗開啟)

# 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 (在新視窗開啟)

# beforeTooltipDraw

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

描述

在繪製 tooltip 之前呼叫。如果任何外掛程式回傳 false，則工具提示繪製將被取消，直到觸發另一個 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 以取消圖表工具提示繪製。

# 繼承自

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 width & height）。
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 →