Chart.js

# インターフェース: Plugin<TType, O>

# 型パラメータ

名前 型
TType extends ChartType = ChartType
O AnyObject

# 階層

# プロパティ

# defaults

• Optional defaults: Partial<O>

プラグインで使用されるデフォルトオプション

# 定義元

types/index.d.ts:1122 (新しいウィンドウで開きます)

# events

• Optional events: keyof HTMLElementEventMap[]

eventsオプションは、プラグインがリッスンする必要があるブラウザイベントを定義します。

デフォルト

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

# 定義元

types/index.d.ts:823 (新しいウィンドウで開きます)

# id

• id: string

# 定義元

types/index.d.ts:817 (新しいウィンドウで開きます)

# メソッド

# afterBuildTicks

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

説明

スケールが目盛りを構築した後に呼び出されます。このフックは、チャート内の各スケールに対して個別に呼び出されます。

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args Object 呼び出し引数。
args.scale Scale<CoreScaleOptions> スケール。
options O プラグインオプション。

# 戻り値

void

# 定義元

types/index.d.ts:982 (新しいウィンドウで開きます)

# afterDataLimits

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

説明

スケールデータの上限が計算された後に呼び出されます。このフックは、チャート内の各スケールに対して個別に呼び出されます。

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args Object 呼び出し引数。
args.scale Scale<CoreScaleOptions> スケール。
options O プラグインオプション。

# 戻り値

void

# 定義元

types/index.d.ts:966 (新しいウィンドウで開きます)

# afterDatasetDraw

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

説明

指定されたargs.indexで、chartのデータセットが描画された後に呼び出されます（データセットは逆順で描画されます）。データセットの描画が以前にキャンセルされた場合、このフックは呼び出されないことに注意してください。

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args Object 呼び出し引数。
args.index number データセットのインデックス。
args.meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> データセットのメタデータ。
options O プラグインオプション。

# 戻り値

void

# 定義元

types/index.d.ts:1064 (新しいウィンドウで開きます)

# afterDatasetUpdate

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

説明

指定されたargs.indexで、chartのデータセットが更新された後に呼び出されます。データセットの更新が以前にキャンセルされた場合、このフックは呼び出されないことに注意してください。

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, 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 O プラグインオプション。

# 戻り値

void

# 定義元

types/index.d.ts:941 (新しいウィンドウで開きます)

# afterDatasetsDraw

▸ Optional 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

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

説明

chart のデータセットが更新された後に呼び出されます。このフックは、データセットの更新が以前にキャンセルされた場合には呼び出されないことに注意してください。

Since

version 2.1.5

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args Object 呼び出し引数。
args.cancelable true -
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" 更新モード。
options O プラグインオプション。

# 戻り値

void

# 定義場所

types/index.d.ts:918 (新しいウィンドウで開く)

# afterDestroy

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

チャートが破棄された後に呼び出されます。

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args EmptyObject 呼び出し引数。
options O プラグインオプション。

# 戻り値

void

# 定義場所

types/index.d.ts:1109 (新しいウィンドウで開く)

# afterDraw

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

説明

chart が描画された後に呼び出されます。このフックは、描画が以前にキャンセルされた場合には呼び出されないことに注意してください。

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args EmptyObject 呼び出し引数。
options O プラグインオプション。

# 戻り値

void

# 定義場所

types/index.d.ts:1024 (新しいウィンドウで開く)

# afterEvent

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

説明

event が処理された後に呼び出されます。このフックは、event が以前に破棄された場合には呼び出されないことに注意してください。

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args Object 呼び出し引数。
args.cancelable false -
args.changed? boolean プラグインがレンダリングを必要とする場合に true に設定します。この args オブジェクトはすべてのプラグインを通過するため、true に変更するのみにしてください。
args.event ChartEvent イベントオブジェクト。
args.inChartArea boolean イベントの位置が chartArea 内にある
args.replay boolean このイベントが Chart.update からリプレイされる場合は true
options O プラグインオプション。

# 戻り値

void

# 定義場所

types/index.d.ts:1087 (新しいウィンドウで開く)

# afterInit

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

説明

chart が初期化された後、最初の更新の前に呼び出されます。

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args EmptyObject 呼び出し引数。
options O プラグインオプション。

# 戻り値

void

# 定義場所

types/index.d.ts:862 (新しいウィンドウで開く)

# afterLayout

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

説明

chart のレイアウトが完了した後に呼び出されます。このフックは、レイアウトの更新が以前にキャンセルされた場合には呼び出されないことに注意してください。

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args EmptyObject 呼び出し引数。
options O プラグインオプション。

