Interface: Plugin<TType, O>

Type parameters

Hierarchy

• ExtendedPlugin<TType>

  ↳ Plugin

Properties

id

• id: string

Defined in: index.esm.d.ts:740 (opens new window)

Methods

afterBuildTicks

▸ OptionalafterBuildTicks(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: { scale: Scale<CoreScaleOptions> }, options: O): void

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

Parameters:

Returns: void

Defined in: index.esm.d.ts:899 (opens new window)

afterDataLimits

▸ OptionalafterDataLimits(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: { scale: Scale<CoreScaleOptions> }, options: O): void

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

Parameters:

Returns: void

Defined in: index.esm.d.ts:883 (opens new window)

afterDatasetDraw

▸ OptionalafterDatasetDraw(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: { index: number ; meta: ChartMeta<Element<{}, {}>, Element<{}, {}>> }, options: O): 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:

Returns: void

Defined in: index.esm.d.ts:981 (opens new window)

afterDatasetUpdate

▸ OptionalafterDatasetUpdate(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: { cancelable: false ; index: number ; meta: ChartMeta<Element<{}, {}>, Element<{}, {}>> ; mode: resize | reset | none | hide | show | normal | active }, options: O): 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:

Returns: void

Defined in: index.esm.d.ts:858 (opens new window)

afterDatasetsDraw

▸ OptionalafterDatasetsDraw(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: Record<string, never>, options: O, cancelable: false): 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:

Returns: void

Defined in: index.esm.d.ts:958 (opens new window)

afterDatasetsUpdate

▸ OptionalafterDatasetsUpdate(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: { cancelable: true ; mode: resize | reset | none | hide | show | normal | active }, options: O): 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:

Returns: void

Defined in: index.esm.d.ts:835 (opens new window)

afterDraw

▸ OptionalafterDraw(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: Record<string, never>, options: O): 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:

Returns: void

Defined in: index.esm.d.ts:941 (opens new window)

afterEvent

▸ OptionalafterEvent(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: { cancelable: false ; changed?: boolean ; event: ChartEvent ; replay: boolean }, options: O): 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:

Returns: void

Defined in: index.esm.d.ts:1002 (opens new window)

afterInit

▸ OptionalafterInit(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: Record<string, never>, options: O): void

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

Parameters:

Returns: void

Defined in: index.esm.d.ts:779 (opens new window)

afterLayout

▸ OptionalafterLayout(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: Record<string, never>, options: O): 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:

Returns: void

Defined in: index.esm.d.ts:907 (opens new window)

afterRender

▸ OptionalafterRender(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: Record<string, never>, options: O): 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:924 (opens new window)

afterTooltipDraw

▸ OptionalafterTooltipDraw(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: { tooltip: TooltipModel<TType> }, options: Record<string, unknown>): void

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

Parameters:

Returns: void

Inherited from: ExtendedPlugin

Defined in: index.esm.d.ts:2319 (opens new window)

afterUpdate

▸ OptionalafterUpdate(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: { mode: resize | reset | none | hide | show | normal | active }, options: O): 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:

Returns: void

Defined in: index.esm.d.ts:798 (opens new window)

beforeBuildTicks

▸ OptionalbeforeBuildTicks(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: { scale: Scale<CoreScaleOptions> }, options: O): void

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

Parameters:

Returns: void

Defined in: index.esm.d.ts:891 (opens new window)

beforeDataLimits

▸ OptionalbeforeDataLimits(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: { scale: Scale<CoreScaleOptions> }, options: O): void

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

Parameters:

Returns: void

Defined in: index.esm.d.ts:875 (opens new window)

beforeDatasetDraw

▸ OptionalbeforeDatasetDraw(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: { index: number ; meta: ChartMeta<Element<{}, {}>, Element<{}, {}>> }, options: O): 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:

Returns: boolean | void

false to cancel the chart datasets drawing.

Defined in: index.esm.d.ts:970 (opens new window)

beforeDatasetUpdate

