Methods
-
gravity( gravity )
-
Description
Which part of the original image to include.
Parameters
Name Type Description gravityQualifiers.Gravity Details
-
background( backgroundQualifier )
-
Description
Sets the background.
Parameters
Name Type Description backgroundQualifierQualifiers.Background Defines the background color to use instead of transparent background areas or when resizing with padding.
Details
-
offsetX( x )
-
Description
Horizontal position for custom-coordinates based padding.
Parameters
Name Type Description xnumber The x position.
Details
-
getActionTag() → {string}
-
Description
Returns the custom name tag that was given to this action
Returns
Details
-
height( x )
-
Description
Sets the height of the resize
Parameters
Name Type Description xstring | number The height in pixels (if an integer is specified) or as a percentage (if a float is specified).
Details
-
offsetY( y )
-
Description
Vertical position for custom-coordinates based padding
Parameters
Name Type Description ynumber The y position.
Details
-
setActionTag() → {this}
-
Description
Sets the custom name tag for this action
Returns
Details
-
width( x )
-
Description
Sets the width of the resize
Parameters
Name Type Description xstring | number The width in pixels (if an integer is specified) or as a percentage (if a float is specified).
Details
-
toString() → {string}
-
Description
Calls toString() on all child qualifiers (implicitly by using .join()).
Returns
Details
-
aspectRatio( ratio ) → {this}
-
Description
Sets the aspect ratio of the asset. For a list of supported types see
AspectRatio valuesParameters
Name Type Description ratioAspectRatioType | number | string The new aspect ratio, specified as a percentage or ratio.
Returns
Details
-
addQualifier( qualifier ) → {this}
-
Description
Adds the parameter to the action.
Parameters
Name Type Description qualifierSDK.Qualifier Returns
Details
-
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
-
addFlag( flag ) → {this}
-
Description
Adds a flag to the current action.
Parameters
Name Type Description flagQualifiers.Flag Returns
Details
-
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