Skip to main content

TooltipValue

@elastic/charts • Exports

@elastic/charts / TooltipValue

Interface: TooltipValue<D, SI>

This interface describe the properties of single value shown in the tooltip

Contents​

Extends​

Type parameters​

• D extends BaseDatum = Datum

• SI extends SeriesIdentifier = SeriesIdentifier

Properties​

color​

color: string

The color of the graphic mark (by default the color of the series)

Source​

packages/charts/src/specs/tooltip.ts:50

datum?​

datum?: D

The datum associated with the current tooltip value Maybe not available

Source​

packages/charts/src/specs/tooltip.ts:67

formattedMarkValue?​

formattedMarkValue?: null | string

The mark value to display

Source​

packages/charts/src/specs/tooltip.ts:46

formattedValue​

formattedValue: string

The formatted value to display

Inherited from​

PointerValue.formattedValue

Source​

packages/charts/src/state/types.ts:177

isHighlighted​

isHighlighted: boolean

True if the mouse is over the graphic mark connected to the tooltip

Source​

packages/charts/src/specs/tooltip.ts:54

isVisible​

isVisible: boolean

True if the tooltip is visible, false otherwise

Source​

packages/charts/src/specs/tooltip.ts:58

label​

label: string

The label of the tooltip value

Source​

packages/charts/src/specs/tooltip.ts:38

markValue?​

markValue?: null | number

The mark value

Source​

packages/charts/src/specs/tooltip.ts:42

seriesIdentifier​

seriesIdentifier: SI

The identifier of the related series

Source​

packages/charts/src/specs/tooltip.ts:62

value​

value: any

The value

Inherited from​

PointerValue.value

Source​

packages/charts/src/state/types.ts:173

valueAccessor?​

valueAccessor?: Accessor<D>

The accessor linked to the current tooltip value

Inherited from​

PointerValue.valueAccessor

Source​

packages/charts/src/state/types.ts:181

Generated using typedoc-plugin-markdown and TypeDoc