InDesign2026
API 21.5.1.73
Object

ClippingPathSettings

Clipping path settings.

Preference ClippingPathSettings
Hierarchy

EPS | Image | ImportedPage | PDF | PICT | WMF

ClippingPathSettings

Path

Properties

NameType AccessDescription
String[] readonly A list of the alpha channels stored in the graphic.
String read/write The name of the Photoshop path or alpha channel to use as a clipping path.
ClippingPathType
read/write The clipping path type.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Boolean read/write If true, creates interior clipping paths within the surrounding clipping path. Note: Valid only when clipping type is alpha channel or detect edges.
Number | String unit read/write 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)
Boolean read/write If true, inverts the clipping path.
Boolean readonly Returns true if the object specifier resolves to valid objects.
EPS | PDF | PICT | WMF | Image | ImportedPage readonly The parent of the ClippingPathSettings (a Image, EPS, WMF, PICT, PDF or ImportedPage).
Paths<Path> readonly A collection of paths.
String[] readonly A list of the clipping paths stored in the graphic.
Object read/write A property that allows setting of several properties at the same time.
Boolean read/write 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.
Number 0–255 read/write 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.
Number 0–10 read/write 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.
Boolean read/write 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.

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.
PageItem

Converts the clipping path to a frame.

ClippingPathSettings[]

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.
String

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

String

Retrieves the object specifier.

Object of 10

Properties elsewhere that hold a ClippingPathSettings.

Return 1

Methods that return a ClippingPathSettings.