Skip to contents

Sankey Level Option

Source: R/series_sankey.R
SankeyLevelOption.Rd

Style overrides applied to all nodes at a given column depth. depth = 0 targets the leftmost column.

Usage

SankeyLevelOption(
  depth = integer(0),
  label = NULL,
  item_style = NULL,
  line_style = NULL
)

Arguments

depth

Numeric [0, Inf): Column depth to target (0 = leftmost). Required.

label

Optional LabelOption: Node label configuration at this depth.

item_style

Optional ItemStyle: Node fill/border styling at this depth.

line_style

Optional LineStyle or list: Link styling for edges leaving this depth. Accepts a LineStyle object or a plain list (allows curveness).

Value

SankeyLevelOption object.

Details

Corresponds to SankeyLevelOption in src/chart/sankey/SankeySeries.ts (line 96). ECharts docs: https://echarts.apache.org/en/option.html#series-sankey.levels

Examples

SankeyLevelOption(depth = 0L, item_style = ItemStyle(color = "#16a085"))
#> <rtemis.draw::SankeyLevelOption>
#>  @ depth     : int 0
#>  @ label     : NULL
#>  @ item_style: <rtemis.draw::ItemStyle>
#>  .. @ color             : chr "#16a085"
#>  .. @ opacity           : NULL
#>  .. @ border_color      : NULL
#>  .. @ border_width      : NULL
#>  .. @ border_type       : NULL
#>  .. @ border_cap        : NULL
#>  .. @ border_join       : NULL
#>  .. @ border_dash_offset: NULL
#>  .. @ border_miter_limit: NULL
#>  .. @ border_radius     : NULL
#>  .. @ decal             : NULL
#>  .. @ shadow_blur       : NULL
#>  .. @ shadow_color      : NULL
#>  .. @ shadow_offset_x   : NULL
#>  .. @ shadow_offset_y   : NULL
#>  @ line_style: NULL