ScenarioCollection
Contents
[
Hide
]ScenarioCollection class
Represents the list of scenarios.
class ScenarioCollection;
Methods
| Method | Description |
|---|---|
| get(number) | Gets the Scenario object by the index. |
| getActiveIndex() | Gets and sets which scenario is selected. |
| setActiveIndex(number) | Gets and sets which scenario is selected. |
| getLastSelected() | Indicates which scenario was last selected by the user to be run/shown. |
| setLastSelected(number) | Indicates which scenario was last selected by the user to be run/shown. |
| add(string) | Adds a scenario. |
| getCount() | Gets the number of elements contained in. |
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
getActiveIndex()
Gets and sets which scenario is selected.
getActiveIndex() : number;
setActiveIndex(number)
Gets and sets which scenario is selected.
setActiveIndex(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getLastSelected()
Indicates which scenario was last selected by the user to be run/shown.
getLastSelected() : number;
setLastSelected(number)
Indicates which scenario was last selected by the user to be run/shown.
setLastSelected(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
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.
getCount()
Gets the number of elements contained in.
getCount() : number;