K4 InDesign Javascript API Documentation

LayoutFrameFittingOption

Options for fitting placed or pasted content in a frame.

Extends

Instance Properties

Name Description Access
autoFit bool If true, the last saved fitting options will be applied to the contents of a frame when it is resized. read-write
bottomCrop Measurement Unit (Number or String)=any The amount in measurement units to crop the bottom edge of a graphic. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
fittingAlignment AnchorPoint The point with which to align the image empty when fitting in a frame. For information, see frame fitting options. read-write
fittingOnEmptyFrame EmptyFrameFittingOptions The frame fitting option to apply to placed or pasted content if the frame is empty. Can be applied to a frame, object style, or document or to the application. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
leftCrop Measurement Unit (Number or String)=any The amount in measurement units to crop the left edge of a graphic. read-write
parent The parent of the FrameFittingOption (a ObjectStyle, Oval, Rectangle, Polygon, Application or Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write
rightCrop Measurement Unit (Number or String)=any The amount in measurement units to crop the right edge of a graphic. read-write
topCrop Measurement Unit (Number or String)=any The amount in measurement units to crop the top edge of a graphic. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → FrameFittingOption
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(
)
  → FrameFittingOption
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)
toSource(
)
  → string
Generates a string which, if executed, will return the FrameFittingOption.
toSpecifier(
)
  → string
Retrieves the object specifier.