Interface: Plugin<TType, O>

↳ Plugin

• id: string

Defined in

afterBuildTicks

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

desc Called after scale has build its ticks. This hook is called separately for each scale in the chart.

Parameters

Name	Type	Description
`chart`	Chart<keyof , (`number` \| ScatterDataPoint \| )[], `unknown`>	The chart instance.
`args`	`Object`	The call arguments.
`args.scale`	Scale<>	The scale.
`options`	`O`	The plugin options.

Returns

void

Defined in

index.esm.d.ts:944 (opens new window)

afterDataLimits

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

desc Called after scale data limits are calculated. This hook is called separately for each scale in the chart.

Parameters

Name	Type	Description
`chart`	<keyof ChartTypeRegistry, (`number` \| \| BubbleDataPoint)[], `unknown`>	The chart instance.
`args`	`Object`	The call arguments.
`args.scale`	<CoreScaleOptions>	The scale.
`options`	`O`	The plugin options.

Returns

void

Defined in

afterDatasetDraw

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

desc Called after the chart datasets at the given args.index have been drawn (datasets are drawn in the reverse order). Note that this hook will not be called if the datasets drawing has been previously cancelled.

Parameters

Name	Type	Description
`chart`	Chart<keyof , (`number` \| ScatterDataPoint \| )[], `unknown`>	The chart instance.
`args`	`Object`	The call arguments.
`args.index`	`number`	The dataset index.
`args.meta`	ChartMeta<<`AnyObject`, `AnyObject`>, Element<`AnyObject`, `AnyObject`>, keyof >	The dataset metadata.
`options`	`O`	The plugin options.

Returns

void

Defined in

index.esm.d.ts:1026 (opens new window)

afterDatasetUpdate

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

desc Called after the chart datasets at the given args.index has been updated. Note that this hook will not be called if the datasets update has been previously cancelled.

Parameters

Name	Type	Description
`chart`	<keyof ChartTypeRegistry, (`number` \| \| BubbleDataPoint)[], `unknown`>	The chart instance.
`args`	`Object`	The call arguments.
`args.cancelable`	`false`	-
`args.index`	`number`	The dataset index.
`args.meta`	<Element<`AnyObject`, `AnyObject`>, <`AnyObject`, `AnyObject`>, keyof ChartTypeRegistry>	The dataset metadata.
`args.mode`	`“resize”` \| `“reset”` \| `“none”` \| `“hide”` \| `“show”` \| `“normal”` \| `“active”`	The update mode.
`options`	`O`	The plugin options.

Returns

void

Defined in

afterDatasetsDraw

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

desc Called after the chart datasets have been drawn. Note that this hook will not be called if the datasets drawing has been previously cancelled.

Parameters

Name	Type	Description
`chart`	Chart<keyof , (`number` \| ScatterDataPoint \| )[], `unknown`>	The chart instance.
`args`	`EmptyObject`	The call arguments.
`options`	`O`	The plugin options.
`cancelable`	`false`	-

Returns

void

Defined in

index.esm.d.ts:1003 (opens new window)

afterDatasetsUpdate

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

desc Called after the chart datasets have been updated. Note that this hook will not be called if the datasets update has been previously cancelled.

since version 2.1.5

Parameters

Name	Type	Description
`chart`	<keyof ChartTypeRegistry, (`number` \| \| BubbleDataPoint)[], `unknown`>	The chart instance.
`args`	`Object`	The call arguments.
`args.cancelable`	`true`	-
`args.mode`	`“resize”` \| `“reset”` \| `“none”` \| `“hide”` \| `“show”` \| `“normal”` \| `“active”`	The update mode.
`options`	`O`	The plugin options.

Returns

void

Defined in

afterDraw

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

desc Called after the chart has been drawn. Note that this hook will not be called if the drawing has been previously cancelled.

Parameters

Name	Type	Description
`chart`	Chart<keyof , (`number` \| ScatterDataPoint \| )[], `unknown`>	The chart instance.
`args`	`EmptyObject`	The call arguments.
`options`	`O`	The plugin options.

Returns

void

Defined in

index.esm.d.ts:986 (opens new window)

afterEvent

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

desc Called after the event has been consumed. Note that this hook will not be called if the event has been previously discarded.

Parameters

