Indesign Scripting Reference
home | search | Links
JavaScript >> ClippingPathSettings

ClippingPathSettings

A clipping path object.

ClippingPathSettings Properties

Property Type Access Description
alphaChannelPathNames Array of Strings read A list of the names of the alpha channel paths in the imported graphic.
appliedPathName String r/w The name of current clipping path applied.
clippingType ClippingPathType enumeration r/w The clipping path type.
includeInsideEdges Boolean r/w If true, include inside edges in the clipping path.
insetFrame Unit r/w The inset of the clipping path.
invertPath Boolean r/w If true, invert the clipping path.
parent Object read The parent of the object.
paths Paths read The paths of the object.
photoshopPathNames Array of Strings read A list of the names of the Photoshop paths in the imported graphic.
properties An array of property names and values r/w Property that allows setting of several properties at the same time.
restrictToFrame Boolean r/w If true, restrict the clipping path to the frame.
threshold Long (0 - 255) r/w Threshold for detect edges or alpha channel.
tolerance Real (0 - 10) r/w Tolerance.
useHighResolutionImage Boolean r/w If true, use high resolution image data when creating the clipping path.

ClippingPathSettings Methods

Method Returns Description
convertToFrame PageItem Convert to Frame.
getElements Array of Objects Resolve the object specifier.
toSource String Generate JavaScript source that, if executed, will return the specified objects.
toSpecifier String Retrieve the object specifier.