K4 InDesign Javascript API Documentation

PreferencesAnchoredObjectSetting

The settings for an anchored object.

Extends

Instance Properties

Name Description Access
anchorPoint AnchorPoint The point in the anchored object to position. read-write
anchorSpaceAbove Measurement Unit (Number or String)=any The space above an above-line anchored object. read-write
anchorXoffset Measurement Unit (Number or String)=any The horizontal (x) offset of the anchored object. read-write
anchorYoffset Measurement Unit (Number or String)=any The vertical (y) offset of the anchored object. Corresponds to the space after property for above line positioning. read-write
anchoredPosition AnchorPosition The position of the anchored object relative to the anchor. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
horizontalAlignment HorizontalAlignment When anchored position is above line, the position of the anchored object is relative to the text area. When anchored position is custom, the horizontal alignment of the anchored object is set by the horizontal reference point. Note: Not valid when anchored position is inline. read-write
horizontalReferencePoint AnchoredRelativeTo The horizontal reference point on the page. Valid only when anchored position is custom. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
lockPosition bool If true, prevents manual positioning of the anchored object. read-write
parent The parent of the AnchoredObjectSetting (a Application, Document, EPSText, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, TextFrame, EndnoteTextFrame, Button, FormField, SignatureField, TextBox, RadioButton, ListBox, ComboBox, CheckBox, MultiStateObject or ObjectStyle). read-only
pinPosition bool If true, pins the position of the anchored object within the text frame top and bottom. read-write
properties Object A property that allows setting of several properties at the same time. read-write
spineRelative bool If true, the position of the anchored object is relative to the binding spine of the page or spread. read-write
verticalAlignment VerticalAlignment The vertical alignment of the anchored object reference point with the vertical reference point on the page. Notes: Valid only when anchored position is custom. read-write
verticalReferencePoint VerticallyRelativeTo The vertical reference point on the page. Valid when anchored position is custom. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → AnchoredObjectSetting
insertAnchoredObject(
storyOffset ​[, anchoredPosition])
releaseAnchoredObject(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
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(
)
  → AnchoredObjectSetting
Resolves the object specifier, creating an array of object references.
insertAnchoredObject(
storyOffset ​[, anchoredPosition])
Inserts the anchored object into specified story.
storyOffset InsertionPoint The location within the story, specified as an insertion point.
anchoredPosition AnchorPosition The position of the anchored object relative to the anchor. (Optional)
releaseAnchoredObject(
)
Releases the anchored object from its associated text.
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 AnchoredObjectSetting.
toSpecifier(
)
  → string
Retrieves the object specifier.