Skip to main content

CustomTooltipProps

@elastic/charts • Exports

@elastic/charts / CustomTooltipProps

Interface: CustomTooltipProps<D, SI>

The set of info used to render the a tooltip.

Contents​

Extends​

Type parameters​

• D extends BaseDatum = Datum

• SI extends SeriesIdentifier = SeriesIdentifier

Properties​

backgroundColor​

backgroundColor: string

Background color for use with contrast ratios

Source​

packages/charts/src/components/tooltip/types.ts:51

dir​

dir: "ltr" | "rtl"

Source​

packages/charts/src/components/tooltip/types.ts:46

header: null | PointerValue<D>

The TooltipValue for the header. On XYAxis chart the x value

Inherited from​

TooltipInfo.header

Source​

packages/charts/src/components/tooltip/types.ts:24

headerFormatter?​

headerFormatter?: TooltipValueFormatter<D, SI>

Source​

packages/charts/src/components/tooltip/types.ts:45

pinned​

pinned: boolean

Tooltip is pinned

Source​

packages/charts/src/components/tooltip/types.ts:56

selected​

selected: TooltipValue<D, SI>[]

Selected items - For use with actions

TODO: permit other values than TooltipValue types

Source​

packages/charts/src/components/tooltip/types.ts:64

setSelection​

setSelection: (items) => void

Allows setting the selected items - For use with actions

TODO: permit other values than TooltipValue types

Parameters​

• items: TooltipValue<D, SI>[]

Returns​

void

Source​

packages/charts/src/components/tooltip/types.ts:79

toggleSelected​

toggleSelected: (item) => void

Toggles selected items - For use with actions

TODO: permit other values than TooltipValue types

Parameters​

• item: TooltipValue<D, SI>

Returns​

void

Source​

packages/charts/src/components/tooltip/types.ts:72

values​

values: TooltipValue<D, SI>[]

The array of TooltipValues to show on the tooltip. On XYAxis chart correspond to the set of y values for each series

Inherited from​

TooltipInfo.values

Source​

packages/charts/src/components/tooltip/types.ts:29

Generated using typedoc-plugin-markdown and TypeDoc