Class IconImage
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
IcôneImage
Une icône prédéfinie, une icône Material Design ou une icône à partir d'une URL avec un style de recadrage personnalisable.
Documentation détaillée
setAltText(altText)
Définit le texte alternatif de l'URL, qui est utilisé pour l'accessibilité.
Paramètres
| Nom | Type | Description |
altText | String | Texte alternatif. |
Renvois
IconImage : cet objet, pour le chaînage.
setIcon(icon)
Définit l'icône prédéfinie si l'URL n'est pas définie. La valeur par défaut est "NONE".
Paramètres
| Nom | Type | Description |
icon | Icon | L'une des valeurs Icon prédéfinies. |
Renvois
IconImage : cet objet, pour le chaînage.
setIconUrl(url)
Définit l'URL de l'icône si elle n'est pas définie.
Paramètres
| Nom | Type | Description |
url | String | URL d'une image hébergée à utiliser comme icône. |
Renvois
IconImage : cet objet, pour le chaînage.
setImageCropType(imageCropType)
Définit le style de recadrage de l'image. Les types de recadrage que vous pouvez utiliser pour les icônes sont SQUARE
et CIRCLE. La valeur par défaut est SQUARE.
Paramètres
| Nom | Type | Description |
imageCropType | ImageCropType | Option ImageCropType à appliquer. |
Renvois
IconImage : cet objet, pour le chaînage.
setMaterialIcon(icon)
Définit l'icône Material Design.
const iconImage = CardService.newIconImage().setMaterialIcon(
CardService.newMaterialIcon().setName('search'),
);
Paramètres
Renvois
IconImage : cet objet, pour le chaînage.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/26 (UTC).
[null,null,["Dernière mise à jour le 2025/07/26 (UTC)."],[[["\u003cp\u003e\u003ccode\u003eIconImage\u003c/code\u003e allows you to display a predefined or custom icon using a URL.\u003c/p\u003e\n"],["\u003cp\u003eYou can customize the icon's appearance with a specific crop style (SQUARE or CIRCLE).\u003c/p\u003e\n"],["\u003cp\u003eAlternative text can be set for accessibility purposes using \u003ccode\u003esetAltText()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003esetIcon()\u003c/code\u003e and \u003ccode\u003esetIconUrl()\u003c/code\u003e methods allow you to specify the icon source, either a predefined icon or a URL.\u003c/p\u003e\n"],["\u003cp\u003eAll methods return the \u003ccode\u003eIconImage\u003c/code\u003e object, enabling method chaining for streamlined configuration.\u003c/p\u003e\n"]]],["The `IconImage` object allows setting an icon using predefined options, a material design icon, or a URL. Key actions include: setting alternative text for accessibility (`setAltText`), choosing a predefined icon (`setIcon`), specifying an icon URL (`setIconUrl`), defining the image crop style (`setImageCropType`), and selecting a material design icon (`setMaterialIcon`). Each method returns the `IconImage` object for chaining additional actions.\n"],null,["# Class IconImage\n\nIconImage\n\nA predefined icon, a material design icon, or an icon from a URL with a customizable crop style. \n\n### Methods\n\n| Method | Return type | Brief description |\n|---------------------------------------------------------------------|----------------|-----------------------------------------------------------------------|\n| [setAltText(altText)](#setAltText(String)) | [IconImage](#) | Sets the alternative text of the URL which is used for accessibility. |\n| [setIcon(icon)](#setIcon(Icon)) | [IconImage](#) | Sets the predefined icon if the URL is not set. |\n| [setIconUrl(url)](#setIconUrl(String)) | [IconImage](#) | Sets the URL of the icon if the icon is not set. |\n| [setImageCropType(imageCropType)](#setImageCropType(ImageCropType)) | [IconImage](#) | Sets the crop style for the image. |\n| [setMaterialIcon(icon)](#setMaterialIcon(MaterialIcon)) | [IconImage](#) | Sets the material design icon. |\n\nDetailed documentation\n----------------------\n\n### `set``Alt``Text(altText)`\n\nSets the alternative text of the URL which is used for accessibility.\n\n#### Parameters\n\n| Name | Type | Description |\n|-------------|----------|-----------------------|\n| `alt``Text` | `String` | The alternative text. |\n\n#### Return\n\n\n[IconImage](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Icon(icon)`\n\nSets the predefined icon if the URL is not set. Default is NONE.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|--------------------------------------------------|--------------------------------------------------------------------------------|\n| `icon` | [Icon](/apps-script/reference/card-service/icon) | One of the predefined [Icon](/apps-script/reference/card-service/icon) values. |\n\n#### Return\n\n\n[IconImage](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Icon``Url(url)`\n\nSets the URL of the icon if the icon is not set.\n\n#### Parameters\n\n| Name | Type | Description |\n|-------|----------|------------------------------------------------------|\n| `url` | `String` | The URL address of a hosted image to use as an icon. |\n\n#### Return\n\n\n[IconImage](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Image``Crop``Type(imageCropType)`\n\nSets the crop style for the image. The crop type options you can use for icons are `SQUARE\n` and `CIRCLE`. Default is `SQUARE`.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------------------|----------------------------------------------------------------------|------------------------------------|\n| `image``Crop``Type` | [ImageCropType](/apps-script/reference/card-service/image-crop-type) | The ImageCropType option to apply. |\n\n#### Return\n\n\n[IconImage](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Material``Icon(icon)`\n\nSets the material design icon.\n\n```javascript\nconst iconImage = CardService.newIconImage().setMaterialIcon(\n CardService.newMaterialIcon().setName('search'),\n);\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|-------------------------------------------------------------------|--------------------|\n| `icon` | [MaterialIcon](/apps-script/reference/card-service/material-icon) | The material icon. |\n\n#### Return\n\n\n[IconImage](#) --- This object, for chaining."]]
