Class TextStyleBuilder
Stay organized with collections
Save and categorize content based on your preferences.
TextStyleBuilder
A builder used to create TextStyle
objects. It allows configuration of the text's
properties such as name, color, and size.
The following example shows how to create a text style using the builder. For a more complete
example, refer to the documentation for TextStyle
.
// Creates a new text style that uses 26-point, blue, Ariel font.
const textStyleBuilder =
Charts.newTextStyle().setColor('#0000FF').setFontName('Ariel').setFontSize(
26);
const style = textStyleBuilder.build();
Detailed documentation
build()
Builds and returns a text style configuration object that was built using this builder.
// Creates a new text style that uses 26-point blue font.
const textStyleBuilder =
Charts.newTextStyle().setColor('#0000FF').setFontSize(26);
const style = textStyleBuilder.build();
Return
TextStyle
— A text style object built using this builder.
setColor(cssValue)
Sets the color of the text style.
// Creates a new text style that uses blue font.
const textStyleBuilder = Charts.newTextStyle().setColor('#0000FF');
const style = textStyleBuilder.build();
Parameters
Name | Type | Description |
cssValue | String | The CSS value for the color (such as "blue" or "#00f" ). |
Return
TextStyleBuilder
— This builder, useful for chaining.
setFontName(fontName)
Sets the font name of the text style.
// Creates a new text style that uses Ariel font.
const textStyleBuilder = Charts.newTextStyle().setFontName('Ariel');
const style = textStyleBuilder.build();
Parameters
Name | Type | Description |
fontName | String | The font name to use for the text style. |
Return
TextStyleBuilder
— This builder, useful for chaining.
setFontSize(fontSize)
Sets the font size of the text style.
// Creates a new text style that uses 26-point font.
const textStyleBuilder = Charts.newTextStyle().setFontSize(26);
const style = textStyleBuilder.build();
Parameters
Name | Type | Description |
fontSize | Number | The font size in pixels to use for the text style. |
Return
TextStyleBuilder
— This builder, useful 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 2024-12-05 UTC.
[null,null,["Last updated 2024-12-05 UTC."],[[["\u003cp\u003eTextStyleBuilder is used to create TextStyle objects for customizing chart text appearance.\u003c/p\u003e\n"],["\u003cp\u003eIt allows configuration of text properties such as color, font name, and font size using methods like \u003ccode\u003esetColor\u003c/code\u003e, \u003ccode\u003esetFontName\u003c/code\u003e, and \u003ccode\u003esetFontSize\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ebuild\u003c/code\u003e method finalizes the configuration and returns a TextStyle object ready to be applied.\u003c/p\u003e\n"],["\u003cp\u003eTextStyleBuilder facilitates a chained approach for building the desired text style by returning the builder instance after each method call.\u003c/p\u003e\n"]]],["The `TextStyleBuilder` creates `TextStyle` objects, allowing text property configuration. Key actions include setting the text color via `setColor(cssValue)` using CSS values. The font is set using `setFontName(fontName)`, taking a string for the desired font. The font size is controlled with `setFontSize(fontSize)`, where the parameter represents pixel size. `build()` finalizes and returns the constructed `TextStyle` object. These methods can be chained.\n"],null,["# Class TextStyleBuilder\n\nTextStyleBuilder\n\nA builder used to create [TextStyle](/apps-script/reference/charts/text-style) objects. It allows configuration of the text's\nproperties such as name, color, and size.\n\nThe following example shows how to create a text style using the builder. For a more complete\nexample, refer to the documentation for [TextStyle](/apps-script/reference/charts/text-style).\n\n```javascript\n// Creates a new text style that uses 26-point, blue, Ariel font.\nconst textStyleBuilder =\n Charts.newTextStyle().setColor('#0000FF').setFontName('Ariel').setFontSize(\n 26);\nconst style = textStyleBuilder.build();\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|-----------------------------------------------|-------------------------------------------------------|-----------------------------------------------------------------------------------------|\n| [build()](#build()) | [TextStyle](/apps-script/reference/charts/text-style) | Builds and returns a text style configuration object that was built using this builder. |\n| [setColor(cssValue)](#setColor(String)) | [TextStyleBuilder](#) | Sets the color of the text style. |\n| [setFontName(fontName)](#setFontName(String)) | [TextStyleBuilder](#) | Sets the font name of the text style. |\n| [setFontSize(fontSize)](#setFontSize(Number)) | [TextStyleBuilder](#) | Sets the font size of the text style. |\n\nDetailed documentation\n----------------------\n\n### `build()`\n\nBuilds and returns a text style configuration object that was built using this builder.\n\n```javascript\n// Creates a new text style that uses 26-point blue font.\nconst textStyleBuilder =\n Charts.newTextStyle().setColor('#0000FF').setFontSize(26);\nconst style = textStyleBuilder.build();\n```\n\n#### Return\n\n\n[TextStyle](/apps-script/reference/charts/text-style) --- A text style object built using this builder.\n\n*** ** * ** ***\n\n### `set``Color(cssValue)`\n\nSets the color of the text style.\n\n```javascript\n// Creates a new text style that uses blue font.\nconst textStyleBuilder = Charts.newTextStyle().setColor('#0000FF');\nconst style = textStyleBuilder.build();\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------|----------|-------------------------------------------------------------|\n| `css``Value` | `String` | The CSS value for the color (such as `\"blue\"` or `\"#00f\"`). |\n\n#### Return\n\n\n[TextStyleBuilder](#) --- This builder, useful for chaining.\n\n*** ** * ** ***\n\n### `set``Font``Name(fontName)`\n\nSets the font name of the text style.\n\n```javascript\n// Creates a new text style that uses Ariel font.\nconst textStyleBuilder = Charts.newTextStyle().setFontName('Ariel');\nconst style = textStyleBuilder.build();\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------|----------|------------------------------------------|\n| `font``Name` | `String` | The font name to use for the text style. |\n\n#### Return\n\n\n[TextStyleBuilder](#) --- This builder, useful for chaining.\n\n*** ** * ** ***\n\n### `set``Font``Size(fontSize)`\n\nSets the font size of the text style.\n\n```javascript\n// Creates a new text style that uses 26-point font.\nconst textStyleBuilder = Charts.newTextStyle().setFontSize(26);\nconst style = textStyleBuilder.build();\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------|----------|----------------------------------------------------|\n| `font``Size` | `Number` | The font size in pixels to use for the text style. |\n\n#### Return\n\n\n[TextStyleBuilder](#) --- This builder, useful for chaining."]]