Adobe InDesign CS6 (8.0) Object Model JS: AnimationSetting

InDesign CS6

Class

AnimationSetting

 Animation settings. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, save, saveACopy, toSource, toSpecifier

Hierarchy

Button | CheckBox | ComboBox | EPS | EPSText | FormField | Graphic | GraphicLine | Group | HtmlItem | Image | ImportedPage | ListBox | MediaItem | Movie | MultiStateObject | Oval | PageItem | PDF | PICT | Polygon | RadioButton | Rectangle | SignatureField | Sound | SplineItem | TextBox | TextFrame | WMF
Preference
AnimationSetting
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
designOptionDesignOptions:
DesignOptions.FROM_CURRENT_APPEARANCE
DesignOptions.TO_CURRENT_APPEARANCE
DesignOptions.TO_CURRENT_LOCATION
r/wThe animation design option.
durationnumber (range: 0.125 - 60) r/wThe duration in second for this animation.
easeTypeAnimationEaseOptions:
AnimationEaseOptions.NO_EASE
AnimationEaseOptions.EASE_IN
AnimationEaseOptions.EASE_OUT
AnimationEaseOptions.EASE_IN_OUT
AnimationEaseOptions.CUSTOM_EASE
r/wThe ease type.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
hasCustomSettingsbool readonlyDetermines if this animated object has custom settings.
hiddenAfterbool r/wDetermines if this object is hidden after its animation is played in an exported SWF file.
initiallyHiddenbool r/wDetermines if this object is initially hidden when displayed in an exported SWF file.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
motionPathArray of
Array of 2 Reals
Ordered array containing keyFrame:Long Integer
Array of 2 Reals
Array of 2 Reals
r/wThe 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.
motionPathPointsArray of 2 Reals
Array of Array of 2 Reals
pathOpen:Boolean
Array of 2 Reals
r/wThe 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.
opacityArrayArray of
Ordered array containing keyFrame:Long Integer
value:Real
r/wThe list of opacity key frames for this animation. Can return: Ordered array containing keyFrame:Long Integer, value:Real.
parentButton
CheckBox
ComboBox
EPS
EPSText
FormField
Graphic
GraphicLine
Group
HtmlItem
Image
ImportedPage
ListBox
MediaItem
Movie
MultiStateObject
Oval
PageItem
PDF
PICT
Polygon
RadioButton
Rectangle
SignatureField
Sound
SplineItem
TextBox
TextFrame
WMF
readonlyThe 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 or TextFrame).
playsnumber (range: 1 - 100) r/wThe number of times this animation plays.
playsLoopbool r/wSet to true if animation play loops.
presetMotionPreset
NothingEnum
String
r/wThe base animation preset applied. Can return: MotionPreset, String or NothingEnum enumerator.
propertiesObject r/wA property that allows setting of several properties at the same time.
rotationArrayArray of
Ordered array containing keyFrame:Long Integer
value:Real
r/wThe list of rotation key frames for this animation. Can return: Ordered array containing keyFrame:Long Integer, value:Real.
scaleXArrayArray of
Ordered array containing keyFrame:Long Integer
value:Real
r/wThe list of scale x key frames for this animation. Can return: Ordered array containing keyFrame:Long Integer, value:Real.
scaleYArrayArray of
Ordered array containing keyFrame:Long Integer
value:Real
r/wThe list of scale y key frames for this animation. Can return: Ordered array containing keyFrame:Long Integer, value:Real.
transformOffsetsArray of number r/wThe tranform offset percentage from the target object bounding box's left-top corner.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Array of AnimationSetting getElements ()
Resolves the object specifier, creating an array of object references.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

MotionPreset save (name: string)
Save this motion preset as custom preset.

ParameterTypeDescription
namestringThe name for the new motion preset.

void saveACopy (to: File)
Save a copy of this motion preset to a InDesign motion preset file.

ParameterTypeDescription
toFileThe Flash motion preset file to export to.

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Button.animationSettings

CheckBox.animationSettings

ComboBox.animationSettings

EPS.animationSettings

EPSText.animationSettings

FormField.animationSettings

Graphic.animationSettings

GraphicLine.animationSettings

Group.animationSettings

HtmlItem.animationSettings

Image.animationSettings

ImportedPage.animationSettings

ListBox.animationSettings

MediaItem.animationSettings

Movie.animationSettings

MultiStateObject.animationSettings

Oval.animationSettings

PDF.animationSettings

PICT.animationSettings

PageItem.animationSettings

Polygon.animationSettings

RadioButton.animationSettings

Rectangle.animationSettings

SignatureField.animationSettings

Sound.animationSettings

SplineItem.animationSettings

TextBox.animationSettings

TextFrame.animationSettings

WMF.animationSettings

Return

Array of AnimationSetting AnimationSetting.getElements ()

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