# 介面：Plugin<TType, O>
# 類型參數
| 名稱 | 類型 |
|---|---|
TType | extends ChartType = ChartType |
O | AnyObject |
# 階層
ExtendedPlugin<TType,O>↳
Plugin↳↳
Tooltip
# 屬性
# defaults
• Optional defaults: Partial<O>
外掛程式中使用的預設選項
# 定義於
# events
• Optional events: keyof HTMLElementEventMap[]
events 選項定義了外掛程式應監聽的瀏覽器事件。
預設
['mousemove', 'mouseout', 'click', 'touchstart', 'touchmove']
# 定義於
# id
• id: string
# 定義於
# 方法
# afterBuildTicks
▸ Optional afterBuildTicks(chart, args, options): void
描述
在刻度建立完成後呼叫。此 hook 會針對圖表中的每個刻度分開呼叫。
# 參數
| 名稱 | 類型 | 描述 |
|---|---|---|
chart | Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> | 圖表實例。 |
args | 物件 | 呼叫引數。 |
args.scale | Scale<CoreScaleOptions> | 刻度。 |
options | O | 外掛程式選項。 |
# 傳回
void
# 定義於
# afterDataLimits
▸ Optional afterDataLimits(chart, args, options): void
描述
在計算刻度資料限制之後呼叫。此 hook 會針對圖表中的每個刻度分開呼叫。
# 參數
| 名稱 | 類型 | 描述 |
|---|---|---|
chart | Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> | 圖表實例。 |
args | 物件 | 呼叫引數。 |
args.scale | Scale<CoreScaleOptions> | 刻度。 |
options | O | 外掛程式選項。 |
# 傳回
void
# 定義於
# afterDatasetDraw
▸ Optional afterDatasetDraw(chart, args, options): void
描述
在繪製給定 args.index 的 chart 資料集之後呼叫（資料集以相反的順序繪製）。請注意，如果先前已取消資料集繪製，則不會呼叫此 hook。
# 參數
| 名稱 | 類型 | 描述 |
|---|---|---|
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
# 定義於
# afterDatasetUpdate
▸ Optional afterDatasetUpdate(chart, args, options): void
描述
在更新給定 args.index 的 chart 資料集之後呼叫。請注意，如果先前已取消資料集更新，則不會呼叫此 hook。
# 參數
| 名稱 | 類型 | 描述 |
|---|---|---|
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
# 定義於
# afterDatasetsDraw
▸ Optional afterDatasetsDraw(chart, args, options, cancelable): void
描述
在繪製 chart 資料集之後呼叫。請注意，如果先前已取消資料集繪製，則不會呼叫此 hook。
# 參數
| 名稱 | 類型 | 描述 |
|---|---|---|
chart | Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> | 圖表實例。 |
args | 空物件 | 呼叫引數。 |
options | O | 外掛程式選項。 |
cancelable | false | - |
# 傳回
void
# 定義於
types/index.d.ts:1041 (opens new window)
# afterDatasetsUpdate
▸ Optional afterDatasetsUpdate(chart, args, options): void
描述
在 chart 的資料集更新後呼叫。請注意，如果資料集更新先前已取消，則不會呼叫此 hook。
始於
版本 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
▸ Optional afterDestroy(chart, args, options): void
在圖表銷毀後呼叫。
# 參數
| 名稱 | 類型 | 描述 |
|---|---|---|
chart | Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> | 圖表實例。 |
args | 空物件 | 呼叫引數。 |
options | O | 外掛程式選項。 |
# 返回值
void
# 定義於
types/index.d.ts:1109 (opens new window)
# afterDraw
▸ Optional afterDraw(chart, args, options): void
描述
在 chart 繪製後呼叫。請注意，如果繪製先前已取消，則不會呼叫此 hook。
# 參數
| 名稱 | 類型 | 描述 |
|---|---|---|
chart | Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> | 圖表實例。 |
args | 空物件 | 呼叫引數。 |
options | O | 外掛程式選項。 |
# 返回值
void
# 定義於
types/index.d.ts:1024 (opens new window)
# afterEvent
▸ Optional afterEvent(chart, args, options): void
描述
在 event 被消耗後呼叫。請注意，如果 event 先前已被捨棄，則不會呼叫此 hook。
# 參數
| 名稱 | 類型 | 描述 |
|---|---|---|
chart | Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> | 圖表實例。 |
args | 物件 | 呼叫引數。 |
args.cancelable | false | - |
args.changed? | boolean | 如果插件需要重新渲染，則設定為 true。應該只將其更改為 true，因為此 args 物件會傳遞給所有插件。 |
args.event | ChartEvent | 事件物件。 |
args.inChartArea | boolean | 事件位置在 chartArea 內 |
args.replay | boolean | 如果此事件是從 Chart.update 重新播放，則為 True |
options | O | 外掛程式選項。 |
# 返回值
void
# 定義於
types/index.d.ts:1087 (opens new window)
# afterInit
▸ Optional afterInit(chart, args, options): void
描述
在 chart 初始化完成且在第一次更新之前呼叫。
# 參數
| 名稱 | 類型 | 描述 |
|---|---|---|
chart | Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> | 圖表實例。 |
args | 空物件 | 呼叫引數。 |
options | O | 外掛程式選項。 |
# 返回值
void
# 定義於
types/index.d.ts:862 (opens new window)
# afterLayout
▸ Optional afterLayout(chart, args, options): void
描述
在 chart 版面配置完成後呼叫。請注意，如果版面配置更新先前已取消，則不會呼叫此 hook。
# 參數
| 名稱 | 類型 | 描述 |
|---|---|---|
chart | Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> | 圖表實例。 |
args | 空物件 | 呼叫引數。 |
options | O | 外掛程式選項。 |
# 返回值
void
# 定義於
types/index.d.ts:990 (opens new window)
# afterRender
▸ Optional afterRender(chart, args, options): void
描述
在 chart 完全渲染 (且動畫完成) 後呼叫。請注意，如果渲染先前已取消，則不會呼叫此 hook。
# 參數
| 名稱 | 類型 | 描述 |
|---|---|---|
chart | Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> | 圖表實例。 |
args | 空物件 | 呼叫引數。 |
options | O | 外掛程式選項。 |
# 返回值
void
# 定義於
types/index.d.ts:1007 (opens new window)
# afterTooltipDraw
▸ Optional afterTooltipDraw(chart, args, options): void
描述
在繪製 tooltip 後呼叫。請注意，如果工具提示繪製先前已取消，則不會呼叫此 hook。
# 參數
| 名稱 | 類型 | 描述 |
|---|---|---|
chart | Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | 圖表實例。 |
args | 物件 | 呼叫引數。 |
args.tooltip | TooltipModel<TType> | 工具提示。 |
options | O | 外掛程式選項。 |
# 返回值
void
# 繼承自
ExtendedPlugin.afterTooltipDraw
# 定義於
types/index.d.ts:2705 (opens new window)
# afterUpdate
▸ Optional afterUpdate(chart, args, options): void
描述
在 chart 更新後且在渲染之前呼叫。請注意，如果圖表更新先前已取消，則不會呼叫此 hook。
# 參數
| 名稱 | 類型 | 描述 |
|---|---|---|
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
▸ Optional beforeBuildTicks(chart, args, options): void
描述
在刻度建立前呼叫。此 hook 會針對圖表中的每個刻度單獨呼叫。
# 參數
| 名稱 | 類型 | 描述 |
|---|---|---|
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
▸ Optional beforeDataLimits(chart, args, options): void
描述
在計算刻度資料限制之前呼叫。此 hook 會針對圖表中的每個刻度單獨呼叫。
# 參數
| 名稱 | 類型 | 描述 |
|---|---|---|
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
▸ Optional beforeDatasetDraw(chart, args, options): boolean | void
描述
在繪製給定 args.index 的 chart 資料集之前呼叫 (資料集會以相反的順序繪製)。如果有任何插件返回 false，則會取消資料集繪製，直到觸發另一次 render。
# 參數
| 名稱 | 類型 | 描述 |
|---|---|---|
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
▸ Optional beforeDatasetUpdate(chart, args, options): boolean | void
描述
在更新給定 args.index 的 chart 資料集之前呼叫。如果有任何插件返回 false，則會取消資料集更新，直到觸發另一次 update。
# 參數
| 名稱 | 類型 | 描述 |
|---|---|---|
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
▸ Optional beforeDatasetsDraw(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: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 | 空物件 | 呼叫引數。 |
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
描述
在更新過程中，在建立任何圖表元素之前呼叫。這可以用於通過更改數據集中的數據數組來進行數據抽取。
# 參數
| 名稱 | 類型 | 描述 |
|---|---|---|
chart | Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> | 圖表實例。 |
args | 空物件 | 呼叫引數。 |
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 | 事件位置在 chartArea 內 |
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 | 空物件 | 呼叫引數。 |
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 | Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | 圖表實例。 |
args | 物件 | 呼叫引數。 |
args.cancelable | true | - |
args.tooltip | TooltipModel<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 | 空物件 | 呼叫引數。 |
options | O | 外掛程式選項。 |
# 回傳
void
# 定義於
types/index.d.ts:832 (opens new window)
# reset
▸ Optional reset(chart, args, options): void
描述
在圖表重設期間呼叫
始於
版本 3.0.0
# 參數
| 名稱 | 類型 | 描述 |
|---|---|---|
chart | Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> | 圖表實例。 |
args | 空物件 | 呼叫引數。 |
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 的寬度和高度）。 |
args.size.height | number | - |
args.size.width | number | - |
options | O | 外掛程式選項。 |
# 返回值
void
# 定義於
types/index.d.ts:1095 (在新視窗中開啟)
# start
▸ Optional start(chart, args, options): void
描述
當外掛程式啟動時呼叫。這發生在圖表建立或外掛程式啟用時。
始於
3.0.0
# 參數
| 名稱 | 類型 | 描述 |
|---|---|---|
chart | Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> | 圖表實例。 |
args | 空物件 | 呼叫引數。 |
options | O | 外掛程式選項。 |
# 返回值
void
# 定義於
types/index.d.ts:840 (在新視窗中開啟)
# stop
▸ Optional stop(chart, args, options): void
描述
當外掛程式停止時呼叫。這發生在圖表銷毀或外掛程式停用時。
始於
3.0.0
# 參數
| 名稱 | 類型 | 描述 |
|---|---|---|
chart | Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> | 圖表實例。 |
args | 空物件 | 呼叫引數。 |
options | O | 外掛程式選項。 |
# 返回值
void
# 定義於
types/index.d.ts:848 (在新視窗中開啟)
# uninstall
▸ Optional uninstall(chart, args, options): void
在圖表銷毀後，針對該圖表安裝的所有外掛程式呼叫。此鉤子也會針對已停用的外掛程式 (options === false) 進行呼叫。
始於
3.0.0
# 參數
| 名稱 | 類型 | 描述 |
|---|---|---|
chart | Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> | 圖表實例。 |
args | 空物件 | 呼叫引數。 |
options | O | 外掛程式選項。 |
# 返回值
void