SankeyRequest

A configuration request for calculating a [SankeyGraph] for a result.

Properties

`impactCategory`

The reference to the impact category if a graph based on the results of that impact category should be returned.

Type: optional Ref of ImpactCategory
Proto-Index: 1

`enviFlow`

The reference to the intervention flow if a graph based on the results of that flow should be returned.

Type: optional EnviFlow
Proto-Index: 2

`forCosts`

If set to true, the returned graph will be based on the life cycle costing results of the system.

Type: optional boolean (external doc)
Proto-Index: 3

`minShare`

A cut-off rule based on the minimum result share of a node, that is the total result of that node (including direct and upstream contributions) divided by the total result of the system.

Type: optional double (external doc)
Proto-Index: 4

`maxNodes`

The maximum number of nodes that should be contained in the returned graph.

Type: optional int (external doc)
Proto-Index: 5

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 SankeyRequest:
  envi_flow: EnviFlow
  for_costs: bool
  impact_category: Ref
  max_nodes: int
  min_share: float

openLCA schema