Mark Area

Container for markArea bands attached to a series. data is a list where each element is a length-2 list of MarkAreaDataPoint (or plain named list) defining the two opposite corners of one band.

Usage

MarkArea(
  data = NULL,
  silent = NULL,
  precision = NULL,
  item_style = NULL,
  label = NULL,
  z2 = NULL
)

Arguments

data

Optional list: List of length-2 lists of MarkAreaDataPoint / plain named list. Each inner pair defines one band.

silent

Optional Logical: Whether hover / tooltip are disabled.

precision

Optional Integer [0, Inf): Decimal precision used by statistical methods ("min", "max", etc.).

item_style

Optional ItemStyle: Default fill/border styling for all bands. Per-band overrides go on the first MarkAreaDataPoint of a pair.

label

Optional LabelOption: Default label configuration.

z2

Optional Numeric: Front-back order among markers.

Value

MarkArea object.

Details

Corresponds to MarkAreaOption in src/component/marker/MarkAreaModel.ts (line 60). ECharts docs: https://echarts.apache.org/en/option.html#series-line.markArea

Examples

# One shaded band, defined by its two corner points.
MarkArea(
  data = list(list(
    MarkAreaDataPoint(x_axis = 1),
    MarkAreaDataPoint(x_axis = 3)
  ))
)

#> <rtemis.draw::MarkArea>
#>  @ data      :List of 1
#>  .. $ :List of 2
#>  ..  ..$ : <rtemis.draw::MarkAreaDataPoint>
#>  ..  .. ..@ x_axis    : num 1
#>  ..  .. ..@ y_axis    : NULL
#>  ..  .. ..@ name      : NULL
#>  ..  .. ..@ value     : NULL
#>  ..  .. ..@ item_style: NULL
#>  ..  .. ..@ label     : NULL
#>  ..  ..$ : <rtemis.draw::MarkAreaDataPoint>
#>  ..  .. ..@ x_axis    : num 3
#>  ..  .. ..@ y_axis    : NULL
#>  ..  .. ..@ name      : NULL
#>  ..  .. ..@ value     : NULL
#>  ..  .. ..@ item_style: NULL
#>  ..  .. ..@ label     : NULL
#>  @ silent    : NULL
#>  @ precision : NULL
#>  @ item_style: NULL
#>  @ label     : NULL
#>  @ z2        : NULL