Class TextArea
Page Summary
TextArea in Data Studio config controls how text input is displayed.
TextArea properties can be set using methods like setId, setName, setHelpText, setAllowOverride, and setPlaceholder.
The setAllowOverride method allows data source creators to enable overriding for report editors.
The setIsDynamic method, when set to true and modified, clears subsequent configuration entries.
All setting methods for TextArea return the TextArea object for method chaining.
Contains text area information for the config. Its properties determine how the text input isdisplayed in Data Studio.
Usage:
constcc=DataStudioApp.createCommunityConnector();constconfig=cc.getConfig();consttextArea1=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 |
|---|---|---|
set | Text | Enables overriding for this config entry. |
set | Text | Sets the help text for this configuration entry. |
set | Text | Sets the unique ID for this configuration entry. |
set | Text | Sets the dynamic status for this configuration entry. |
set | Text | Sets the display name for this configuration entry. |
set | Text | Sets the placeholder text for this configuration entry. |
Detailed documentation
setAllowOverride(allowOverride)
Enables overriding for this config entry. If set totrue, data source creators have theoption to enable this for report editors.
Parameters
| Name | Type | Description |
|---|---|---|
allow | Boolean | Whether or not this config entry can be overridden in reports. |
Return
Text — This builder, for chaining.
setHelpText(helpText)
Sets the help text for this configuration entry.
Parameters
| Name | Type | Description |
|---|---|---|
help | String | The helpText to set. |
Return
Text — 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
Text — 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 |
|---|---|---|
is | Boolean | The dynamic status to set. |
Return
Text — 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
Text — 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
Text — This builder, for chaining.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-11 UTC.