TextNamedGrids

A collection of named grids.

Instance Properties

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

Methods

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