An index.
Go to Property Listing | Method Listing
addEventListener, capitalize, extractLabel, generate, getElements, importTopics, insertLabel, removeEventListener, removeUnusedTopics, toSource, toSpecifier, update
Boolean, EventListeners, Events, IndexSections, Number, Object, String, Topic, Topics
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
The topics in the specified index section. |
||
|
readonly |
A collection of event listeners. |
||
|
readonly |
A collection of events. |
||
|
readonly |
The unique ID of the Index. |
||
|
readonly |
The index of the Index within its containing object. |
||
|
readonly |
A collection of index sections. |
||
|
readonly |
Returns true if the object specifier resolves to valid objects. |
||
|
read/write |
A property that can be set to any string. |
||
|
read/write |
The name of the Index; this is an alias to the Index's label property. |
||
|
readonly |
The parent of the Index (a Document). |
||
|
read/write |
A property that allows setting of several properties at the same time. |
||
|
readonly |
A collection of index topics. |
EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Adds an event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The event type. |
|
|
handler |
JavaScriptFunction |
The event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
undefined capitalize ([capitalizationOption:IndexCapitalizationOptions=IndexCapitalizationOptions])
Makes the initial letter for the specified index topic or group of index topics upper case.
|
Parameter |
Type |
Description |
|---|---|---|
|
capitalizationOption |
The entry or entries to capitalize. (Optional) (default: IndexCapitalizationOptions.ALL_ENTRIES) |
String extractLabel (key:String)
Gets the label value associated with the specified key.
|
Parameter |
Type |
Description |
|---|---|---|
|
key |
The key. |
Story generate (on:Varies Page Spread MasterSpread, placePoint:Array of Number String, destinationLayer:Layer, [autoflowing:Boolean=Boolean], [includeOverset:Boolean=Boolean])
Generates a new index story.
|
Parameter |
Type |
Description |
|---|---|---|
|
on |
The spread or page on which to place the story. Can accept: Page, Spread or MasterSpread. (Optional) |
|
|
placePoint |
The coordinates of the upper left corner of the story bounding box, in the format [x, y]. (Optional) |
|
|
destinationLayer |
The layer on which to place the story. (Optional) |
|
|
autoflowing |
If true, allows the story to flow onto subsequent pages if the story does not fit on the specified page. If no subsequent pages exist in the document, creates the necessary pages. (Optional) (default: false) |
|
|
includeOverset |
If true, includes topics in overset text in the story. (Optional) (default: false) |
Index getElements ()
Resolves the object specifier, creating an array of object references.
undefined importTopics (from:File)
Imports a list of index topics.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
The file from which to import the topics. |
undefined insertLabel (key:String, value:String)
Sets the label to the value associated with the specified key.
Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Removes the event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The registered event type. |
|
|
handler |
JavaScriptFunction |
The registered event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
undefined removeUnusedTopics ()
Removes all index topics that do not have any index entries.
String toSource ()
Generates a string which, if executed, will return the Index.
String toSpecifier ()
Retrieves the object specifier.
undefined update ()
Updates the index preview pane. Note: Does not update the index.