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.

  • ThesetAspectRatio(ratio) method sets the aspect ratio when using theRECTANGLE_CUSTOM crop type, requiring a positive numerical value.

  • ThesetImageCropType(type) method sets the crop type for the image, defaulting toSQUARE.

ImageCropStyle

A class that represents a crop style that can be applied to image components. You can't set thesize 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 isRECTANGLE_CUSTOM.
setImageCropType(type)ImageCropStyleSets the crop type for the image.

Detailed documentation

setAspectRatio(ratio)

Sets the aspect ratio to use if the crop type isRECTANGLE_CUSTOM. The ratio mustbe 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.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-03 UTC.