InDesign Server2025
InDesign2026 InDesign Server2025 Illustrator29 PhotoshopCC 2015.5 Bridge2021 Core JavaScriptExtendScript only ScriptUIExtendScript only
API 20.5.0.49
Object

AnimationSetting

Animation settings.

Preference ›AnimationSetting
Hierarchy

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

AnimationSetting

Properties

NameType AccessDescription
DesignOptions
 read/write The animation design option.
Number 0.125–60 read/write The duration in second for this animation.
AnimationEaseOptions
 read/write The ease type.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Boolean readonly Determines if this animated object has custom settings.
Boolean read/write Determines if this object is hidden after its animation is played in an exported SWF file.
Boolean read/write Determines if this object is initially hidden when displayed in an exported SWF file.
Boolean readonly Returns true if the object specifier resolves to valid objects.
Array[] | 2 Reals[] | Array[] | 2 Reals[] read/write 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.
Array[] | 2 Reals[] | Boolean[] | 2 Reals[] read/write 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.
Array[] | Real[] read/write The list of opacity key frames for this animation. Can return: Ordered array containing keyFrame:Long Integer, value:Real.
Button | CheckBox | ComboBox | EPS | EPSText | FormField | Graphic | GraphicLine | Group | HtmlItem | Image | ImportedPage | ListBox | MediaItem | Movie | MultiStateObject | Oval | PDF | PICT | Polygon | RadioButton | Rectangle | SVG | SignatureField | Sound | SplineItem | TextBox | TextFrame | WMF | EndnoteTextFrame | PageItem readonly 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, SVG, ImportedPage, PICT, WMF, PDF, EPS, Image, Group, TextFrame or EndnoteTextFrame).
Number 1–100 read/write The number of times this animation plays.
Boolean read/write Set to true if animation play loops.
MotionPreset | String | NothingEnum
 read/write The base animation preset applied. Can return: MotionPreset, String or NothingEnum enumerator.
Object read/write A property that allows setting of several properties at the same time.
Array[] | Real[] read/write The list of rotation key frames for this animation. Can return: Ordered array containing keyFrame:Long Integer, value:Real.
Array[] | Real[] read/write The list of scale x key frames for this animation. Can return: Ordered array containing keyFrame:Long Integer, value:Real.
Array[] | Real[] read/write The list of scale y key frames for this animation. Can return: Ordered array containing keyFrame:Long Integer, value:Real.
Number[] read/write The tranform offset percentage from the target object bounding box's left-top corner.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ AnimationSetting[]

Resolves the object specifier, creating an array of object references.

→ Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ MotionPreset

Save this motion preset as custom preset.

name String The name for the new motion preset.
→ void

Save a copy of this motion preset to a InDesign motion preset file.

to File The Flash motion preset file to export to.
→ String

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

→ String

Retrieves the object specifier.

Object of 34

Properties elsewhere that hold a AnimationSetting.

Button.animationSettingsCheckBox.animationSettingsComboBox.animationSettingsEPS.animationSettingsEPSText.animationSettingsEndnoteTextFrame.animationSettingsEvent.parentEventListener.parentFormField.animationSettingsGraphic.animationSettingsGraphicLine.animationSettingsGroup.animationSettingsHtmlItem.animationSettingsImage.animationSettingsImportedPage.animationSettingsListBox.animationSettingsMediaItem.animationSettingsMovie.animationSettingsMultiStateObject.animationSettingsMutationEvent.parentOval.animationSettingsPDF.animationSettingsPICT.animationSettingsPageItem.animationSettingsPolygon.animationSettingsRadioButton.animationSettingsRectangle.animationSettingsSVG.animationSettingsSignatureField.animationSettingsSound.animationSettingsSplineItem.animationSettingsTextBox.animationSettingsTextFrame.animationSettingsWMF.animationSettings

Return 1

Methods that return a AnimationSetting.

AnimationSetting.getElements()