IndexingTopics

Instance Properties

Methods

add(

name ​[, sortBy] ​[, withProperties])

→ Topic

Creates a new index topic.

name	string The name of the topic. Note: This is the text that appears in the index.
sortBy	string The string to sort this topic by instead of the topic name. Note: The actual topic text, rather than the sort order text, appears in the index. (Optional)
withProperties	Object Initial values for properties of the new Topic (Optional)

anyItem(

)

→ Topic

Returns any Topic in the collection.

count(

)

→ number

Displays the number of elements in the Topic.

everyItem(

)

→ Topic

Returns every Topic in the collection.

firstItem(

)

→ Topic

Returns the first Topic in the collection.

item(

index)

→ Topic

Returns the Topic with the specified index or name.

index

The index or name. Can accept: Long Integer or String.

itemByName(

name)

→ Topic

Returns the Topic with the specified name.

name	string The name.

itemByRange(

from, to)

→ Topic

Returns the Topics within the specified range.

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

lastItem(

)

→ Topic

Returns the last Topic in the collection.

middleItem(

)

→ Topic

Returns the middle Topic in the collection.

nextItem(

obj)

→ Topic

Returns the Topic whose index follows the specified Topic in the collection.

obj	Topic The Topic whose index comes before the desired Topic.

previousItem(

obj)

→ Topic

Returns the Topic with the index previous to the specified index.

obj	Topic The index of the Topic that follows the desired Topic.

toSource(

)

→ string

Generates a string which, if executed, will return the Topic.