# 戻り値

void

# 定義場所

types/index.d.ts:990 (新しいウィンドウで開く)

# afterRender

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

説明

chart が完全にレンダリングされた後（およびアニメーションが完了した後）に呼び出されます。このフックは、レンダリングが以前にキャンセルされた場合には呼び出されないことに注意してください。

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args EmptyObject 呼び出し引数。
options O プラグインオプション。

# 戻り値

void

# 定義場所

types/index.d.ts:1007 (新しいウィンドウで開く)

# afterTooltipDraw

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

説明

tooltip の描画後に呼び出されます。このフックは、ツールチップの描画が以前にキャンセルされた場合には呼び出されないことに注意してください。

# パラメータ

名前 型 説明
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> チャートインスタンス。
args Object 呼び出し引数。
args.tooltip TooltipModel<TType> ツールチップ。
options O プラグインオプション。

# 戻り値

void

# 継承元

ExtendedPlugin.afterTooltipDraw

# 定義場所

types/index.d.ts:2705 (新しいウィンドウで開く)

# afterUpdate

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

説明

chart が更新された後、レンダリング前に呼び出されます。このフックは、チャートの更新が以前にキャンセルされた場合には呼び出されないことに注意してください。

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args Object 呼び出し引数。
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" 更新モード
options O プラグインオプション。

# 戻り値

void

# 定義場所

types/index.d.ts:881 (新しいウィンドウで開く)

# beforeBuildTicks

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

説明

スケールが目盛りを構築する前に呼び出されます。このフックは、チャート内の各スケールに対して個別に呼び出されます。

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args Object 呼び出し引数。
args.scale Scale<CoreScaleOptions> スケール。
options O プラグインオプション。

# 戻り値

void

# 定義場所

types/index.d.ts:974 (新しいウィンドウで開く)

# beforeDataLimits

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

説明

スケールのデータ制限が計算される前に呼び出されます。このフックは、チャート内の各スケールに対して個別に呼び出されます。

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args Object 呼び出し引数。
args.scale Scale<CoreScaleOptions> スケール。
options O プラグインオプション。

# 戻り値

void

# 定義場所

types/index.d.ts:958 (新しいウィンドウで開く)

# beforeDatasetDraw

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

説明

指定された args.index で chart データセットを描画する前に呼び出されます (データセットは逆順で描画されます)。いずれかのプラグインが false を返すと、別の render がトリガーされるまでデータセットの描画はキャンセルされます。

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args Object 呼び出し引数。
args.index number データセットのインデックス。
args.meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> データセットのメタデータ。
options O プラグインオプション。

# 戻り値

boolean | void

false を返すと、チャート データセットの描画がキャンセルされます。

# 定義場所

types/index.d.ts:1053 (新しいウィンドウで開く)

# beforeDatasetUpdate

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

説明

指定された args.index で chart データセットを更新する前に呼び出されます。いずれかのプラグインが false を返すと、別の update がトリガーされるまでデータセットの更新はキャンセルされます。

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, 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 O プラグインオプション。

# 戻り値

boolean | void

false を返すと、チャート データセットの描画がキャンセルされます。

# 定義場所

types/index.d.ts:930 (新しいウィンドウで開く)

# beforeDatasetsDraw

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

説明

chartデータセットの描画前に呼び出されます。プラグインのいずれかがfalseを返した場合、別のrenderがトリガーされるまで、データセットの描画はキャンセルされます。

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args Object 呼び出し引数。
args.cancelable true -
options O プラグインオプション。

# 戻り値

boolean | void

false を返すと、チャート データセットの描画がキャンセルされます。

# 定義場所

types/index.d.ts:1033 (新しいウィンドウで開く)

# beforeDatasetsUpdate

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

説明

chartデータセットの更新前に呼び出されます。プラグインのいずれかがfalseを返した場合、別のupdateがトリガーされるまで、データセットの更新はキャンセルされます。

Since

version 2.1.5

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args Object 呼び出し引数。
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" 更新モード。
options O プラグインオプション。

# 戻り値

boolean | void

データセットの更新をキャンセルする場合はfalse。

# 定義場所

types/index.d.ts:908 (新しいウィンドウで開く)

# 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 (新しいウィンドウで開く)

# beforeDraw

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

説明

アニメーションフレームごとに、chartを描画する前に呼び出されます。プラグインのいずれかがfalseを返した場合、別のrenderがトリガーされるまで、フレームの描画はキャンセルされます。

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args Object 呼び出し引数。
args.cancelable true -
options O プラグインオプション。

# 戻り値

boolean | void

チャートの描画をキャンセルする場合はfalse。

