K4 InDesign Javascript API Documentation

Interactive ElementsTimingGroup

a timing group.

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
index number The index of the TimingGroup within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent TimingList The parent of the TimingGroup (a TimingList). read-only
placement number The placement of the timing group in the timing list. read-write
plays number The number of times this timing group plays. read-write
playsLoop bool Set to true if timing group loops. read-write
properties Object A property that allows setting of several properties at the same time. read-write
timingTargets TimingTargets A collection of timing target. read-only

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → TimingGroup
move(
to, reference)
  → TimingGroup
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
unlink(
)
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → TimingGroup
Resolves the object specifier, creating an array of object references.
move(
to, reference)
  → TimingGroup
Moves the timing group or target to the specified location.
to LocationOptions The location in relation to the reference object or within the containing object.
reference The reference object. Note: Required when the to parameter specifies before or after. . Can accept: TimingGroup, TimingTarget or TimingList. (Optional)
remove(
)
Deletes the TimingGroup.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the TimingGroup.
toSpecifier(
)
  → string
Retrieves the object specifier.
unlink(
)
Unlink all targets in the group into separate groups in this timing list.