Topics

Topics

A collection of index topics.

Topic add (name: string[, sortBy: string][, withProperties: Object])
Creates a new index topic.

Parameter	Type	Description
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)

Topic anyItem ()
Returns any Topic in the collection.

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

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

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

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

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

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

Parameter	Type	Description
name	string	The name.

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

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

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

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

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

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

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

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

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

Index.topics
IndexSection.topics
Topic.topics