Name	Type	Description
`chart`	<keyof ChartTypeRegistry, (`number` \| \| BubbleDataPoint)[], `unknown`>	The chart instance.
`args`	`Object`	The call arguments.
`args.cancelable`	`false`	-
`args.changed?`	`boolean`	-
`args.event`		The event object.
`args.replay`	`boolean`	True if this event is replayed from `Chart.update`
`options`	`O`	The plugin options.

Returns

void

Defined in

index.esm.d.ts:1047 (opens new window)

afterInit

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

desc Called after chart has been initialized and before the first update.

Parameters

Name	Type	Description
`chart`	<keyof ChartTypeRegistry, (`number` \| \| BubbleDataPoint)[], `unknown`>	The chart instance.
`args`	`EmptyObject`	The call arguments.
`options`	`O`	The plugin options.

Returns

void

Defined in

afterLayout

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

desc Called after the chart has been laid out. Note that this hook will not be called if the layout update has been previously cancelled.

Parameters

Name	Type	Description
`chart`	Chart<keyof , (`number` \| ScatterDataPoint \| )[], `unknown`>	The chart instance.
`args`	`EmptyObject`	The call arguments.
`options`	`O`	The plugin options.

Returns

void

Defined in

index.esm.d.ts:952 (opens new window)

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

desc Called after the chart has been fully rendered (and animation completed). Note that this hook will not be called if the rendering has been previously cancelled.

Parameters

Returns

void

Defined in

index.esm.d.ts:969 (opens new window)

afterTooltipDraw

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

desc Called after drawing the tooltip. Note that this hook will not be called if the tooltip drawing has been previously cancelled.

Parameters

Name	Type	Description
	<keyof ChartTypeRegistry, (`number` \| \| BubbleDataPoint)[], `unknown`>	The chart instance.
`args`	`Object`	The call arguments.
`args.tooltip`	<`TType`>	The tooltip.
`options`	`O`	The plugin options.

Returns

void

Inherited from

Defined in

afterUpdate

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

desc Called after chart has been updated and before rendering. Note that this hook will not be called if the chart update has been previously cancelled.

Parameters

Name	Type	Description
`chart`	Chart<keyof , (`number` \| ScatterDataPoint \| )[], `unknown`>	The chart instance.
`args`	`Object`	The call arguments.
`args.mode`	`“resize”` \| `“reset”` \| `“none”` \| `“hide”` \| `“show”` \| `“normal”` \| `“active”`	The update mode
`options`	`O`	The plugin options.

Returns

void

Defined in

index.esm.d.ts:843 (opens new window)

beforeBuildTicks

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

desc Called before scale bulds its ticks. This hook is called separately for each scale in the chart.

Parameters

Name	Type	Description
`chart`	<keyof ChartTypeRegistry, (`number` \| \| BubbleDataPoint)[], `unknown`>	The chart instance.
`args`	`Object`	The call arguments.
`args.scale`	<CoreScaleOptions>	The scale.
`options`	`O`	The plugin options.

Returns

void

Defined in

beforeDataLimits

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

desc Called before scale data limits are calculated. This hook is called separately for each scale in the chart.

Parameters

Name	Type	Description
`chart`	Chart<keyof , (`number` \| ScatterDataPoint \| )[], `unknown`>	The chart instance.
`args`	`Object`	The call arguments.
`args.scale`	Scale<>	The scale.
`options`	`O`	The plugin options.

Returns

void

Defined in

index.esm.d.ts:920 (opens new window)

beforeDatasetDraw

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

desc Called before drawing the chart dataset at the given args.index (datasets are drawn in the reverse order). If any plugin returns false, the datasets drawing is cancelled until another render is triggered.

Parameters

Name	Type	Description
`chart`	<keyof ChartTypeRegistry, (`number` \| \| BubbleDataPoint)[], `unknown`>	The chart instance.
`args`	`Object`	The call arguments.
`args.index`	`number`	The dataset index.
`args.meta`	<Element<`AnyObject`, `AnyObject`>, <`AnyObject`, `AnyObject`>, keyof ChartTypeRegistry>	The dataset metadata.
`options`	`O`	The plugin options.

Returns

boolean | void

false to cancel the chart datasets drawing.

Defined in

beforeDatasetUpdate

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

