Interface: ExtendedPlugin<TType, O, Model>

Type parameters

NameTypeDefault
TTypeChartType-
O-AnyObject
Model-TooltipModel<TType>

Hierarchy

Methods

afterTooltipDraw

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

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

Parameters:

NameTypeDescription
chartChart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>The chart instance.
argsobjectThe call arguments.
args.tooltipModelThe tooltip.
optionsOThe plugin options.

Returns: void

Defined in: index.esm.d.ts:2319ExtendedPlugin - 图1 (opens new window)


beforeTooltipDraw

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

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

Parameters:

NameTypeDescription
chartChart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>The chart instance.
argsobjectThe call arguments.
args.tooltipModelThe tooltip.
optionsOThe plugin options.

Returns: boolean | void

false to cancel the chart tooltip drawing.

Defined in: index.esm.d.ts:2310ExtendedPlugin - 图2 (opens new window)