K4 InDesign Javascript API Documentation

Interactive ElementsTimingGroups

A collection of timing data objects.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
dynamicTarget ​[, delaySeconds] ​[, withProperties])
  → TimingGroup
anyItem(
)
  → TimingGroup
count(
)
  → number
everyItem(
)
  → TimingGroup
firstItem(
)
  → TimingGroup
item(
index)
  → TimingGroup
itemByRange(
from, to)
  → TimingGroup
lastItem(
)
  → TimingGroup
middleItem(
)
  → TimingGroup
nextItem(
obj)
  → TimingGroup
previousItem(
obj)
  → TimingGroup
toSource(
)
  → string
add(
dynamicTarget ​[, delaySeconds=0] ​[, withProperties])
  → TimingGroup
Adds a new timing group.
dynamicTarget A page item target that is an animation, media, or mso. Can accept: PageItem, Graphic, Behavior or MediaItem.
delaySeconds number The time delay in seconds for a target. (Optional)
withProperties Object Initial values for properties of the new TimingGroup (Optional)
anyItem(
)
  → TimingGroup
Returns any TimingGroup in the collection.
count(
)
  → number
Displays the number of elements in the TimingGroup.
everyItem(
)
  → TimingGroup
Returns every TimingGroup in the collection.
firstItem(
)
  → TimingGroup
Returns the first TimingGroup in the collection.
item(
index)
  → TimingGroup
Returns the TimingGroup with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByRange(
from, to)
  → TimingGroup
Returns the TimingGroups within the specified range.
from The TimingGroup, index, or name at the beginning of the range. Can accept: TimingGroup, Long Integer or String.
to The TimingGroup, index, or name at the end of the range. Can accept: TimingGroup, Long Integer or String.
lastItem(
)
  → TimingGroup
Returns the last TimingGroup in the collection.
middleItem(
)
  → TimingGroup
Returns the middle TimingGroup in the collection.
nextItem(
obj)
  → TimingGroup
Returns the TimingGroup whose index follows the specified TimingGroup in the collection.
obj TimingGroup The TimingGroup whose index comes before the desired TimingGroup.
previousItem(
obj)
  → TimingGroup
Returns the TimingGroup with the index previous to the specified index.
obj TimingGroup The index of the TimingGroup that follows the desired TimingGroup.
toSource(
)
  → string
Generates a string which, if executed, will return the TimingGroup.