TooltipConfig

interface TooltipConfig<A extends Annotation, C extends Chart>

An interface that defines the parameters for a call to the tooltip function.

Type parameters

  • A: Annotation

  • C: Chart

Properties

annotations

annotations: A []

The Annotations to which the interaction is applied.

backgroundColor

backgroundColor: undefined | string | GlyphCallback <A, C, string>

This defines the background color of the tooltip.

borderRadius

borderRadius: undefined | number | GlyphCallback <A, C, number>

This defines the border radius of the tooltip.

chart

chart: undefined | C

The Chart to which the interaction is applied.

opacity

opacity: undefined | number | GlyphCallback <A, C, number>

This defines the opacity of the tooltip.

padding

padding: undefined | number | GlyphCallback <A, C, number>

This defines the CSS padding of the tooltip.

selector

selector: undefined | string

The selector of the glyphs to which the interaction is applied.

text

text: GlyphProperty <A, C, string>

This defines the text for the tooltip.

textColor

textColor: undefined | string | GlyphCallback <A, C, string>

This defines the tooltip text color.