Google is committed to advancing racial equity for Black communities. See how.

Class ImageCropStyle

ImageCropStyle

A class that represents a crop style that can be applied to image components.

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.