A builder used to create Text
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 Text
.
// 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();
Methods
Method | Return type | Brief description |
---|---|---|
build() | Text | Builds and returns a text style configuration object that was built using this builder. |
set | Text | Sets the color of the text style. |
set | Text | Sets the font name of the text style. |
set | Text | Sets the font size of the text style. |
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
Text
— 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 |
---|---|---|
css | String | The CSS value for the color (such as "blue" or "#00f" ). |
Return
Text
— 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 |
---|---|---|
font | String | The font name to use for the text style. |
Return
Text
— 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 |
---|---|---|
font | Number | The font size in pixels to use for the text style. |
Return
Text
— This builder, useful for chaining.