TimingGroup
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| index | number | readonly | The index of the TimingGroup within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| parent | TimingList | readonly | The parent of the TimingGroup (a TimingList). |
| placement | number | r/w | The placement of the timing group in the timing list. |
| plays | number (range: 1 - 100) | r/w | The number of times this timing group plays. |
| playsLoop | bool | r/w | Set to true if timing group loops. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| timingTargets | TimingTargets | readonly | A collection of timing target. |
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 TimingGroup getElements ()
Resolves the object specifier, creating an array of object references.
TimingGroup move (to:
LocationOptions[, reference:
varies])
Moves the timing group or target to the specified location.
| Parameter | Type | Description |
|---|---|---|
| to | LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING LocationOptions.UNKNOWN | The location in relation to the reference object or within the containing object. |
| reference | TimingGroup TimingList TimingTarget | The reference object. Note: Required when the to parameter specifies before or after. . Can accept: TimingGroup, TimingTarget or TimingList. (Optional) |
void remove ()
Deletes the TimingGroup.
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 TimingGroup.
string toSpecifier ()
Retrieves the object specifier.
void unlink ()
Unlink all targets in the group into separate groups in this timing list.
Element of
TimingTarget.parent
Used in:
TimingGroup TimingGroups.nextItem (obj: TimingGroup)
TimingGroup TimingGroups.previousItem (obj: TimingGroup)
Return
Array of TimingGroup TimingGroup.getElements ()
TimingGroup TimingGroup.move (to: LocationOptions[, reference: varies])
TimingGroup TimingGroups.[] (index: number)
TimingGroup TimingGroups.add (dynamicTarget: varies[, delaySeconds: number=0][, withProperties: Object])
TimingGroup TimingGroups.anyItem ()
Array of TimingGroup TimingGroups.everyItem ()
TimingGroup TimingGroups.firstItem ()
TimingGroup TimingGroups.item (index: varies)
Array of TimingGroup TimingGroups.itemByRange (from: varies, to: varies)
TimingGroup TimingGroups.lastItem ()
TimingGroup TimingGroups.middleItem ()
TimingGroup TimingGroups.nextItem (obj: TimingGroup)
TimingGroup TimingGroups.previousItem (obj: TimingGroup)
| Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |