API / Components / ChartTooltipContentProps
Defined in: src/components/Tooltip/ChartTooltipContent.tsx:16
Properties
| Property | Type | Description |
|---|---|---|
headerFormat? |
ValueFormat |
- |
hovered? |
TooltipDataChunk[] |
- |
hoveredPlotBands? |
AxisPlotBand[] |
- |
hoveredPlotLines? |
AxisPlotLine[] |
- |
hoveredPlotShapes? |
AxisPlotShape[] |
- |
pinned? |
boolean |
- |
qa? |
string |
- |
renderer? |
(args: ChartTooltipRendererArgs) => null | RendererElement |
- |
rowRenderer? |
null | (args) => string | RendererElement |
- |
rows? |
ChartTooltipRow[] |
- |
totals? |
object |
- |
totals.aggregation? |
"sum" | (args) => ChartTooltipTotalsAggregationValue |
The aggregation method for calculating totals. It can be a built-in function (e.g., 'sum') or a custom function. Area-range contributes its width (y1 - y0); x-range contributes its duration (abs(x1 - x0)). X-range intervals on category X axes are excluded from built-in totals. 'sum' adds interval widths, not interval unions. On datetime X axes, x-range durations are in milliseconds. Set totals.valueFormat to format them as durations, e.g. with a custom formatter, rather than as dates. Default 'sum' |
totals.enabled? |
boolean |
Enables/disables the display of totals Default false |
totals.label? |
string |
The label text for the totals. For built-in aggregations, the label can be omitted. |
totals.valueFormat? |
ValueFormat |
Formatting settings for totals tooltip value. |
valueFormat? |
ValueFormat |
- |
xAxis? |
null | ChartXAxis |
- |
yAxes? |
ChartYAxis[] |
All Y axes. Takes precedence over yAxis when resolving series values. |
yAxis? |
ChartYAxis |
- |
Previous
Next