ScenarioCollection

ScenarioCollection class

Represents the list of scenarios.

Methods

NameDescription
add(name)Adds a scenario.
add()Reserved for internal use.
clear()
contains()Reserved for internal use.
get(index)Gets the Scenario object by the index.
get()Reserved for internal use.
getActiveIndex()Gets and sets which scenario is selected.
getCount()
getLastSelected()Indicates which scenario was last selected by the user to be run/shown.
indexOf()Reserved for internal use.
iterator()
removeAt()
setActiveIndex()Gets and sets which scenario is selected.
setLastSelected()Indicates which scenario was last selected by the user to be run/shown.

add(name)

Adds a scenario.

ParameterTypeDescription
nameStringThe name of scenario.

Returns: Number — Number The index in the list of scenarios.

add()

Reserved for internal use.

clear()

contains()

Reserved for internal use.

get(index)

Gets the Scenario object by the index.

ParameterTypeDescription
indexNumberThe specific index in the list.

Returns: Scenario — Scenario

get()

Reserved for internal use.

getActiveIndex()

Gets and sets which scenario is selected.

getCount()

getLastSelected()

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

indexOf()

Reserved for internal use.

iterator()

removeAt()

setActiveIndex()

Gets and sets which scenario is selected.

setLastSelected()

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