Skip to main content

TooltipAction

@elastic/chartsExports


@elastic/charts / TooltipAction

Type alias: TooltipAction<D, SI>

TooltipAction<D, SI>: Object

Tooltip action parameters

Type parameters

D extends BaseDatum = Datum

SI extends SeriesIdentifier = SeriesIdentifier

Type declaration

disabled?

disabled?: (selected, allItems) => boolean | string

Disables action when true or string description is passed If a string is passed, it will be used as the title to display reason for disablement

Parameters

selected: TooltipValue<D, SI>[]

allItems: TooltipValue<D, SI>[]

Returns

boolean | string

hide?

hide?: (selected, allItems) => boolean

Hides action from list

Parameters

selected: TooltipValue<D, SI>[]

allItems: TooltipValue<D, SI>[]

Returns

boolean

label

label: string | (selected, allItems) => ReactNode

Clickable label to display action

onSelect

onSelect: (selected, allItems) => void

Callback trigger when action is selected

Parameters

selected: TooltipValue<D, SI>[]

allItems: TooltipValue<D, SI>[]

Returns

void

Source

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


Generated using typedoc-plugin-markdown and TypeDoc