1. Home
  2. .Resize.ResizeCropAction

new ResizeCropAction()

Description

Defines how to crop an asset

Details

Actions.Resize.ResizeAdvancedAction

actions/resize/ResizeCropAction.ts, line 10

Visit Resize for examples

Methods

x( x )

Description

Horizontal position for custom-coordinates based cropping.

Parameters
Name Type Description
x number

The x position.
Details

actions/resize/ResizeCropAction.ts, line 15

gravity( gravity )

Description

Which part of the original image to include.

Parameters
Name Type Description
gravity Qualifiers.Gravity
Details

Actions.Resize.ResizeAdvancedAction#gravity

actions/resize/ResizeAdvancedAction.ts, line 17

y( y )

Description

Vertical position for custom-coordinates based cropping

Parameters
Name Type Description
y number

The y position.
Details

actions/resize/ResizeCropAction.ts, line 23

getActionTag() → {string}

Description

Returns the custom name tag that was given to this action

Returns
Details

SDK.Action#getActionTag

internal/Action.ts, line 29

height( x )

Description

Sets the height of the resize

Parameters
Name Type Description
x string | number

The height in pixels (if an integer is specified) or as a percentage (if a float is specified).
Details

Actions.Resize.ResizeSimpleAction#height

actions/resize/ResizeSimpleAction.ts, line 33

setActionTag() → {this}

Description

Sets the custom name tag for this action

Returns
Details

SDK.Action#setActionTag

internal/Action.ts, line 36

width( x )

Description

Sets the width of the resize

Parameters
Name Type Description
x string | number

The width in pixels (if an integer is specified) or as a percentage (if a float is specified).
Details

Actions.Resize.ResizeSimpleAction#width

actions/resize/ResizeSimpleAction.ts, line 41

toString() → {string}

Description

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

Returns
Details

SDK.Action#toString

internal/Action.ts, line 44

aspectRatio( ratio ) → {this}

Description

Sets the aspect ratio of the asset. For a list of supported types see AspectRatio values

Parameters
Name Type Description
ratio AspectRatioType | number | string

The new aspect ratio, specified as a percentage or ratio.
Returns
Details

Actions.Resize.ResizeSimpleAction#aspectRatio

actions/resize/ResizeSimpleAction.ts, line 52

addQualifier( qualifier ) → {this}

Description

Adds the parameter to the action.

Parameters
Name Type Description
qualifier SDK.Qualifier
Returns
Details

SDK.Action#addQualifier

internal/Action.ts, line 53

relative() → {this}

Description

Modifies percentage-based width & height parameters of overlays and underlays (e.g., 1.0) to be relative to the containing image instead of the added layer.

Returns
Details

Actions.Resize.ResizeSimpleAction#relative

actions/resize/ResizeSimpleAction.ts, line 71

addFlag( flag ) → {this}

Description

Adds a flag to the current action.

Parameters
Name Type Description
flag Qualifiers.Flag
Returns
Details

SDK.Action#addFlag

internal/Action.ts, line 77

regionRelative() → {this}

Description

Modifies percentage-based width & height parameters of overlays and underlays (e.g., 1.0) to be relative to the overlaid region

Returns
Details

Actions.Resize.ResizeSimpleAction#regionRelative

actions/resize/ResizeSimpleAction.ts, line 79

zoom( z )

Description

Controls how much of the original image surrounding the face to keep when using either the 'crop' or 'thumb' cropping modes with face detection.

Parameters
Name Type Description
z number | string

The zoom factor. (Default: 1.0)
Details

actions/resize/ResizeCropAction.ts, line 31