Class TextArea

AI-generated Key Takeaways

• TextArea defines how text input is displayed in Data Studio, and its properties can be customized using various methods.

• Developers can use methods like setAllowOverride, setHelpText, setId, setIsDynamic, setName, and setPlaceholder to configure the TextArea.

• Each method allows for customization, like enabling overrides, setting help text, defining IDs, setting dynamic status, naming the field, and adding placeholder text.

• All configuration methods return the TextArea builder, allowing for chained configurations in a fluent manner.

• Using TextArea, developers can create interactive text input fields in Data Studio for users to input data.

TextArea

Contains text area information for the config. Its properties determine how the text input is displayed in Data Studio.

Usage:

const cc = DataStudioApp.createCommunityConnector();
const config = cc.getConfig();

const textArea1 = config.newTextArea()
                      .setId('textArea1')
                      .setName('Search')
                      .setHelpText('for example, Coldplay')
                      .setAllowOverride(true)
                      .setPlaceholder('Search for an artist for all songs.');

Methods

Method	Return type	Brief description
setAllowOverride(allowOverride)	TextArea	Enables overriding for this config entry.
setHelpText(helpText)	TextArea	Sets the help text for this configuration entry.
setId(id)	TextArea	Sets the unique ID for this configuration entry.
setIsDynamic(isDynamic)	TextArea	Sets the dynamic status for this configuration entry.
setName(name)	TextArea	Sets the display name for this configuration entry.
setPlaceholder(placeholder)	TextArea	Sets the placeholder text for this configuration entry.

Detailed documentation

setAllowOverride(allowOverride)

Enables overriding for this config entry. If set to true, data source creators have the option to enable this for report editors.

Parameters

Name	Type	Description
allowOverride	Boolean	Whether or not this config entry can be overridden in reports.

Return

TextArea — This builder, for chaining.

---

setHelpText(helpText)

Sets the help text for this configuration entry.

Parameters

Name	Type	Description
helpText	String	The helpText to set.

Return

TextArea — This builder, for chaining.

---

setId(id)

Sets the unique ID for this configuration entry.

Parameters

Name	Type	Description
id	String	The ID to set.

Return

TextArea — This builder, for chaining.

---

setIsDynamic(isDynamic)

Sets the dynamic status for this configuration entry.

If a dynamic configuration entry is modified, subsequent configuration entries are cleared.

Parameters

Name	Type	Description
isDynamic	Boolean	The dynamic status to set.

Return

TextArea — This builder, for chaining.

---

setName(name)

Sets the display name for this configuration entry.

Parameters

Name	Type	Description
name	String	The name to set.

Return

TextArea — This builder, for chaining.

---

setPlaceholder(placeholder)

Sets the placeholder text for this configuration entry.

Parameters

Name	Type	Description
placeholder	String	The placeholder text to set.

Return

TextArea — This builder, for chaining.