Skip to contents

Bar Series

Source: R/series.R
BarSeries.Rd

Configuration for a bar chart series.

Usage

BarSeries(
  name = NULL,
  data = NULL,
  x_axis_index = NULL,
  y_axis_index = NULL,
  stack = NULL,
  silent = NULL,
  legend_hover_link = NULL,
  color = NULL,
  z_level = NULL,
  z = NULL,
  clip = NULL,
  bar_width = NULL,
  bar_max_width = NULL,
  bar_min_width = NULL,
  bar_min_height = NULL,
  bar_gap = NULL,
  bar_category_gap = NULL,
  round_cap = NULL,
  show_background = NULL,
  item_style = NULL,
  label = NULL
)

Arguments

name

Optional Character: Series name for legend display.

data

Optional Vector or list: Data values.

x_axis_index

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

y_axis_index

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

stack

Optional Character: Stack group name.

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.

clip

Optional Logical: Whether to clip overflow.

bar_width

Optional Numeric or Character: Bar width.

bar_max_width

Optional Numeric or Character: Maximum bar width.

bar_min_width

Optional Numeric or Character: Minimum bar width.

bar_min_height

Optional Numeric [0, Inf): Minimum bar height.

bar_gap

Optional Numeric or Character: Gap between bars in the same category.

bar_category_gap

Optional Numeric or Character: Gap between categories.

round_cap

Optional Logical: Whether to use a round cap.

show_background

Optional Logical: Whether to show the bar background.

item_style

Optional ItemStyle: Bar styling.

label

Optional LabelOption: Data-label configuration.

Value

BarSeries object.

Details

Corresponds to BarSeriesOption in src/chart/bar/BarSeries.ts (line 68) and BaseBarSeriesOption in src/chart/bar/BaseBarSeries.ts (line 38). ECharts docs: https://echarts.apache.org/en/option.html#series-bar

Examples

BarSeries(name = "Counts", data = c(3, 7, 2))
#> <rtemis.draw::BarSeries>
#>  @ name             : chr "Counts"
#>  @ data             : num [1:3] 3 7 2
#>  @ x_axis_index     : NULL
#>  @ y_axis_index     : NULL
#>  @ stack            : NULL
#>  @ silent           : NULL
#>  @ legend_hover_link: NULL
#>  @ color            : NULL
#>  @ z_level          : NULL
#>  @ z                : NULL
#>  @ clip             : NULL
#>  @ bar_width        : NULL
#>  @ bar_max_width    : NULL
#>  @ bar_min_width    : NULL
#>  @ bar_min_height   : NULL
#>  @ bar_gap          : NULL
#>  @ bar_category_gap : NULL
#>  @ round_cap        : NULL
#>  @ show_background  : NULL
#>  @ item_style       : NULL
#>  @ label            : NULL