Class ImageCropStyle

  • ImageCropStyle is a class used to apply crop styles to image components in Apps Script, as images cannot be sized or resized directly.

  • The class provides methods to set the aspect ratio and the crop type of an image.

  • The setAspectRatio(ratio) method sets the aspect ratio when using the RECTANGLE_CUSTOM crop type, requiring a positive numerical value.

  • The setImageCropType(type) method sets the crop type for the image, defaulting to SQUARE.
ImageCropStyle

A class that represents a crop style that can be applied to image components. You can't set the size of an image or resize it, but you can crop the image.

Methods

MethodReturn typeBrief description
setAspectRatio(ratio)ImageCropStyleSets the aspect ratio to use if the crop type is RECTANGLE_CUSTOM.
setImageCropType(type)ImageCropStyleSets the crop type for the image.

Detailed documentation

setAspectRatio(ratio)

Sets the aspect ratio to use if the crop type is RECTANGLE_CUSTOM. The ratio must be a positive value.

Parameters

NameTypeDescription
ratioNumberThe ratio to apply.

Return

ImageCropStyle — This object, for chaining.

Throws

Error — if the input is negative or zero.

setImageCropType(type)

Sets the crop type for the image. Default is SQUARE.

Parameters

NameTypeDescription
typeImageCropTypeThe crop type.

Return

ImageCropStyle — This object, for chaining.