Skip to contents

Line Series

Source: R/series.R
LineSeries.Rd

Configuration for a line chart series.

Usage

LineSeries(
  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,
  smooth = NULL,
  step = NULL,
  connect_nulls = NULL,
  clip = NULL,
  show_symbol = NULL,
  symbol = NULL,
  symbol_size = NULL,
  symbol_rotate = NULL,
  symbol_offset = NULL,
  line_style = NULL,
  area_style = NULL,
  item_style = NULL,
  label = NULL,
  mark_area = NULL
)

Arguments

name

Optional Character: Series name for legend display.

data

Optional Numeric 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.

smooth

Optional Logical or Numeric [0, 1]: Line smoothing.

step

Optional Logical or Character {"start", "end", "middle"}: Step line mode.

connect_nulls

Optional Logical: Whether to connect across NULL points.

clip

Optional Logical: Whether to clip overflow.

show_symbol

Optional Logical: Whether to show data-point symbols.

symbol

Optional Character {"circle", "rect", "roundRect", "triangle", "diamond", "pin", "arrow", "none"}: Symbol type. "diamond", "pin", "arrow", "none", or custom SVG path.

symbol_size

Optional Numeric: Symbol size in pixels.

symbol_rotate

Optional Numeric: Symbol rotation in degrees, counter-clockwise-positive. A symbol is unrotated at 0.

symbol_offset

Optional Numeric or Character: Shift from the data point as c(x, y), in screen pixels (numbers) or as a percentage of the symbol's own size (strings, e.g. c("0%", "-50%")). Applied after symbol_rotate, in the unrotated frame.

line_style

Optional LineStyle: Line styling.

area_style

Optional AreaStyle: Area fill styling.

item_style

Optional ItemStyle: Data-point marker styling.

label

Optional LabelOption: Data-label configuration.

mark_area

Optional MarkArea: Shaded bands (e.g. vertical highlight regions across x-ranges).

Value

LineSeries object.

Details

Corresponds to LineSeriesOption in src/chart/line/LineSeries.ts (line 74). ECharts docs: https://echarts.apache.org/en/option.html#series-line

Examples

LineSeries(name = "Sessions", data = c(150, 230, 224), smooth = TRUE)
#> <rtemis.draw::LineSeries>
#>  @ name             : chr "Sessions"
#>  @ data             : num [1:3] 150 230 224
#>  @ x_axis_index     : NULL
#>  @ y_axis_index     : NULL
#>  @ stack            : NULL
#>  @ silent           : NULL
#>  @ legend_hover_link: NULL
#>  @ color            : NULL
#>  @ z_level          : NULL
#>  @ z                : NULL
#>  @ smooth           : logi TRUE
#>  @ step             : NULL
#>  @ connect_nulls    : NULL
#>  @ clip             : NULL
#>  @ show_symbol      : NULL
#>  @ symbol           : NULL
#>  @ symbol_size      : NULL
#>  @ symbol_rotate    : NULL
#>  @ symbol_offset    : NULL
#>  @ line_style       : NULL
#>  @ area_style       : NULL
#>  @ item_style       : NULL
#>  @ label            : NULL
#>  @ mark_area        : NULL