Class

ClippingPathSettings

Clipping path settings. Base Class: Preference

QuickLinks

addEventListener, convertToFrame, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

EPS | Image | ImportedPage | PDF | PICT | WMF

Preference

ClippingPathSettings

Event | EventListener | MutationEvent | Path

Properties

Property	Type	Access	Description
alphaChannelPathNames	Array of string	readonly	A list of the alpha channels stored in the graphic.
appliedPathName	string	r/w	The name of the Photoshop path or alpha channel to use as a clipping path.
clippingType	ClippingPathType: ClippingPathType.NONE ClippingPathType.DETECT_EDGES ClippingPathType.ALPHA_CHANNEL ClippingPathType.PHOTOSHOP_PATH ClippingPathType.USER_MODIFIED_PATH	r/w	The clipping path type.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
includeInsideEdges	bool	r/w	If true, creates interior clipping paths within the surrounding clipping path. Note: Valid only when clipping type is alpha channel or detect edges.
insetFrame	Measurement Unit (Number or String)	r/w	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)
invertPath	bool	r/w	If true, inverts the clipping path.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
parent	EPS Image ImportedPage PDF PICT WMF	readonly	The parent of the ClippingPathSettings (a Image, EPS, WMF, PICT, PDF or ImportedPage).
paths	Paths Path	readonly	A collection of paths.
photoshopPathNames	Array of string	readonly	A list of the clipping paths stored in the graphic.
properties	Object	r/w	A property that allows setting of several properties at the same time.
restrictToFrame	bool	r/w	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.
threshold	number (range: 0 - 255)	r/w	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.
tolerance	number (range: 0 - 10)	r/w	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.
useHighResolutionImage	bool	r/w	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

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

PageItem convertToFrame ()
Converts the clipping path to a frame.

Array of ClippingPathSettings getElements ()
Resolves the object specifier, creating an array of object references.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

EPS.clippingPath

Image.clippingPath

ImportedPage.clippingPath

PDF.clippingPath

PICT.clippingPath

Path.parent

WMF.clippingPath

Return

Array of ClippingPathSettings ClippingPathSettings.getElements ()

Jongware, 28-Apr-2012 v3.0.3i

Contents :: Index