Sankey Node Item

One node in a Sankey diagram. Node names must match the source / target strings used in the corresponding SankeyEdgeItem objects.

Usage

SankeyNodeItem(
  name = NULL,
  value = NULL,
  depth = NULL,
  draggable = NULL,
  local_x = NULL,
  local_y = NULL,
  label = NULL,
  item_style = NULL,
  focus_node_adjacency = NULL
)

Arguments

name

Optional Character: Node name (must match source/target strings).

value

Optional Numeric: Node value shown in tooltip.

depth

Optional Numeric [0, Inf): Fixed column depth (0 = leftmost).

draggable

Optional Logical: Whether the node can be dragged.

local_x

Optional Numeric: Horizontal position inside the layout rect.

local_y

Optional Numeric: Vertical position inside the layout rect.

label

Optional LabelOption: Node label configuration.

item_style

Optional ItemStyle: Node fill/border styling.

focus_node_adjacency

Optional Logical or Character {"inEdges", "outEdges", "allEdges"}: Which adjacent elements to highlight on hover.

Value

SankeyNodeItem object.

Details

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

Examples

SankeyNodeItem(name = "Source A", value = 10)

#> <rtemis.draw::SankeyNodeItem>
#>  @ name                : chr "Source A"
#>  @ value               : num 10
#>  @ depth               : NULL
#>  @ draggable           : NULL
#>  @ local_x             : NULL
#>  @ local_y             : NULL
#>  @ label               : NULL
#>  @ item_style          : NULL
#>  @ focus_node_adjacency: NULL