Skip to contents

Tooltip configuration for showing data on hover/click.

Usage

Tooltip(
  show = NULL,
  trigger = NULL,
  trigger_on = NULL,
  show_content = NULL,
  always_show_content = NULL,
  formatter = NULL,
  value_formatter = NULL,
  position = NULL,
  confine = NULL,
  enterable = NULL,
  show_delay = NULL,
  hide_delay = NULL,
  transition_duration = NULL,
  background_color = NULL,
  border_color = NULL,
  border_width = NULL,
  border_radius = NULL,
  padding = NULL,
  text_style = NULL,
  extra_css_text = NULL,
  order = NULL,
  class_name = NULL
)

Arguments

show

Optional Logical: Whether to show the tooltip.

trigger

Optional Character {"item", "axis", "none"}: Trigger type.

trigger_on

Optional Character {"mousemove", "click", "none", "mousemove|click"}: Trigger event. "mousemove|click".

show_content

Optional Logical: Whether to show tooltip content.

always_show_content

Optional Logical: Whether to keep the tooltip visible.

formatter

Optional Character or function: Tooltip content formatter.

value_formatter

Optional function: Formatter for the value portion.

position

Optional Character or Numeric: Tooltip position.

confine

Optional Logical: Whether to confine the tooltip within the chart container.

enterable

Optional Logical: Whether the mouse can enter the tooltip.

show_delay

Optional Numeric [0, Inf): Delay before showing, in milliseconds.

hide_delay

Optional Numeric [0, Inf): Delay before hiding, in milliseconds.

transition_duration

Optional Numeric [0, Inf): Transition duration in seconds.

background_color

Optional Character: Background color.

border_color

Optional Character: Border color.

border_width

Optional Numeric [0, Inf): Border width.

border_radius

Optional Numeric [0, Inf): Border radius.

padding

Optional Numeric: Padding inside the tooltip.

text_style

Optional TextStyle: Tooltip text style.

extra_css_text

Optional Character: Extra CSS for HTML render mode.

order

Optional Character {"seriesAsc", "seriesDesc", "valueAsc", "valueDesc"}: Tooltip content order.

class_name

Optional Character: CSS class name for the tooltip element.

Details

Corresponds to TooltipOption in src/component/tooltip/TooltipModel.ts (line 36) and CommonTooltipOption in src/util/types.ts (line 1527). ECharts docs: https://echarts.apache.org/en/option.html#tooltip