Skip to contents

Configuration for a boxplot chart series.

Usage

BoxplotSeries(
  name = NULL,
  data = NULL,
  x_axis_index = NULL,
  y_axis_index = NULL,
  silent = NULL,
  legend_hover_link = NULL,
  color = NULL,
  z_level = NULL,
  z = NULL,
  layout = NULL,
  box_width = NULL,
  item_style = NULL,
  label = NULL
)

Arguments

name

Optional Character: Series name.

data

Optional list: Boxplot data. Each element is c(min, Q1, median, Q3, max).

x_axis_index

Optional Numeric [0, Inf): X-axis index.

y_axis_index

Optional Numeric [0, Inf): Y-axis index.

silent

Optional Logical: Whether the series is silent.

Optional Logical: Whether to highlight related legends on hover.

color

Optional Character: Series color override.

z_level

Optional Numeric: Canvas layer index.

z

Optional Numeric: Front-back order within the same layer.

layout

Optional Character {"horizontal", "vertical"}: Layout orientation.

box_width

Optional Numeric or Character: Box-width range as a length-2 vector.

item_style

Optional ItemStyle: Boxplot styling.

label

Optional LabelOption: Data-label configuration.

Value

BoxplotSeries object.

Details

Corresponds to BoxplotSeriesOption in src/chart/boxplot/BoxplotSeries.ts (line 59). ECharts docs: https://echarts.apache.org/en/option.html#series-boxplot

Examples

# Each element is one box, given as its five-number summary.
BoxplotSeries(
  name = "Distribution",
  data = list(c(850, 940, 960, 980, 1070), c(750, 800, 840, 890, 1020))
)
#> <rtemis.draw::BoxplotSeries>
#>  @ name             : chr "Distribution"
#>  @ data             :List of 2
#>  .. $ : num [1:5] 850 940 960 980 1070
#>  .. $ : num [1:5] 750 800 840 890 1020
#>  @ x_axis_index     : NULL
#>  @ y_axis_index     : NULL
#>  @ silent           : NULL
#>  @ legend_hover_link: NULL
#>  @ color            : NULL
#>  @ z_level          : NULL
#>  @ z                : NULL
#>  @ layout           : NULL
#>  @ box_width        : NULL
#>  @ item_style       : NULL
#>  @ label            : NULL