NavigationPoint
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| eventListeners | EventListeners EventListener | readonly | A collection of event listeners. |
| events | Events Event | readonly | A collection of events. |
| id | number | readonly | Unique internally-generated identifier (read only). |
| index | number | readonly | The index of the NavigationPoint within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| name | string | r/w | The UI display name. |
| parent | Movie | readonly | The parent of the NavigationPoint (a Movie). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| time | number | r/w | The time in seconds rounded up to two decimal places (e.g., 3.115 rounded to 3.12). |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
Array
of NavigationPoint getElements ()
Resolves the object specifier, creating an array of object references.
void remove ()
Deletes the NavigationPoint.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the NavigationPoint.
Used in:
NavigationPoint NavigationPoints.nextItem (obj: NavigationPoint)
NavigationPoint NavigationPoints.previousItem (obj: NavigationPoint)
Return
Array of NavigationPoint NavigationPoint.getElements ()
NavigationPoint NavigationPoints.[] (index: number)
NavigationPoint NavigationPoints.add ([withProperties: Object])
NavigationPoint NavigationPoints.anyItem ()
Array of NavigationPoint NavigationPoints.everyItem ()
NavigationPoint NavigationPoints.firstItem ()
NavigationPoint NavigationPoints.item (index: varies)
NavigationPoint NavigationPoints.itemByID (id: number)
NavigationPoint NavigationPoints.itemByName (name: string)
Array of NavigationPoint NavigationPoints.itemByRange (from: varies, to: varies)
NavigationPoint NavigationPoints.lastItem ()
NavigationPoint NavigationPoints.middleItem ()
NavigationPoint NavigationPoints.nextItem (obj: NavigationPoint)
NavigationPoint NavigationPoints.previousItem (obj: NavigationPoint)
| Jongware, 29-Apr-2012 v3.0.3i | Contents :: Index |