Scenario Output

ScenarioOutput — a value exposed in scenario comparison views.

class ScenarioOutput(name, scenario_output_value, scenario_output_table=None)[source]

A named value or field surfaced as a scenario-comparison output.

Construct via ModelConfiguration.add_scenario_output(). Pass a Calculation/Parameter for model-level outputs, or a Field plus its Table for per-row outputs.

property name: str

Display name for this scenario output.

property cell_reference: str

Resolved cell reference (!!!<id> form) used in serialisation.

build()[source]

Serialise to a JSON-compatible dict.

Return type:

dict[str, Any]