1. Home
  2. .Reshape~CutByImage

new CutByImage( imageSource )

Description

Trims pixels according to the transparency levels of a given overlay image. Wherever the overlay image is transparent, the original is shown, and wherever the overlay is opaque, the resulting image is transparent.

Parameters
Name Type Description
imageSource Qualifiers.Source.ImageSource
Details

SDK.Action

actions/reshape/CutByImage.ts, line 13

Visit Reshape for examples

Methods

position( position ) → {this}

Description

Defines the position of the layer.

Parameters
Name Type Description
position Qualifiers.Position

The position of the overlay with respect to the base image.
Returns
Details

actions/reshape/CutByImage.ts, line 22

getActionTag() → {string}

Description

Returns the custom name tag that was given to this action

Returns
Details

SDK.Action#getActionTag

SDK.Action#getActionTag

internal/Action.ts, line 29

setActionTag() → {this}

Description

Sets the custom name tag for this action

Returns
Details

SDK.Action#setActionTag

SDK.Action#setActionTag

internal/Action.ts, line 36

toString() → {string}

Description

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

Returns
Details

SDK.Action#toString

SDK.Action#toString

internal/Action.ts, line 44

addQualifier( qualifier ) → {this}

Description

Adds the parameter to the action.

Parameters
Name Type Description
qualifier SDK.Qualifier
Returns
Details

SDK.Action#addQualifier

SDK.Action#addQualifier

internal/Action.ts, line 53

addFlag( flag ) → {this}

Description

Adds a flag to the current action.

Parameters
Name Type Description
flag Qualifiers.Flag
Returns
Details

SDK.Action#addFlag

SDK.Action#addFlag

internal/Action.ts, line 77