Adobe InDesign CS6 Server (8.0) Object Model JS: ClippingPathSettings

InDesign Server CS6

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

PropertyTypeAccessDescription
alphaChannelPathNamesArray of string readonlyA list of the alpha channels stored in the graphic.
appliedPathNamestring r/wThe name of the Photoshop path or alpha channel to use as a clipping path.
clippingTypeClippingPathType:
ClippingPathType.NONE
ClippingPathType.DETECT_EDGES
ClippingPathType.ALPHA_CHANNEL
ClippingPathType.PHOTOSHOP_PATH
ClippingPathType.USER_MODIFIED_PATH
r/wThe clipping path type.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
includeInsideEdgesbool r/wIf true, creates interior clipping paths within the surrounding clipping path. Note: Valid only when clipping type is alpha channel or detect edges.
insetFrameMeasurement Unit (Number or String) r/wShrinks 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)
invertPathbool r/wIf true, inverts the clipping path.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentEPS
Image
ImportedPage
PDF
PICT
WMF
readonlyThe parent of the ClippingPathSettings (a Image, EPS, WMF, PICT, PDF or ImportedPage).
pathsPaths Path readonlyA collection of paths.
photoshopPathNamesArray of string readonlyA list of the clipping paths stored in the graphic.
propertiesObject r/wA property that allows setting of several properties at the same time.
restrictToFramebool r/wIf 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.
thresholdnumber (range: 0 - 255) r/wThe 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.
tolerancenumber (range: 0 - 10) r/wSpecifies 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.
useHighResolutionImagebool r/wIf 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.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis 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.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis 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.3iContents :: Index