desc Called before updating the chart dataset at the given args.index. If any plugin returns false, the datasets update is cancelled until another update is triggered.

Parameters

Name	Type	Description
`chart`	Chart<keyof , (`number` \| ScatterDataPoint \| )[], `unknown`>	The chart instance.
`args`	`Object`	The call arguments.
`args.cancelable`	`true`	-
`args.index`	`number`	The dataset index.
`args.meta`	ChartMeta<<`AnyObject`, `AnyObject`>, Element<`AnyObject`, `AnyObject`>, keyof >	The dataset metadata.
`args.mode`	`“resize”` \| `“reset”` \| `“none”` \| `“hide”` \| `“show”` \| `“normal”` \| `“active”`	The update mode.
`options`	`O`	The plugin options.

Returns

boolean | void

false to cancel the chart datasets drawing.

Defined in

index.esm.d.ts:892 (opens new window)

beforeDatasetsDraw

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

desc Called before drawing the chart datasets. If any plugin returns false, the datasets drawing is cancelled until another render is triggered.

Parameters

Name	Type	Description
`chart`	<keyof ChartTypeRegistry, (`number` \| \| BubbleDataPoint)[], `unknown`>	The chart instance.
`args`	`Object`	The call arguments.
`args.cancelable`	`true`	-
`options`	`O`	The plugin options.

Returns

boolean | void

false to cancel the chart datasets drawing.

Defined in

beforeDatasetsUpdate

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

desc Called before updating the chart datasets. If any plugin returns false, the datasets update is cancelled until another update is triggered.

since version 2.1.5

Parameters

Name	Type	Description
`chart`	Chart<keyof , (`number` \| ScatterDataPoint \| )[], `unknown`>	The chart instance.
`args`	`Object`	The call arguments.
`args.mode`	`“resize”` \| `“reset”` \| `“none”` \| `“hide”` \| `“show”` \| `“normal”` \| `“active”`	The update mode.
`options`	`O`	The plugin options.

Returns

boolean | void

false to cancel the datasets update.

Defined in

index.esm.d.ts:870 (opens new window)

beforeDraw

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

desc Called before drawing chart at every animation frame. If any plugin returns false, the frame drawing is cancelled untilanother render is triggered.

Parameters

Name	Type	Description
`chart`	<keyof ChartTypeRegistry, (`number` \| \| BubbleDataPoint)[], `unknown`>	The chart instance.
`args`	`Object`	The call arguments.
`args.cancelable`	`true`	-
`options`	`O`	The plugin options.

Returns

boolean | void

false to cancel the chart drawing.

Defined in

beforeElementsUpdate

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

desc Called during the update process, before any chart elements have been created. This can be used for data decimation by changing the data array inside a dataset.

Parameters

Name	Type	Description
`chart`	Chart<keyof , (`number` \| ScatterDataPoint \| )[], `unknown`>	The chart instance.
`args`	`EmptyObject`	The call arguments.
`options`	`O`	The plugin options.

Returns

void

Defined in

index.esm.d.ts:851 (opens new window)

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

desc Called before processing the specified event. If any plugin returns false, the event will be discarded.

Parameters

Returns

boolean | void

Defined in

index.esm.d.ts:1036 (opens new window)

beforeInit

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

desc Called before initializing chart.

Parameters

Name	Type	Description
`chart`	<keyof ChartTypeRegistry, (`number` \| \| BubbleDataPoint)[], `unknown`>	The chart instance.
`args`	`EmptyObject`	The call arguments.
`options`	`O`	The plugin options.

Returns

void

Defined in

beforeLayout

desc Called before laying out chart. If any plugin returns false, the layout update is cancelled until another update is triggered.

Parameters

Name	Type	Description
`chart`	Chart<keyof , (`number` \| ScatterDataPoint \| )[], `unknown`>	The chart instance.
`args`	`Object`	The call arguments.
`args.cancelable`	`true`	-
`options`	`O`	The plugin options.

Returns

boolean | void

false to cancel the chart layout.

Defined in

index.esm.d.ts:912 (opens new window)

beforeRender

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

desc Called before rendering chart. If any plugin returns false, the rendering is cancelled until another render is triggered.

Parameters

