ScenarioCollection
Contents
[
Hide
]ScenarioCollection class
Represents the list of scenarios.
class ScenarioCollection;
Properties
| Property | Type | Description |
|---|---|---|
| activeIndex | number | Gets and sets which scenario is selected. |
| lastSelected | number | Indicates which scenario was last selected by the user to be run/shown. |
Methods
| Method | Description |
|---|---|
| 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:
| Parameter | Type | Description |
|---|---|---|
| index | number | The specific index in the list. |
Returns
add(string)
Adds a scenario.
add(name: string) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| name | string | The name of scenario. |
Returns
The index in the list of scenarios.