Skip to contents

Scatter Series

Source: R/series.R
ScatterSeries.Rd

Configuration for a scatter (point) chart series.

Usage

ScatterSeries(
  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,
  clip = NULL,
  symbol = NULL,
  symbol_size = NULL,
  symbol_rotate = NULL,
  symbol_offset = NULL,
  large = NULL,
  large_threshold = 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.

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.

symbol

Optional Character: Symbol type.

symbol_size

Optional Numeric or function: Symbol size.

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.

large

Optional Logical: Whether to enable large-data optimization.

large_threshold

Optional Numeric [0, Inf): Threshold for large mode.

item_style

Optional ItemStyle: Data-point marker styling.

label

Optional LabelOption: Data-label configuration.

Value

ScatterSeries object.

Details

Corresponds to ScatterSeriesOption in src/chart/scatter/ScatterSeries.ts (line 64). ECharts docs: https://echarts.apache.org/en/option.html#series-scatter

Examples

ScatterSeries(name = "Points", data = list(c(1, 2), c(3, 4)), symbol_size = 8)
#> <rtemis.draw::ScatterSeries>
#>  @ name             : chr "Points"
#>  @ data             :List of 2
#>  .. $ : num [1:2] 1 2
#>  .. $ : num [1:2] 3 4
#>  @ x_axis_index     : NULL
#>  @ y_axis_index     : NULL
#>  @ silent           : NULL
#>  @ legend_hover_link: NULL
#>  @ color            : NULL
#>  @ z_level          : NULL
#>  @ z                : NULL
#>  @ clip             : NULL
#>  @ symbol           : NULL
#>  @ symbol_size      : num 8
#>  @ symbol_rotate    : NULL
#>  @ symbol_offset    : NULL
#>  @ large            : NULL
#>  @ large_threshold  : NULL
#>  @ item_style       : NULL
#>  @ label            : NULL