Name	Type	Description
`chart`	<keyof ChartTypeRegistry, (`number` \| \| BubbleDataPoint)[], `unknown`>	The chart instance.
`args`	`Object`	The call arguments.
`args.cancelable`	`true`	-
`options`	`O`	The plugin options.

Returns

boolean | void

false to cancel the chart rendering.

Defined in

beforeTooltipDraw

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

desc Called before drawing the tooltip. If any plugin returns false, the tooltip drawing is cancelled until another render is triggered.

Parameters

Name	Type	Description
`chart`	Chart<keyof , (`number` \| ScatterDataPoint \| )[], `unknown`>	The chart instance.
`args`	`Object`	The call arguments.
`args.tooltip`	TooltipModel<`TType`>	The tooltip.
`options`	`O`	The plugin options.

Returns

boolean | void

false to cancel the chart tooltip drawing.

Inherited from

.beforeTooltipDraw

Defined in

index.esm.d.ts:2501 (opens new window)

beforeUpdate

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

desc Called before updating chart. If any plugin returns false, the update is cancelled (and thus subsequent render(s)) until another update is triggered.

Parameters

Name	Type	Description
`chart`	<keyof ChartTypeRegistry, (`number` \| \| BubbleDataPoint)[], `unknown`>	The chart instance.
`args`	`Object`	The call arguments.
`args.cancelable`	`true`	-
`args.mode`	`“resize”` \| `“reset”` \| `“none”` \| `“hide”` \| `“show”` \| `“normal”` \| `“active”`	The update mode
`options`	`O`	The plugin options.

Returns

boolean | void

false to cancel the chart update.

Defined in

destroy

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

Called after the chart has been destroyed.

Parameters

Name	Type	Description
`chart`	Chart<keyof , (`number` \| ScatterDataPoint \| )[], `unknown`>	The chart instance.
`args`	`EmptyObject`	The call arguments.
`options`	`O`	The plugin options.

Returns

void

Defined in

index.esm.d.ts:1062 (opens new window)

install

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

desc Called when plugin is installed for this chart instance. This hook is also invoked for disabled plugins (options === false).

since 3.0.0

Parameters

Name	Type	Description
`chart`	<keyof ChartTypeRegistry, (`number` \| \| BubbleDataPoint)[], `unknown`>	The chart instance.
`args`	`EmptyObject`	The call arguments.
`options`	`O`	The plugin options.

Returns

void

Defined in

reset

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

desc Called during chart reset

since version 3.0.0

Parameters

Name	Type	Description
`chart`	Chart<keyof , (`number` \| ScatterDataPoint \| )[], `unknown`>	The chart instance.
`args`	`EmptyObject`	The call arguments.
`options`	`O`	The plugin options.

Returns

void

Defined in

index.esm.d.ts:859 (opens new window)

resize

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

desc Called after the chart as been resized.

Parameters

Name	Type	Description
`chart`	<keyof ChartTypeRegistry, (`number` \| \| BubbleDataPoint)[], `unknown`>	The chart instance.
`args`	`Object`	The call arguments.
`args.size`	`Object`	The new canvas display size (eq. canvas.style width & height).
`args.size.height`	`number`	-
`args.size.width`	`number`	-
`options`	`O`	The plugin options.

Returns

void

Defined in

start

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

desc Called when a plugin is starting. This happens when chart is created or plugin is enabled.

since 3.0.0

Parameters

Name	Type	Description
`chart`	Chart<keyof , (`number` \| ScatterDataPoint \| )[], `unknown`>	The chart instance.
`args`	`EmptyObject`	The call arguments.
`options`	`O`	The plugin options.

Returns

void

Defined in

index.esm.d.ts:802 (opens new window)

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

desc Called when a plugin stopping. This happens when chart is destroyed or plugin is disabled.

since 3.0.0

Parameters

Returns

void

Defined in

index.esm.d.ts:810 (opens new window)

uninstall

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

Called after chart is destroyed on all plugins that were installed for that chart. This hook is also invoked for disabled plugins (options === false).

since 3.0.0

Parameters

Name	Type	Description
`chart`	<keyof ChartTypeRegistry, (`number` \| \| BubbleDataPoint)[], `unknown`>	The chart instance.
`args`	`EmptyObject`	The call arguments.
`options`	`O`	The plugin options.