Sankey Edge Item

One directed link (edge) in a Sankey diagram.

Usage

SankeyEdgeItem(
  source = NULL,
  target = NULL,
  value = NULL,
  line_style = NULL,
  edge_label = NULL,
  focus_node_adjacency = NULL
)

Arguments

source

Optional Character: Source node name.

target

Optional Character: Target node name.

value

Optional Numeric: Flow value (determines link width).

line_style

Optional LineStyle or list: Link line styling. Accepts a LineStyle object or a plain named list; a list also allows the Sankey-specific curveness field (e.g. list(curveness = 0.5, opacity = 0.3)).

edge_label

Optional LabelOption: Label shown on the link itself.

focus_node_adjacency

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

Value

SankeyEdgeItem object.

Details

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

Examples

SankeyEdgeItem(source = "A", target = "B", value = 5)

#> <rtemis.draw::SankeyEdgeItem>
#>  @ source              : chr "A"
#>  @ target              : chr "B"
#>  @ value               : num 5
#>  @ line_style          : NULL
#>  @ edge_label          : NULL
#>  @ focus_node_adjacency: NULL