new ClipAction()

Description

Defines the clipping path to use when trimming pixels.

Details

Visit PSDTools for an example

Methods


byName( path ) → {this}

Description

The name of the path to clip by

Parameters
Name Type Description
path string
Returns

getActionTag() → {string}

Description

Returns the custom name tag that was given to this action

Returns

byIndex( path ) → {this}

Description

The index of the path to clip by

Parameters
Name Type Description
path number
Returns

setActionTag() → {this}

Description

Sets the custom name tag for this action

Returns

evenOdd() → {this}

Description

Trims pixels according to a clipping path included in the original image using an evenodd clipping rule.

Returns

toString() → {string}

Description

Calls toString() on all child qualifiers (implicitly by using .join()).

Returns
Details

addQualifier( qualifier ) → {this}

Description

Adds the parameter to the action.

Parameters
Name Type Description
qualifier SDK.Qualifier
Returns

addFlag( flag ) → {this}

Description

Adds a flag to the current action.

Parameters
Name Type Description
flag Qualifiers.Flag
Returns
Details