Class IconImage
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
圖示圖片預先定義的圖示、Material Design 圖示,或含有可自訂裁剪樣式的網址圖示。
內容詳盡的說明文件
setAltText(altText)
設定網址的替代文字,用於無障礙功能。
參數
名稱 | 類型 | 說明 |
altText | String | 替代文字。 |
回攻員
IconImage
:這個物件用於鏈結。
setIcon(icon)
如果未設定網址,就會設定預先定義的圖示。預設值為「NONE」。
參數
回攻員
IconImage
:這個物件用於鏈結。
setIconUrl(url)
如果未設定圖示,則會設定圖示的網址。
參數
名稱 | 類型 | 說明 |
url | String | 要用來做為圖示的主機代管圖片網址。 |
回攻員
IconImage
:這個物件用於鏈結。
setImageCropType(imageCropType)
設定圖片的裁剪樣式。您可以為圖示使用 SQUARE
和 CIRCLE
這兩種裁剪類型選項。預設值為 SQUARE
。
參數
回攻員
IconImage
:這個物件用於鏈結。
setMaterialIcon(icon)
設定 Material Design 圖示。
const iconImage = CardService.newIconImage().setMaterialIcon(
CardService.newMaterialIcon().setName('search'),
);
參數
回攻員
IconImage
:這個物件用於鏈結。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-07-26 (世界標準時間)。
[null,null,["上次更新時間:2025-07-26 (世界標準時間)。"],[[["\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."]]