K4 InDesign Javascript API Documentation

LayoutMotionPreset

A Motion preset Object.

Instance Properties

Name Description Access
contents string Motion preset raw data read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
id number The unique ID of the MotionPreset. read-only
index number The index of the MotionPreset within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
name string The name of the MotionPreset. read-write
parent The parent of the MotionPreset (a Application or Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
duplicate(
[name])
  → MotionPreset
extractLabel(
key)
  → string
getElements(
)
  → MotionPreset
insertLabel(
key, value)
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
saveACopy(
to)
toSource(
)
  → string
toSpecifier(
)
  → string
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)
duplicate(
[name])
  → MotionPreset
Duplicates the motion preset.
name string The name for the duplicated motion preset. (Optional)
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → MotionPreset
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
remove(
)
Deletes the MotionPreset.
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)
saveACopy(
to)
Save a copy of this motion preset to a InDesign motion preset file.
to File The Flash motion preset file to export to.
toSource(
)
  → string
Generates a string which, if executed, will return the MotionPreset.
toSpecifier(
)
  → string
Retrieves the object specifier.