IndexingIndexes

A collection of indexes.

Instance Properties

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

Methods

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