Skip to contents

Title

Title.Rd

Chart title configuration with main text and optional subtext.

Usage

Title(
  show = NULL,
  text = NULL,
  link = NULL,
  target = NULL,
  subtext = NULL,
  sublink = NULL,
  subtarget = NULL,
  text_align = NULL,
  text_vertical_align = NULL,
  padding = NULL,
  item_gap = NULL,
  text_style = NULL,
  subtext_style = NULL,
  trigger_event = NULL,
  background_color = NULL,
  border_color = NULL,
  border_width = NULL,
  border_radius = NULL,
  left = NULL,
  right = NULL,
  top = NULL,
  bottom = NULL
)

Arguments

show

Optional Logical: Whether to show the title.

text

Optional Character: Main title text. Supports \\n for newlines.

Optional Character: Hyperlink for the main title.

target

Optional Character {"self", "blank"}: Link target.

subtext

Optional Character: Subtitle text.

Optional Character: Hyperlink for the subtitle.

subtarget

Optional Character {"self", "blank"}: Subtitle link target.

text_align

Optional Character {"auto", "left", "center", "right"}: Horizontal alignment.

text_vertical_align

Optional Character {"auto", "top", "middle", "bottom"}: Vertical alignment.

padding

Optional Numeric: Padding inside the title box.

item_gap

Optional Numeric [0, Inf): Gap between title and subtitle in pixels.

text_style

Optional TextStyle: Main title text style.

subtext_style

Optional TextStyle: Subtitle text style.

trigger_event

Optional Logical: Whether the title emits events.

background_color

Optional Character: Title-box background color.

border_color

Optional Character: Border color.

border_width

Optional Numeric [0, Inf): Border width.

border_radius

Optional Numeric: Border radius.

left

Optional Numeric or Character: Left position.

right

Optional Numeric or Character: Right position.

top

Optional Numeric or Character: Top position.

bottom

Optional Numeric or Character: Bottom position.

Details

Corresponds to TitleOption in src/component/title/install.ts (line 48). ECharts docs: https://echarts.apache.org/en/option.html#title