Class IconImage

IconImage

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

Method	Return type	Brief description
`setAltText(altText)`	`IconImage`	Sets the alternative text of the URL which is used for accessibility.
`setIcon(icon)`	`IconImage`	Sets the predefined icon if the URL is not set.
`setIconUrl(url)`	`IconImage`	Sets the URL of the icon if the icon is not set.
`setImageCropType(imageCropType)`	`IconImage`	Sets the crop style for the image.

Detailed documentation

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

Name	Type	Description
`altText`	`String`	The alternative text.

IconImage — This object, for chaining.

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

Name	Type	Description
`icon`	`Icon`	One of the predefined `Icon` values.

IconImage — This object, for chaining.

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

Name	Type	Description
`url`	`String`	The URL address of a hosted image to use as an icon.

IconImage — This object, for chaining.

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

Name	Type	Description
`imageCropType`	`ImageCropType`	The ImageCropType option to apply.

IconImage — This object, for chaining.