Class IconImage
Page Summary
IconImage allows you to use a predefined icon, a material design icon, or an icon from a URL with customizable crop style.
You can set alternative text for accessibility, choose from predefined icons, specify an icon URL, set the image crop type, and set a material design icon.
Methods like
setAltText,setIcon,setIconUrl,setImageCropType, andsetMaterialIconare available to configure the IconImage.
A predefined icon, a material design icon, or an icon from a URL with a customizable crop style.
Methods
| Method | Return type | Brief description |
|---|---|---|
set | Icon | Sets the alternative text of the URL which is used for accessibility. |
set | Icon | Sets the predefined icon if the URL is not set. |
set | Icon | Sets the URL of the icon if the icon is not set. |
set | Icon | Sets the crop style for the image. |
set | Icon | Sets the material design icon. |
Detailed documentation
setAltText(altText)
Sets the alternative text of the URL which is used for accessibility.
Parameters
| Name | Type | Description |
|---|---|---|
alt | String | The alternative text. |
Return
Icon — This object, for chaining.
setIcon(icon)
setIconUrl(url)
Sets the URL of the icon if the icon is not set.
Parameters
| Name | Type | Description |
|---|---|---|
url | String | The URL address of a hosted image to use as an icon. |
Return
Icon — This object, for chaining.
setImageCropType(imageCropType)
Sets the crop style for the image. The crop type options you can use for icons areSQUARE andCIRCLE. Default isSQUARE.
Parameters
| Name | Type | Description |
|---|---|---|
image | Image | The ImageCropType option to apply. |
Return
Icon — This object, for chaining.
setMaterialIcon(icon)
Sets the material design icon.
consticonImage=CardService.newIconImage().setMaterialIcon(CardService.newMaterialIcon().setName('search'),);
Parameters
| Name | Type | Description |
|---|---|---|
icon | Material | The material icon. |
Return
Icon — 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.