K4 InDesign Javascript API Documentation

PreferencesAnimationSetting

Animation settings.

Extends

Instance Properties

Name Description Access
designOption DesignOptions The animation design option. read-write
duration number The duration in second for this animation. read-write
easeType AnimationEaseOptions The ease type. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
hasCustomSettings bool Determines if this animated object has custom settings. read-only
hiddenAfter bool Determines if this object is hidden after its animation is played in an exported SWF file. read-write
initiallyHidden bool Determines if this object is initially hidden when displayed in an exported SWF file. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
motionPath The list of motion path points and key frames for this animation. Can return: Ordered array containing keyFrame:Long Integer, pathPoint:Ordered array containing anchor:Array of 2 Reals, leftDirection:Array of 2 Reals, rightDirection:Array of 2 Reals. read-write
motionPathPoints The list of motion path points for this animation. Can return: Ordered array containing pathPointArray:Array of Ordered array containing anchor:Array of 2 Reals, leftDirection:Array of 2 Reals, rightDirection:Array of 2 Reals, pathOpen:Boolean. read-write
opacityArray The list of opacity key frames for this animation. Can return: Ordered array containing keyFrame:Long Integer, value:Real. read-write
parent The parent of the AnimationSetting (a PageItem, HtmlItem, FormField, SignatureField, TextBox, RadioButton, ListBox, ComboBox, CheckBox, MultiStateObject, Button, MediaItem, Sound, Movie, EPSText, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Graphic, ImportedPage, PICT, WMF, PDF, EPS, Image, Group, TextFrame or EndnoteTextFrame). read-only
plays number The number of times this animation plays. read-write
playsLoop bool Set to true if animation play loops. read-write
preset The base animation preset applied. Can return: MotionPreset, String or NothingEnum enumerator. read-write
properties Object A property that allows setting of several properties at the same time. read-write
rotationArray The list of rotation key frames for this animation. Can return: Ordered array containing keyFrame:Long Integer, value:Real. read-write
scaleXArray The list of scale x key frames for this animation. Can return: Ordered array containing keyFrame:Long Integer, value:Real. read-write
scaleYArray The list of scale y key frames for this animation. Can return: Ordered array containing keyFrame:Long Integer, value:Real. read-write
transformOffsets number The tranform offset percentage from the target object bounding box's left-top corner. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → AnimationSetting
removeEventListener(
eventType, handler ​[, captures])
  → bool
save(
name)
  → MotionPreset
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)
getElements(
)
  → AnimationSetting
Resolves the object specifier, creating an array of object references.
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)
save(
name)
  → MotionPreset
Save this motion preset as custom preset.
name string The name for the new motion preset.
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 AnimationSetting.
toSpecifier(
)
  → string
Retrieves the object specifier.