# インターフェース: Tooltip
# 階層
-
↳
Tooltip
# プロパティ
# defaults
• Optional defaults: Partial<AnyObject>
プラグインで使用されるデフォルトオプション
# 継承元
# 定義元
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 (新しいウィンドウで開きます)
# 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 | オブジェクト | 呼び出し引数。 |
args.scale | Scale<CoreScaleOptions> | スケール。 |
options | AnyObject | プラグインオプション。 |
# 戻り値
void
# 継承元
# 定義元
types/index.d.ts:982 (新しいウィンドウで開きます)
# afterDataLimits
▸ Optional afterDataLimits(chart, args, options): void
説明
スケールデータのリミットが計算された後に呼び出されます。このフックは、チャート内の各スケールに対して個別に呼び出されます。
# パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
chart | Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | チャートインスタンス。 |
args | オブジェクト | 呼び出し引数。 |
args.scale | Scale<CoreScaleOptions> | スケール。 |
options | AnyObject | プラグインオプション。 |
# 戻り値
void
# 継承元
# 定義元
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 | オブジェクト | 呼び出し引数。 |
args.index | number | データセットのインデックス。 |
args.meta | ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> | データセットメタデータ。 |
options | AnyObject | プラグインオプション。 |
# 戻り値
void
# 継承元
# 定義元
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 | オブジェクト | 呼び出し引数。 |
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
# 継承元
# 定義元
types/index.d.ts:941 (新しいウィンドウで開きます)
# 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
# 継承元
# 定義元
types/index.d.ts:1041 (新しいウィンドウで開きます)
# afterDatasetsUpdate
▸ Optional afterDatasetsUpdate(chart, args, options): void
説明
chartデータセットが更新された後に呼び出されます。データセットの更新が以前にキャンセルされた場合、このフックは呼び出されないことに注意してください。
Since
version 2.1.5
# パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
chart | Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | チャートインスタンス。 |
args | オブジェクト | 呼び出し引数。 |
args.cancelable | true | - |
args.mode | "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" | 更新モード。 |
options | AnyObject | プラグインオプション。 |
# 戻り値
void
# 継承元
# 定義元
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
# 継承元
# 定義元
types/index.d.ts:1109 (新しいウィンドウで開きます)
# afterDraw
▸ Optional afterDraw(chart, args, options): void
説明
chartが描画された後に呼び出されます。描画が以前にキャンセルされた場合、このフックは呼び出されないことに注意してください。
# パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
chart | Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | チャートインスタンス。 |
args | EmptyObject | 呼び出し引数。 |
options | AnyObject | プラグインオプション。 |
# 戻り値
void
# 継承元
# 定義元
types/index.d.ts:1024 (新しいウィンドウで開きます)
# afterEvent
▸ Optional afterEvent(chart, args, options): void
説明
eventが消費された後に呼び出されます。eventが以前に破棄された場合、このフックは呼び出されないことに注意してください。
# パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
chart | Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | チャートインスタンス。 |
args | オブジェクト | 呼び出し引数。 |
args.cancelable | false | - |
args.changed? | boolean | プラグインがレンダリングを必要とする場合、trueに設定します。このargsオブジェクトはすべてのプラグインを通過するため、trueにのみ変更する必要があります。 |
args.event | ChartEvent | イベントオブジェクト。 |
args.inChartArea | boolean | イベントの位置はchartArea内です |
args.replay | boolean | このイベントがChart.updateからリプレイされた場合はTrue |
options | AnyObject | プラグインオプション。 |
# 戻り値
void
# 継承元
# 定義元
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
# 継承元
# 定義元
types/index.d.ts:862 (新しいウィンドウで開きます)
# afterLayout
▸ Optional afterLayout(chart, args, options): void
説明
chartがレイアウトされた後に呼び出されます。レイアウトの更新が以前にキャンセルされた場合、このフックは呼び出されないことに注意してください。
# パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
chart | Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | チャートインスタンス。 |
args | EmptyObject | 呼び出し引数。 |
options | AnyObject | プラグインオプション。 |
# 戻り値
void
# 継承元
# 定義元
types/index.d.ts:990 (新しいウィンドウで開きます)
# afterRender
▸ Optional afterRender(chart, args, options): void
説明
chartが完全にレンダリングされた後（およびアニメーションが完了した後）に呼び出されます。レンダリングが以前にキャンセルされた場合、このフックは呼び出されないことに注意してください。
# パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
chart | Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | チャートインスタンス。 |
args | EmptyObject | 呼び出し引数。 |
options | AnyObject | プラグインオプション。 |
# 戻り値
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 | オブジェクト | 呼び出し引数。 |
args.tooltip | TooltipModel<keyof ChartTypeRegistry> | ツールチップ。 |
options | AnyObject | プラグインオプション。 |
# 戻り値
void
# 継承元
# 定義元
types/index.d.ts:2705 (新しいウィンドウで開きます)
# afterUpdate
▸ Optional afterUpdate(chart, args, options): void
説明
chartが更新され、レンダリング前に呼び出されます。チャートの更新が以前にキャンセルされた場合、このフックは呼び出されないことに注意してください。
# パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
chart | Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | チャートインスタンス。 |
args | オブジェクト | 呼び出し引数。 |
args.mode | "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" | 更新モード |
options | AnyObject | プラグインオプション。 |
# 戻り値
void
# 継承元
# 定義元
types/index.d.ts:881 (新しいウィンドウで開きます)
# beforeBuildTicks
▸ Optional beforeBuildTicks(chart, args, options): void
説明
スケールが目盛りを作成する前に呼び出されます。このフックは、チャート内の各スケールに対して個別に呼び出されます。
# パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
chart | Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | チャートインスタンス。 |
args | オブジェクト | 呼び出し引数。 |
args.scale | Scale<CoreScaleOptions> | スケール。 |
options | AnyObject | プラグインオプション。 |
# 戻り値
void
# 継承元
# 定義場所
types/index.d.ts:974 (新しいウィンドウで開く)
# beforeDataLimits
▸ Optional beforeDataLimits(chart, args, options): void
説明
スケールデータのリミットが計算される前に呼び出されます。このフックは、チャート内の各スケールに対して個別に呼び出されます。
# パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
chart | Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | チャートインスタンス。 |
args | オブジェクト | 呼び出し引数。 |
args.scale | Scale<CoreScaleOptions> | スケール。 |
options | AnyObject | プラグインオプション。 |
# 戻り値
void
# 継承元
# 定義場所
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 | オブジェクト | 呼び出し引数。 |
args.index | number | データセットのインデックス。 |
args.meta | ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> | データセットメタデータ。 |
options | AnyObject | プラグインオプション。 |
# 戻り値
boolean | void
チャートデータセットの描画をキャンセルする場合は false。
# 継承元
# 定義場所
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 | オブジェクト | 呼び出し引数。 |
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。
# 継承元
# 定義場所
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 | オブジェクト | 呼び出し引数。 |
args.cancelable | true | - |
options | AnyObject | プラグインオプション。 |
# 戻り値
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<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | チャートインスタンス。 |
args | オブジェクト | 呼び出し引数。 |
args.mode | "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" | 更新モード。 |
options | AnyObject | プラグインオプション。 |
# 戻り値
boolean | void
データセットの更新をキャンセルする場合は false。
# 継承元
# 定義場所
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
# 継承元
# 定義場所
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 | オブジェクト | 呼び出し引数。 |
args.cancelable | true | - |
options | AnyObject | プラグインオプション。 |
# 戻り値
boolean | void
チャートの描画をキャンセルする場合は false。
# 継承元
# 定義場所
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
# 継承元
# 定義場所
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 | オブジェクト | 呼び出し引数。 |
args.cancelable | true | - |
args.event | ChartEvent | イベントオブジェクト。 |
args.inChartArea | boolean | イベントの位置はchartArea内です |
args.replay | boolean | このイベントがChart.updateからリプレイされた場合はTrue |
options | AnyObject | プラグインオプション。 |
# 戻り値
boolean | void
# 継承元
# 定義場所
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
# 継承元
# 定義場所
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 | オブジェクト | 呼び出し引数。 |
args.cancelable | true | - |
options | AnyObject | プラグインオプション。 |
# 戻り値
boolean | void
チャートのレイアウトをキャンセルする場合は false。
# 継承元
# 定義元
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 | オブジェクト | 呼び出し引数。 |
args.cancelable | true | - |
options | AnyObject | プラグインオプション。 |
# 戻り値
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 | オブジェクト | 呼び出し引数。 |
args.cancelable | true | - |
args.tooltip | TooltipModel<keyof ChartTypeRegistry> | ツールチップ。 |
options | AnyObject | プラグインオプション。 |
# 戻り値
boolean | void
チャートのツールチップの描画をキャンセルする場合は false。
# 継承元
# 定義元
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 | オブジェクト | 呼び出し引数。 |
args.cancelable | true | - |
args.mode | "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" | 更新モード |
options | AnyObject | プラグインオプション。 |
# 戻り値
boolean | void
チャートの更新をキャンセルする場合は false。
# 継承元
# 定義元
types/index.d.ts:872 (新しいウィンドウで開きます)
# install
▸ Optional install(chart, args, options): void
説明
プラグインがこのチャートインスタンスにインストールされたときに呼び出されます。このフックは、無効になっているプラグイン (options === false) でも呼び出されます。
Since
3.0.0
# パラメーター
| 名前 | 型 | 説明 |
|---|---|---|
chart | Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | チャートインスタンス。 |
args | EmptyObject | 呼び出し引数。 |
options | AnyObject | プラグインオプション。 |
# 戻り値
void
# 継承元
# 定義元
types/index.d.ts:832 (新しいウィンドウで開きます)
# reset
▸ Optional reset(chart, args, options): void
説明
チャートのリセット中に呼び出されます。
Since
バージョン 3.0.0
# パラメーター
| 名前 | 型 | 説明 |
|---|---|---|
chart | Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | チャートインスタンス。 |
args | EmptyObject | 呼び出し引数。 |
options | AnyObject | プラグインオプション。 |
# 戻り値
void
# 継承元
# 定義元
types/index.d.ts:897 (新しいウィンドウで開きます)
# resize
▸ Optional resize(chart, args, options): void
説明
チャートのサイズが変更された後に呼び出されます。
# パラメーター
| 名前 | 型 | 説明 |
|---|---|---|
chart | Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | チャートインスタンス。 |
args | オブジェクト | 呼び出し引数。 |
args.size | オブジェクト | キャンバスの新しい表示サイズ（canvas.style の width および height に相当）。 |
args.size.height | number | - |
args.size.width | number | - |
options | AnyObject | プラグインオプション。 |
# 戻り値
void
# 継承元
# 定義元
types/index.d.ts:1095 (新しいウィンドウで開きます)
# start
▸ Optional start(chart, args, options): void
説明
プラグインが開始されるときに呼び出されます。これは、チャートが作成されたとき、またはプラグインが有効になったときに発生します。
Since
3.0.0
# パラメーター
| 名前 | 型 | 説明 |
|---|---|---|
chart | Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | チャートインスタンス。 |
args | EmptyObject | 呼び出し引数。 |
options | AnyObject | プラグインオプション。 |
# 戻り値
void
# 継承元
# 定義元
types/index.d.ts:840 (新しいウィンドウで開きます)
# stop
▸ Optional stop(chart, args, options): void
説明
プラグインが停止するときに呼び出されます。これは、チャートが破棄されたとき、またはプラグインが無効になったときに発生します。
Since
3.0.0
# パラメーター
| 名前 | 型 | 説明 |
|---|---|---|
chart | Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | チャートインスタンス。 |
args | EmptyObject | 呼び出し引数。 |
options | AnyObject | プラグインオプション。 |
# 戻り値
void
# 継承元
# 定義元
types/index.d.ts:848 (新しいウィンドウで開きます)
# uninstall
▸ Optional uninstall(chart, args, options): void
そのチャートにインストールされていたすべてのプラグインについて、チャートが破棄された後に呼び出されます。このフックは、無効になっているプラグイン (options === false) でも呼び出されます。
Since
3.0.0
# パラメーター
| 名前 | 型 | 説明 |
|---|---|---|
chart | Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | チャートインスタンス。 |
args | EmptyObject | 呼び出し引数。 |
options | AnyObject | プラグインオプション。 |
# 戻り値
void