ScenarioCollection

ScenarioCollection class

Represents the list of scenarios.

class ScenarioCollection;

Properties

PropertyTypeDescription
activeIndexnumberGets and sets which scenario is selected.
lastSelectednumberIndicates which scenario was last selected by the user to be run/shown.

Methods

MethodDescription
get(number)Gets the Scenario object by the index.
add(string)Adds a scenario.

activeIndex

Gets and sets which scenario is selected.

activeIndex : number;

lastSelected

Indicates which scenario was last selected by the user to be run/shown.

lastSelected : number;

get(number)

Gets the Scenario object by the index.

get(index: number) : Scenario;

Parameters:

ParameterTypeDescription
indexnumberThe specific index in the list.

Returns

Scenario

add(string)

Adds a scenario.

add(name: string) : number;

Parameters:

ParameterTypeDescription
namestringThe name of scenario.

Returns

The index in the list of scenarios.