Class MaterialIcon
Stay organized with collections
Save and categorize content based on your preferences.
MaterialIcon
An object that supports all Google Font Icons.
Available for Google Workspace add-ons and Google Chat apps.
const materialIcon = CardService.newMaterialIcon()
.setName('search')
.setFill(true)
.setWeight(400)
.setGrade(0);
Detailed documentation
setFill(fill)
Whether the icon renders as filled. Default value is false.
To preview different icon settings, go to Google
Font Icons and adjust the settings under Customize.
const materialIcon =
CardService.newMaterialIcon().setName('search').setFill(true);
Parameters
| Name | Type | Description |
fill | Boolean | Whether the icon is filled. |
Return
MaterialIcon — This object, for chaining.
setGrade(grade)
Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than
adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0,
200}. If absent, default value is 0. If any other value is specified, the default value is
used.
To preview different icon settings, go to Google
Font Icons and adjust the settings under Customize.
const materialIcon =
CardService.newMaterialIcon().setName('search').setGrade(200);
Parameters
| Name | Type | Description |
grade | Integer | The icon's grade. |
Return
MaterialIcon — This object, for chaining.
setName(name)
Sets the name of the icon. Required.
The icon name defined in Google Font Icon, For
example, check_box.
Any invalid names are abandoned and replaced with an empty string and results in the icon
failing to render.
const materialIcon = CardService.newMaterialIcon().setName('search');
Parameters
| Name | Type | Description |
name | String | The name of the icon. |
Return
MaterialIcon — This object, for chaining.
setWeight(weight)
The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent,
default value is 400. If any other value is specified, the default value is used.
To preview different icon settings, go to Google
Font Icons and adjust the settings under Customize.
const materialIcon =
CardService.newMaterialIcon().setName('search').setWeight(700);
Parameters
| Name | Type | Description |
weight | Integer | The stroke weight of the icon. |
Return
MaterialIcon — This object, for chaining.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-30 UTC.
[null,null,["Last updated 2025-01-30 UTC."],[[["\u003cp\u003e\u003ccode\u003eMaterialIcon\u003c/code\u003e objects allow you to use and customize \u003ca href=\"https://fonts.google.com/icons\"\u003eGoogle Font Icons\u003c/a\u003e within Google Workspace Add-ons and Google Chat apps.\u003c/p\u003e\n"],["\u003cp\u003eYou can customize the icon's appearance by setting its fill, grade, name, and weight using methods like \u003ccode\u003esetFill()\u003c/code\u003e, \u003ccode\u003esetGrade()\u003c/code\u003e, \u003ccode\u003esetName()\u003c/code\u003e, and \u003ccode\u003esetWeight()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eRefer to the \u003ca href=\"https://fonts.google.com/icons\"\u003eGoogle Font Icons\u003c/a\u003e website to preview different icon settings and find valid icon names.\u003c/p\u003e\n"],["\u003cp\u003eWhen setting grade and weight, ensure you use the accepted values or the default values will be applied.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003esetName()\u003c/code\u003e method is required and uses the icon name as defined on the Google Font Icons website; using an invalid name will result in the icon not rendering.\u003c/p\u003e\n"]]],[],null,["# Class MaterialIcon\n\nMaterialIcon\n\nAn object that supports all [Google Font Icons](https://fonts.google.com/icons).\n\nAvailable for Google Workspace add-ons and Google Chat apps.\n\n```javascript\nconst materialIcon = CardService.newMaterialIcon()\n .setName('search')\n .setFill(true)\n .setWeight(400)\n .setGrade(0);\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|------------------------------------------|-------------------|-----------------------------------------------|\n| [setFill(fill)](#setFill(Boolean)) | [MaterialIcon](#) | Whether the icon renders as filled. |\n| [setGrade(grade)](#setGrade(Integer)) | [MaterialIcon](#) | Weight and grade affect a symbol's thickness. |\n| [setName(name)](#setName(String)) | [MaterialIcon](#) | Sets the name of the icon. |\n| [setWeight(weight)](#setWeight(Integer)) | [MaterialIcon](#) | The stroke weight of the icon. |\n\nDetailed documentation\n----------------------\n\n### `set``Fill(fill)`\n\nWhether the icon renders as filled. Default value is `false`.\n\nTo preview different icon settings, go to [Google\nFont Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.\n\n```javascript\nconst materialIcon =\n CardService.newMaterialIcon().setName('search').setFill(true);\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|-----------|-----------------------------|\n| `fill` | `Boolean` | Whether the icon is filled. |\n\n#### Return\n\n\n[MaterialIcon](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Grade(grade)`\n\nWeight and grade affect a symbol's thickness. Adjustments to grade are more granular than\nadjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0,\n200}. If absent, default value is 0. If any other value is specified, the default value is\nused.\n\nTo preview different icon settings, go to [Google\nFont Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.\n\n```javascript\nconst materialIcon =\n CardService.newMaterialIcon().setName('search').setGrade(200);\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|-----------|-------------------|\n| `grade` | `Integer` | The icon's grade. |\n\n#### Return\n\n\n[MaterialIcon](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Name(name)`\n\nSets the name of the icon. Required.\n\nThe icon name defined in [Google Font Icon](https://fonts.google.com/icons), For\nexample, `check_box`.\n\nAny invalid names are abandoned and replaced with an empty string and results in the icon\nfailing to render.\n\n```javascript\nconst materialIcon = CardService.newMaterialIcon().setName('search');\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|----------|-----------------------|\n| `name` | `String` | The name of the icon. |\n\n#### Return\n\n\n[MaterialIcon](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Weight(weight)`\n\nThe stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent,\ndefault value is 400. If any other value is specified, the default value is used.\n\nTo preview different icon settings, go to [Google\nFont Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.\n\n```javascript\nconst materialIcon =\n CardService.newMaterialIcon().setName('search').setWeight(700);\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|----------|-----------|--------------------------------|\n| `weight` | `Integer` | The stroke weight of the icon. |\n\n#### Return\n\n\n[MaterialIcon](#) --- This object, for chaining."]]
