Class ImageCropStyle
Stay organized with collections
Save and categorize content based on your preferences.
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.
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
| Name | Type | Description |
ratio | Number | The 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
Return
ImageCropStyle — This object, for chaining.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["\u003cp\u003e\u003ccode\u003eImageCropStyle\u003c/code\u003e allows cropping images within Google Apps Script, but not resizing them directly.\u003c/p\u003e\n"],["\u003cp\u003eTwo main methods, \u003ccode\u003esetAspectRatio\u003c/code\u003e and \u003ccode\u003esetImageCropType\u003c/code\u003e, provide control over the cropping process.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003esetAspectRatio\u003c/code\u003e is applicable only when using the \u003ccode\u003eRECTANGLE_CUSTOM\u003c/code\u003e crop type and requires a positive ratio value.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003esetImageCropType\u003c/code\u003e lets you choose the shape of the crop, with \u003ccode\u003eSQUARE\u003c/code\u003e being the default option.\u003c/p\u003e\n"],["\u003cp\u003eBoth methods return the \u003ccode\u003eImageCropStyle\u003c/code\u003e object, enabling method chaining for streamlined code.\u003c/p\u003e\n"]]],["The `ImageCropStyle` class allows users to crop images without resizing them. Key actions include setting the image crop type using `setImageCropType`, which defaults to SQUARE. For a `RECTANGLE_CUSTOM` crop type, you can set the aspect ratio via `setAspectRatio`, which requires a positive numeric value. Both methods return the `ImageCropStyle` object, enabling method chaining. `setAspectRatio` throws an error if the ratio is zero or negative.\n"],null,["# Class ImageCropStyle\n\nImageCropStyle\n\nA class that represents a crop style that can be applied to image components. You can't set the\nsize of an image or resize it, but you can crop the image. \n\n### Methods\n\n| Method | Return type | Brief description |\n|------------------------------------------------------------|---------------------|----------------------------------------------------------------------|\n| [setAspectRatio(ratio)](#setAspectRatio(Number)) | [ImageCropStyle](#) | Sets the aspect ratio to use if the crop type is `RECTANGLE_CUSTOM`. |\n| [setImageCropType(type)](#setImageCropType(ImageCropType)) | [ImageCropStyle](#) | Sets the crop type for the image. |\n\nDetailed documentation\n----------------------\n\n### `set``Aspect``Ratio(ratio)`\n\nSets the aspect ratio to use if the crop type is `RECTANGLE_CUSTOM`. The ratio must\nbe a positive value.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|----------|---------------------|\n| `ratio` | `Number` | The ratio to apply. |\n\n#### Return\n\n\n[ImageCropStyle](#) --- This object, for chaining.\n\n#### Throws\n\n\n[`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) --- if the input is negative or zero.\n\n*** ** * ** ***\n\n### `set``Image``Crop``Type(type)`\n\nSets the crop type for the image. Default is SQUARE.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|----------------------------------------------------------------------|----------------|\n| `type` | [ImageCropType](/apps-script/reference/card-service/image-crop-type) | The crop type. |\n\n#### Return\n\n\n[ImageCropStyle](#) --- This object, for chaining."]]