▸ OptionalbeforeDatasetUpdate(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: { cancelable: true ; index: number ; meta: ChartMeta<Element<{}, {}>, Element<{}, {}>> ; mode: resize | reset | none | hide | show | normal | active }, options: O): 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:

Returns: boolean | void

false to cancel the chart datasets drawing.

Defined in: index.esm.d.ts:847 (opens new window)

beforeDatasetsDraw

▸ OptionalbeforeDatasetsDraw(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: { cancelable: true }, options: O): 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:

Returns: boolean | void

false to cancel the chart datasets drawing.

Defined in: index.esm.d.ts:950 (opens new window)

beforeDatasetsUpdate

▸ OptionalbeforeDatasetsUpdate(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: { mode: resize | reset | none | hide | show | normal | active }, options: O): 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:

Returns: boolean | void

false to cancel the datasets update.

Defined in: index.esm.d.ts:825 (opens new window)

beforeDraw

▸ OptionalbeforeDraw(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: { cancelable: true }, options: O): 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:

Returns: boolean | void

false to cancel the chart drawing.

Defined in: index.esm.d.ts:933 (opens new window)

beforeElementsUpdate

▸ OptionalbeforeElementsUpdate(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: Record<string, never>, options: O): 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:

Returns: void

Defined in: index.esm.d.ts:806 (opens new window)

beforeEvent

▸ OptionalbeforeEvent(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: { cancelable: true ; event: ChartEvent ; replay: boolean }, options: O): 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:991 (opens new window)

beforeInit

▸ OptionalbeforeInit(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: Record<string, never>, options: O): void

desc Called before initializing chart.

Parameters:

Returns: void

Defined in: index.esm.d.ts:772 (opens new window)

beforeLayout

▸ OptionalbeforeLayout(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: { cancelable: true }, options: O): boolean | void

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

Parameters:

Returns: boolean | void

false to cancel the chart layout.

Defined in: index.esm.d.ts:867 (opens new window)

beforeRender

▸ OptionalbeforeRender(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: { cancelable: true }, options: O): boolean | void

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

Parameters:

Returns: boolean | void

false to cancel the chart rendering.

Defined in: index.esm.d.ts:916 (opens new window)

beforeTooltipDraw

▸ OptionalbeforeTooltipDraw(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: { tooltip: TooltipModel<TType> }, options: Record<string, unknown>): boolean | void

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

Parameters:

Returns: boolean | void

false to cancel the chart tooltip drawing.

Inherited from: ExtendedPlugin

Defined in: index.esm.d.ts:2310 (opens new window)

beforeUpdate

▸ OptionalbeforeUpdate(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: { cancelable: true ; mode: resize | reset | none | hide | show | normal | active }, options: O): 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:

Returns: boolean | void

false to cancel the chart update.

Defined in: index.esm.d.ts:789 (opens new window)

destroy

▸ Optionaldestroy(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: Record<string, never>, options: O): void

Called after the chart has been destroyed.

Parameters:

Returns: void

Defined in: index.esm.d.ts:1017 (opens new window)

install

▸ Optionalinstall(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: Record<string, never>, options: O): 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:

Returns: void

Defined in: index.esm.d.ts:749 (opens new window)

reset

▸ Optionalreset(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: Record<string, never>, options: O): void

desc Called during chart reset

since version 3.0.0

Parameters:

Returns: void

Defined in: index.esm.d.ts:814 (opens new window)

resize

▸ Optionalresize(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: { size: { height: number ; width: number } }, options: O): void

desc Called after the chart as been resized.

Parameters:

Returns: void

Defined in: index.esm.d.ts:1010 (opens new window)

start

▸ Optionalstart(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: Record<string, never>, options: O): void

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

since 3.0.0

Parameters:

Returns: void

Defined in: index.esm.d.ts:757 (opens new window)

stop

▸ Optionalstop(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: Record<string, never>, options: O): 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:765 (opens new window)

uninstall

▸ Optionaluninstall(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, args: Record<string, never>, options: O): 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:

Returns: void

Defined in: index.esm.d.ts:1025 (opens new window)