Skip to content

Tooltip action

Use this action with change({ id: 'Tooltip', context }).

Context

  • id?: Get | Update (Update is assumed if omitted)
  • visible: true | false
  • mode: standard | cards | bubble | external
  • showMainTitle: true | false
  • mainTitle: Name | Description

Behavior

Tooltip supports:

  • Get: returns current tooltip settings in the same shape as Update context.
  • Update: applies one or more tooltip fields.

All Update fields are optional.

  • visible shows or hides the tooltip.
  • mode controls presentation:
    • standard: one shared tooltip
    • cards: one header card per pane
    • bubble: bubble-style tooltip
    • external: disables the built-in tooltip so the host can render tooltip data externally (see CH_TOOLTIPCHANGED).
  • showMainTitle toggles the main plot title inside tooltip content.
  • mainTitle selects whether that title uses symbol name or symbol description.