SankeyGraph

A data structure that contains elements for a Sankey diagram.

Properties

rootIndex

The index of the node that represents the quantitative reference of the graph. In order to create and layout a Sankey diagram, an LCA system is typically traversed in breadth-first order. When back-links of cycles in this traversal order are ignored, the (sub-) graph created by this traversal is a directed acyclic graph (DAG) with this root.

• Type: int (external doc)
• Proto-Index: 1

nodes

The nodes of the graph.

• Type: List of SankeyNode
• Proto-Index: 2

edges

The edges of the graph.

• Type: List of SankeyEdge
• Proto-Index: 3

Python class stub

The snippet below shows the names of the properties of the corresponding Python class of the olca-schema package. Note that this is not the full class definition but just shows the names of the class and its properties.

@dataclass
class SankeyGraph:
  edges: List[SankeyEdge]
  nodes: List[SankeyNode]
  root_index: int