# 定義場所

types/index.d.ts:1016 (新しいウィンドウで開く)

# beforeElementsUpdate

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

説明

チャート要素が作成される前の更新処理中に呼び出されます。これは、データセット内のデータ配列を変更することによって、データの間引きに使用できます。

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args EmptyObject 呼び出し引数。
options O プラグインオプション。

# 戻り値

void

# 定義場所

types/index.d.ts:889 (新しいウィンドウで開く)

# beforeEvent

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

説明

指定されたeventを処理する前に呼び出されます。プラグインのいずれかがfalseを返した場合、イベントは破棄されます。

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args Object 呼び出し引数。
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 (新しいウィンドウで開く)

# 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 (新しいウィンドウで開く)

# beforeLayout

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

説明

chartのレイアウト前に呼び出されます。プラグインのいずれかがfalseを返した場合、別のupdateがトリガーされるまで、レイアウトの更新はキャンセルされます。

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args Object 呼び出し引数。
args.cancelable true -
options O プラグインオプション。

# 戻り値

boolean | void

チャートのレイアウトをキャンセルする場合はfalse。

# 定義場所

types/index.d.ts:950 (新しいウィンドウで開く)

# beforeRender

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

説明

chartのレンダリング前に呼び出されます。プラグインのいずれかがfalseを返した場合、別のrenderがトリガーされるまで、レンダリングはキャンセルされます。

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args Object 呼び出し引数。
args.cancelable true -
options O プラグインオプション。

# 戻り値

boolean | void

チャートのレンダリングをキャンセルする場合はfalse。

# 定義場所

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<TType> ツールチップ。
options O プラグインオプション。

# 戻り値

boolean | void

チャートのツールチップの描画をキャンセルする場合はfalse。

# 継承元

ExtendedPlugin.beforeTooltipDraw

# 定義場所

types/index.d.ts:2696 (新しいウィンドウで開く)

# beforeUpdate

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

説明

chartを更新する前に呼び出されます。プラグインのいずれかがfalseを返した場合、別のupdateがトリガーされるまで、更新はキャンセルされます（したがって、後続のrenderもキャンセルされます）。

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args Object 呼び出し引数。
args.cancelable true -
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" 更新モード
options O プラグインオプション。

# 戻り値

boolean | void

チャートの更新をキャンセルする場合はfalse。

# 定義場所

types/index.d.ts:872 (新しいウィンドウで開く)

# install

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

説明

プラグインがこのチャートインスタンスにインストールされたときに呼び出されます。このフックは、無効になっているプラグイン（options === false）の場合にも呼び出されます。

Since

3.0.0

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args EmptyObject 呼び出し引数。
options O プラグインオプション。

# 戻り値

void

# 定義元

types/index.d.ts:832 (新しいウィンドウで開く)

# reset

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

説明

チャートのリセット中に呼び出されます

Since

バージョン 3.0.0

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args EmptyObject 呼び出し引数。
options O プラグインオプション。

# 戻り値

void

# 定義元

types/index.d.ts:897 (新しいウィンドウで開く)

# resize

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

説明

チャートのリサイズ後に呼び出されます。

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args Object 呼び出し引数。
args.size Object 新しいキャンバスの表示サイズ（例：canvas.style の width と height）。
args.size.height number -
args.size.width number -
options O プラグインオプション。

# 戻り値

void

# 定義元

types/index.d.ts:1095 (新しいウィンドウで開く)

# start

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

説明

プラグインが起動するときに呼び出されます。これは、チャートが作成されたとき、またはプラグインが有効になったときに発生します。

Since

3.0.0

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args EmptyObject 呼び出し引数。
options O プラグインオプション。

# 戻り値

void

# 定義元

types/index.d.ts:840 (新しいウィンドウで開く)

# stop

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

説明

プラグインが停止するときに呼び出されます。これは、チャートが破棄されたとき、またはプラグインが無効になったときに発生します。

Since

3.0.0

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args EmptyObject 呼び出し引数。
options O プラグインオプション。

# 戻り値

void

# 定義元

types/index.d.ts:848 (新しいウィンドウで開く)

# uninstall

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

チャートが破棄された後、そのチャートにインストールされていたすべてのプラグインで呼び出されます。このフックは、無効になっているプラグイン（options === false）の場合にも呼び出されます。

Since

3.0.0

# パラメータ

名前 型 説明
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> チャートインスタンス。
args EmptyObject 呼び出し引数。
options O プラグインオプション。

# 戻り値

void

# 定義元

types/index.d.ts:1117 (新しいウィンドウで開く)

← PluginChartOptions →