Interactive ElementsStates

A collection of states.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
[withProperties])
 → State
anyItem(
)
 → State
count(
)
 → number
everyItem(
)
 → State
firstItem(
)
 → State
item(
index)
 → State
itemByID(
id)
 → State
itemByName(
name)
 → State
itemByRange(
from, to)
 → State
lastItem(
)
 → State
middleItem(
)
 → State
nextItem(
obj)
 → State
previousItem(
obj)
 → State
toSource(
)
 → string
add(
[withProperties])
 → State
Creates a new State.
withProperties Object Initial values for properties of the new State (Optional)
anyItem(
)
 → State
Returns any State in the collection.
count(
)
 → number
Displays the number of elements in the State.
everyItem(
)
 → State
Returns every State in the collection.
firstItem(
)
 → State
Returns the first State in the collection.
item(
index)
 → State
Returns the State with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
 → State
Returns the State with the specified ID.
id number The ID.
itemByName(
name)
 → State
Returns the State with the specified name.
name string The name.
itemByRange(
from, to)
 → State
Returns the States within the specified range.
from The State, index, or name at the beginning of the range. Can accept: State, Long Integer or String.
to The State, index, or name at the end of the range. Can accept: State, Long Integer or String.
lastItem(
)
 → State
Returns the last State in the collection.
middleItem(
)
 → State
Returns the middle State in the collection.
nextItem(
obj)
 → State
Returns the State whose index follows the specified State in the collection.
obj State The State whose index comes before the desired State.
previousItem(
obj)
 → State
Returns the State with the index previous to the specified index.
obj State The index of the State that follows the desired State.
toSource(
)
 → string
Generates a string which, if executed, will return the State.