K4 InDesign Javascript API Documentation

PreferencesClippingPathSettings

Clipping path settings.

Extends

Instance Properties

Name Description Access
alphaChannelPathNames string A list of the alpha channels stored in the graphic. read-only
appliedPathName string The name of the Photoshop path or alpha channel to use as a clipping path. read-write
clippingType ClippingPathType The clipping path type. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
includeInsideEdges bool If true, creates interior clipping paths within the surrounding clipping path. Note: Valid only when clipping type is alpha channel or detect edges. read-write
insetFrame Measurement Unit (Number or String)=any Shrinks the area enclosed by the clipping path by the specified amount. (Range depends on the unit. For points: -10000 to 10000; picas: -833p4 to 833p4; inches: -138.8889 to 138.8889; mm: -3527.778 to 3527.778; cm: -352.7778 to 352.7778; ciceros: -781c11.889 to 781c11.889) read-write
invertPath bool If true, inverts the clipping path. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent The parent of the ClippingPathSettings (a Image, EPS, WMF, PICT, PDF or ImportedPage). read-only
paths Paths A collection of paths. read-only
photoshopPathNames string A list of the clipping paths stored in the graphic. read-only
properties Object A property that allows setting of several properties at the same time. read-write
restrictToFrame bool If true, truncates the clipping path at the edge of the frame containing the graphic. Note: Valid only when clipping type is alpha channel or detect edges. read-write
threshold number The lowest value (darkest) pixel to allow in the image. All pixels in the image whose values are greater than (lighter than) the threshold value are clipped (obscured). (Range: 0 to 255) Note: Valid only when clipping type is detect edges or alpha channel. read-write
tolerance number Specifies how similar a pixel's intensity value can be to the threshold value before the pixel is obscured by the clipping path. (Range: 0 to 10) Note: Valid only when clipping type is detect edges or alpha channel. read-write
useHighResolutionImage bool If true, uses the high-resolution version of the graphic to create the clipping path. If false, calculates the clipping path based on screen-display resolution. Note: Valid only when clipping type is detect edges. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
convertToFrame(
)
  → PageItem
getElements(
)
  → ClippingPathSettings
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)
convertToFrame(
)
  → PageItem
Converts the clipping path to a frame.
getElements(
)
  → ClippingPathSettings
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 ClippingPathSettings.
toSpecifier(
)
  → string
Retrieves the object specifier.