A predefined icon or an icon from a URL with a customizable crop style.
Methods
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
setAltText(altText)
Sets the alternative text of the URL which is used for accessibility.
Parameters
Name | Type | Description |
---|---|---|
altText | String | The alternative text. |
Return
IconImage
— 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
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
Name | Type | Description |
---|---|---|
imageCropType | ImageCropType | The ImageCropType option to apply. |
Return
IconImage
— This object, for chaining.