Called after scale data limits are calculated. This hook is called separately for each scale in the chart.
The chart instance.
The call arguments.
The scale.
The plugin options.
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.
The chart instance.
The call arguments.
The dataset index.
The dataset metadata.
The plugin options.
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.
The chart instance.
The call arguments.
The dataset index.
The dataset metadata.
The update mode.
The plugin options.
Called after the chart
datasets have been drawn. Note that this hook
will not be called if the datasets drawing has been previously cancelled.
The chart instance.
The call arguments.
The plugin options.
Called after the chart
datasets have been updated. Note that this hook
will not be called if the datasets update has been previously cancelled.
The chart instance.
The call arguments.
The update mode.
The plugin options.
version 2.1.5
Called after the chart has been destroyed.
The chart instance.
The call arguments.
The plugin options.
Called after the chart
has been drawn. Note that this hook will not be called
if the drawing has been previously cancelled.
The chart instance.
The call arguments.
The plugin options.
Called after the event
has been consumed. Note that this hook
will not be called if the event
has been previously discarded.
The chart instance.
The call arguments.
The event object.
True if this event is replayed from Chart.update
The event position is inside chartArea
Set to true if the plugin needs a render. Should only be changed to true, because this args object is passed through all plugins.
The plugin options.
Called after chart
has been initialized and before the first update.
The chart instance.
The call arguments.
The plugin options.
Called after the chart
has been laid out. Note that this hook will not
be called if the layout update has been previously cancelled.
The chart instance.
The call arguments.
The plugin options.
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.
The chart instance.
The call arguments.
The plugin options.
Called after drawing the tooltip
. Note that this hook will not
be called if the tooltip drawing has been previously cancelled.
The chart instance.
The call arguments.
The tooltip.
The plugin options.
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.
The chart instance.
The call arguments.
The update mode
The plugin options.
Called before scale bulds its ticks. This hook is called separately for each scale in the chart.
The chart instance.
The call arguments.
The scale.
The plugin options.
Called before scale data limits are calculated. This hook is called separately for each scale in the chart.
The chart instance.
The call arguments.
The scale.
The plugin options.
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.
The chart instance.
The call arguments.
The dataset index.
The dataset metadata.
The plugin options.
false
to cancel the chart datasets drawing.
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.
The chart instance.
The call arguments.
The dataset index.
The dataset metadata.
The update mode.
The plugin options.
false
to cancel the chart datasets drawing.
Called before drawing the chart
datasets. If any plugin returns false
,
the datasets drawing is cancelled until another render
is triggered.
The chart instance.
The call arguments.
The plugin options.
false
to cancel the chart datasets drawing.
Called before updating the chart
datasets. If any plugin returns false
,
the datasets update is cancelled until another update
is triggered.
The chart instance.
The call arguments.
The update mode.
The plugin options.
false to cancel the datasets update.
version 2.1.5
Called before the chart is being destroyed.
The chart instance.
The call arguments.
The plugin options.
Called before drawing chart
at every animation frame. If any plugin returns false
,
the frame drawing is cancelled untilanother render
is triggered.
The chart instance.
The call arguments.
The plugin options.
false
to cancel the chart drawing.
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.
The chart instance.
The call arguments.
The plugin options.
Called before processing the specified event
. If any plugin returns false
,
the event will be discarded.
The chart instance.
The call arguments.
The event object.
True if this event is replayed from Chart.update
The event position is inside chartArea
The plugin options.
Called before initializing chart
.
Called before laying out chart
. If any plugin returns false
,
the layout update is cancelled until another update
is triggered.
The chart instance.
The call arguments.
The plugin options.
false
to cancel the chart layout.
Called before rendering chart
. If any plugin returns false
,
the rendering is cancelled until another render
is triggered.
The chart instance.
The call arguments.
The plugin options.
false
to cancel the chart rendering.
Called before drawing the tooltip
. If any plugin returns false
,
the tooltip drawing is cancelled until another render
is triggered.
The chart instance.
The call arguments.
The tooltip.
The plugin options.
false
to cancel the chart tooltip drawing.
Called before updating chart
. If any plugin returns false
, the update
is cancelled (and thus subsequent render(s)) until another update
is triggered.
false
to cancel the chart update.
Called after the chart has been destroyed.
The chart instance.
The call arguments.
The plugin options.
since version 3.7.0 in favour of afterDestroy
Called when plugin is installed for this chart instance. This hook is also invoked for disabled plugins (options === false).
The chart instance.
The call arguments.
The plugin options.
3.0.0
Called during chart reset
The chart instance.
The call arguments.
The plugin options.
version 3.0.0
Called after the chart as been resized.
The chart instance.
The call arguments.
The new canvas display size (eq. canvas.style width & height).
The plugin options.
Called when a plugin is starting. This happens when chart is created or plugin is enabled.
3.0.0
Called when a plugin stopping. This happens when chart is destroyed or plugin is disabled.
3.0.0
Called after chart is destroyed on all plugins that were installed for that chart. This hook is also invoked for disabled plugins (options === false).
The chart instance.
The call arguments.
The plugin options.
3.0.0
Generated using TypeDoc
Called after scale has build its ticks. This hook is called separately for each scale in the chart.
The chart instance.
The call arguments.
The scale.
The plugin options.