Adobe InDesign CS6 Server (8.0) Object Model JS: TimingGroups

InDesign Server CS6

Class

TimingGroups

 A collection of timing data objects.

See also TimingGroup.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

TimingGroup [] (index: number)
Returns the TimingGroup with the specified index.

ParameterTypeDescription
indexnumberThe index.

TimingGroup add (dynamicTarget: varies[, delaySeconds: number=0][, withProperties: Object])
Adds a new timing group.

ParameterTypeDescription
dynamicTargetBehavior
Graphic
MediaItem
PageItem
A page item target that is an animation, media, or mso. Can accept: PageItem, Graphic, Behavior or MediaItem.
delaySecondsnumberThe time delay in seconds for a target. (Optional) (default: 0)
withPropertiesObjectInitial values for properties of the new TimingGroup (Optional)

TimingGroup anyItem ()
Returns any TimingGroup in the collection.

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

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

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

TimingGroup item (index: varies)
Returns the TimingGroup with the specified index or name.

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

Array of TimingGroup itemByRange (from: varies, to: varies)
Returns the TimingGroups within the specified range.

ParameterTypeDescription
fromLong Integer
String
TimingGroup
The TimingGroup, index, or name at the beginning of the range. Can accept: TimingGroup, Long Integer or String.
toLong Integer
String
TimingGroup
The TimingGroup, index, or name at the end of the range. Can accept: TimingGroup, Long Integer or String.

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

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

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

ParameterTypeDescription
objTimingGroupThe TimingGroup whose index comes before the desired TimingGroup.

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

ParameterTypeDescription
objTimingGroupThe index of the TimingGroup that follows the desired TimingGroup.

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

Element of

TimingList.timingGroups

Jongware, 28-Apr-2012 v3.0.3iContents :: Index