ScenarioCollection
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. |
| getActiveIndex() | @deprecated. Please use the ‘activeIndex’ property instead. Gets and sets which scenario is selected. |
| setActiveIndex(number) | @deprecated. Please use the ‘activeIndex’ property instead. Gets and sets which scenario is selected. |
| getLastSelected() | @deprecated. Please use the ’lastSelected’ property instead. Indicates which scenario was last selected by the user to be run/shown. |
| setLastSelected(number) | @deprecated. Please use the ’lastSelected’ property instead. Indicates which scenario was last selected by the user to be run/shown. |
| add(string) | Adds a scenario. |
| getCount() | @deprecated. Please use the ‘count’ property instead. Gets the number of elements contained in. |
| isNull() | Checks whether the implementation object is null. |
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
getActiveIndex()
@deprecated. Please use the ‘activeIndex’ property instead. Gets and sets which scenario is selected.
getActiveIndex() : number;
setActiveIndex(number)
@deprecated. Please use the ‘activeIndex’ property instead. Gets and sets which scenario is selected.
setActiveIndex(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getLastSelected()
@deprecated. Please use the ’lastSelected’ property instead. Indicates which scenario was last selected by the user to be run/shown.
getLastSelected() : number;
setLastSelected(number)
@deprecated. Please use the ’lastSelected’ property instead. 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()
@deprecated. Please use the ‘count’ property instead. Gets the number of elements contained in.
getCount() : number;
isNull()
Checks whether the implementation object is null.
isNull() : boolean;