echarts4r (version 0.4.0)

e_tooltip: Tooltip

Description

Customise tooltip

Usage

e_tooltip(e, trigger = c("item", "axis"), formatter = NULL, ...)
e_tooltip_item_formatter(
  style = c("decimal", "percent", "currency"),
  digits = 0,
  locale = NULL,
  currency = "USD"
)
e_tooltip_choro_formatter(
  style = c("decimal", "percent", "currency"),
  digits = 0,
  locale = NULL,
  currency = "USD"
)
e_tooltip_pie_formatter(
  style = c("decimal", "percent", "currency"),
  digits = 0,
  locale = NULL,
  currency = "USD",
  ...
)
e_tooltip_pointer_formatter(
  style = c("decimal", "percent", "currency"),
  digits = 0,
  locale = NULL,
  currency = "USD"
)

Arguments

e

An echarts4r object as returned by e_charts or a proxy as returned by echarts4rProxy.

trigger

What triggers the tooltip, one of item or item.

formatter

Item and Pointer formatter as returned by e_tooltip_item_formatter, e_tooltip_pointer_formatter, e_tooltip_pie_formatter.

...

Any other option to pass, check See Also section.

style

Formatter style, one of decimal, percent, or currency.

digits

Number of decimals.

locale

Locale, if NULL then it is inferred from Sys.getlocale.

currency

Currency to to display.

Formatters

• e_tooltip_pie_formatter: special helper for e_pie.

• e_tooltip_item_formatter: general helper, this is passed to the tooltip formatter.

• e_tooltip_pointer_formatter: helper for pointer, this is passed to the label parameter under axisPointer.

See Also

Additional arguments

Examples

# NOT RUN {
# basic
USArrests %>%
  e_charts(Assault) %>%
  e_scatter(Murder) %>%
  e_tooltip()

# formatter
cars %>%
  dplyr::mutate(
    dist = dist / 120
  ) %>%
  e_charts(speed) %>%
  e_scatter(dist, symbol_size = 5) %>%
  e_tooltip(
    formatter = e_tooltip_item_formatter("percent")
  )

# axis pointer
cars %>%
  e_charts(speed) %>%
  e_scatter(dist, symbol_size = 5) %>%
  e_tooltip(
    formatter = e_tooltip_pointer_formatter("currency"),
    axisPointer = list(
      type = "cross"
    )
  )
# }