Got 5 mins? Help us improve Apps Script documentation by taking a quick online study.

Class IconImage

IconImage

A predefined icon or an icon from a URL with a customizable crop style.

Methods

MethodReturn typeBrief description
setAltText(altText)IconImageSets the alternative text of the URL which is used for accessibility.
setIcon(icon)IconImageSets the predefined icon if the URL is not set.
setIconUrl(url)IconImageSets the URL of the icon if the icon is not set.
setImageCropType(imageCropType)IconImageSets the crop style for the image.

Detailed documentation

setAltText(altText)

Sets the alternative text of the URL which is used for accessibility.

Parameters

NameTypeDescription
altTextStringThe alternative text.

Return

IconImage — This object, for chaining.


setIcon(icon)

Sets the predefined icon if the URL is not set. Default is NONE.

Parameters

NameTypeDescription
iconIconOne of the predefined Icon values.

Return

IconImage — This object, for chaining.


setIconUrl(url)

Sets the URL of the icon if the icon is not set.

Parameters

NameTypeDescription
urlStringThe URL address of a hosted image to use as an icon.

Return

IconImage — This object, for chaining.


setImageCropType(imageCropType)

Sets the crop style for the image. The crop type options you can use for icons are SQUARE and CIRCLE. Default is SQUARE.

Parameters

NameTypeDescription
imageCropTypeImageCropTypeThe ImageCropType option to apply.

Return

IconImage — This object, for chaining.