Indexes

Indexes

A collection of indexes.

Index add ([withProperties: Object])
Creates a new Index.

Parameter	Type	Description
withProperties	Object	Initial values for properties of the new Index (Optional)

Index anyItem ()
Returns any Index in the collection.

number count ()
Displays the number of elements in the Index.

Array of Index everyItem ()
Returns every Index in the collection.

Index firstItem ()
Returns the first Index in the collection.

Index item (index: any)
Returns the Index with the specified index or name.

Parameter	Type	Description
index	Long Integer String	The index or name. Can accept: Long Integer or String.

Index itemByID (id: number)
Returns the Index with the specified ID.

Parameter	Type	Description
id	number	The ID.

Index itemByName (name: string)
Returns the Index with the specified name.

Parameter	Type	Description
name	string	The name.

Array of Index itemByRange (from: any, to: any)
Returns the Indexes within the specified range.

Parameter	Type	Description
from	Index Long Integer String	The Index, index, or name at the beginning of the range. Can accept: Index, Long Integer or String.
to	Index Long Integer String	The Index, index, or name at the end of the range. Can accept: Index, Long Integer or String.

Index lastItem ()
Returns the last Index in the collection.

Index middleItem ()
Returns the middle Index in the collection.

Index nextItem (obj: Index)
Returns the Index whose index follows the specified Index in the collection.

Parameter	Type	Description
obj	Index	The Index whose index comes before the desired Index.

Index previousItem (obj: Index)
Returns the Index with the index previous to the specified index.

Parameter	Type	Description
obj	Index	The index of the Index that follows the desired Index.

string toSource ()
Generates a string which, if executed, will return the Index.

Document.indexes