Class TextStyleBuilder

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();

Methods

MethodReturn typeBrief description
build()TextStyleBuilds and returns a text style configuration object that was built using this builder.
setColor(cssValue)TextStyleBuilderSets the color of the text style.
setFontName(fontName)TextStyleBuilderSets the font name of the text style.
setFontSize(fontSize)TextStyleBuilderSets 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

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

NameTypeDescription
cssValueStringThe 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

NameTypeDescription
fontNameStringThe 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

NameTypeDescription
fontSizeNumberThe font size in pixels to use for the text style.

Return

TextStyleBuilder — This builder, useful for chaining.