Skip to contents

Text styling used in labels, titles, tooltips, and other text elements.

Usage

TextStyle(
  color = NULL,
  font_style = NULL,
  font_weight = NULL,
  font_family = NULL,
  font_size = NULL,
  align = NULL,
  vertical_align = NULL,
  opacity = NULL,
  line_height = NULL,
  background_color = NULL,
  border_color = NULL,
  border_width = NULL,
  border_type = NULL,
  border_dash_offset = NULL,
  border_radius = NULL,
  padding = NULL,
  width = NULL,
  height = NULL,
  text_border_color = NULL,
  text_border_width = NULL,
  text_border_type = NULL,
  text_border_dash_offset = NULL,
  text_shadow_blur = NULL,
  text_shadow_color = NULL,
  text_shadow_offset_x = NULL,
  text_shadow_offset_y = NULL,
  overflow = NULL,
  ellipsis = NULL,
  rich = NULL,
  shadow_blur = NULL,
  shadow_color = NULL,
  shadow_offset_x = NULL,
  shadow_offset_y = NULL
)

Arguments

color

Optional Character: Text color.

font_style

Optional Character {"normal", "italic", "oblique"}: Font style.

font_weight

Optional Character {"normal", "bold", "bolder", "lighter"} or Numeric [100, 900]: Font weight.

font_family

Optional Character: Font family name.

font_size

Optional Numeric or Character: Font size.

align

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

vertical_align

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

opacity

Optional Numeric [0, 1]: Text opacity.

line_height

Optional Numeric [0, Inf): Line height in pixels.

background_color

Optional Character: Background color behind text.

border_color

Optional Character: Text box border color.

border_width

Optional Numeric [0, Inf): Text box border width.

border_type

Optional Character {"solid", "dashed", "dotted"}: Text box border type.

border_dash_offset

Optional Numeric: Text box border dash offset.

border_radius

Optional Numeric or Numeric vector: Text box corner radius.

padding

Optional Numeric or Numeric vector: Text box padding.

width

Optional Numeric or Character: Text box width.

height

Optional Numeric [0, Inf): Text box height.

text_border_color

Optional Character: Stroke color around the text.

text_border_width

Optional Numeric [0, Inf): Stroke width around the text.

text_border_type

Optional Character {"solid", "dashed", "dotted"}: Stroke type around the text.

text_border_dash_offset

Optional Numeric: Stroke dash offset around the text.

text_shadow_blur

Optional Numeric [0, Inf): Text shadow blur radius.

text_shadow_color

Optional Character: Text shadow color.

text_shadow_offset_x

Optional Numeric: Text shadow horizontal offset.

text_shadow_offset_y

Optional Numeric: Text shadow vertical offset.

overflow

Optional Character {"truncate", "break", "breakAll", "none"}: Text overflow behavior.

ellipsis

Optional Character: Ellipsis string used when truncating.

rich

Optional Named list: Rich text styles.

shadow_blur

Optional Numeric [0, Inf): Box shadow blur radius.

shadow_color

Optional Character: Box shadow color.

shadow_offset_x

Optional Numeric: Box shadow horizontal offset.

shadow_offset_y

Optional Numeric: Box shadow vertical offset.

Details

Corresponds to TextCommonOption in src/util/types.ts (line 1220). ECharts docs: https://echarts.apache.org/en/option.html#title.textStyle