Class TextArea
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Área de texto
Contiene información del área de texto para la configuración. Sus propiedades determinan cómo se muestra la entrada de texto en Data Studio.
Uso:
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.');
Documentación detallada
setAllowOverride(allowOverride)
Habilita la anulación para esta entrada de configuración. Si se establece en true, los creadores de fuentes de datos tienen la opción de habilitar esta opción para los editores de informes.
Parámetros
| Nombre | Tipo | Descripción |
allowOverride | Boolean | Indica si esta entrada de configuración se puede anular en los informes. |
Volver
TextArea: Este compilador, para encadenar.
setHelpText(helpText)
Establece el texto de ayuda para esta entrada de configuración.
Parámetros
| Nombre | Tipo | Descripción |
helpText | String | Es el texto de ayuda que se establecerá. |
Volver
TextArea: Este compilador, para encadenar.
setId(id)
Establece el ID único para esta entrada de configuración.
Parámetros
| Nombre | Tipo | Descripción |
id | String | Es el ID que se establecerá. |
Volver
TextArea: Este compilador, para encadenar.
setIsDynamic(isDynamic)
Establece el estado dinámico de esta entrada de configuración.
Si se modifica una entrada de configuración dinámica, se borran las entradas de configuración posteriores.
Parámetros
| Nombre | Tipo | Descripción |
isDynamic | Boolean | Es el estado dinámico que se establecerá. |
Volver
TextArea: Este compilador, para encadenar.
setName(name)
Establece el nombre visible para esta entrada de configuración.
Parámetros
| Nombre | Tipo | Descripción |
name | String | Es el nombre que se debe establecer. |
Volver
TextArea: Este compilador, para encadenar.
setPlaceholder(placeholder)
Establece el texto del marcador de posición para esta entrada de configuración.
Parámetros
| Nombre | Tipo | Descripción |
placeholder | String | Es el texto del marcador de posición que se establecerá. |
Volver
TextArea: Este compilador, para encadenar.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-26 (UTC)
[null,null,["Última actualización: 2025-07-26 (UTC)"],[[["\u003cp\u003eTextArea defines how text input is displayed in Data Studio, and its properties can be customized using various methods.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use methods like \u003ccode\u003esetAllowOverride\u003c/code\u003e, \u003ccode\u003esetHelpText\u003c/code\u003e, \u003ccode\u003esetId\u003c/code\u003e, \u003ccode\u003esetIsDynamic\u003c/code\u003e, \u003ccode\u003esetName\u003c/code\u003e, and \u003ccode\u003esetPlaceholder\u003c/code\u003e to configure the TextArea.\u003c/p\u003e\n"],["\u003cp\u003eEach method allows for customization, like enabling overrides, setting help text, defining IDs, setting dynamic status, naming the field, and adding placeholder text.\u003c/p\u003e\n"],["\u003cp\u003eAll configuration methods return the TextArea builder, allowing for chained configurations in a fluent manner.\u003c/p\u003e\n"],["\u003cp\u003eUsing \u003ccode\u003eTextArea\u003c/code\u003e, developers can create interactive text input fields in Data Studio for users to input data.\u003c/p\u003e\n"]]],[],null,["# Class TextArea\n\nTextArea\n\nContains text area information for the config. Its properties determine how the text input is\ndisplayed in Data Studio.\n\nUsage:\n\n```javascript\nconst cc = DataStudioApp.createCommunityConnector();\nconst config = cc.getConfig();\n\nconst textArea1 = config.newTextArea()\n .setId('textArea1')\n .setName('Search')\n .setHelpText('for example, Coldplay')\n .setAllowOverride(true)\n .setPlaceholder('Search for an artist for all songs.');\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|---------------------------------------------------------------|---------------|---------------------------------------------------------|\n| [setAllowOverride(allowOverride)](#setAllowOverride(Boolean)) | [TextArea](#) | Enables overriding for this config entry. |\n| [setHelpText(helpText)](#setHelpText(String)) | [TextArea](#) | Sets the help text for this configuration entry. |\n| [setId(id)](#setId(String)) | [TextArea](#) | Sets the unique ID for this configuration entry. |\n| [setIsDynamic(isDynamic)](#setIsDynamic(Boolean)) | [TextArea](#) | Sets the dynamic status for this configuration entry. |\n| [setName(name)](#setName(String)) | [TextArea](#) | Sets the display name for this configuration entry. |\n| [setPlaceholder(placeholder)](#setPlaceholder(String)) | [TextArea](#) | Sets the placeholder text for this configuration entry. |\n\nDetailed documentation\n----------------------\n\n### `set``Allow``Override(allowOverride)`\n\nEnables overriding for this config entry. If set to `true`, data source creators have the\noption to enable this for report editors.\n\n#### Parameters\n\n| Name | Type | Description |\n|-------------------|-----------|----------------------------------------------------------------|\n| `allow``Override` | `Boolean` | Whether or not this config entry can be overridden in reports. |\n\n#### Return\n\n\n[TextArea](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `set``Help``Text(helpText)`\n\nSets the help text for this configuration entry.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------|----------|----------------------|\n| `help``Text` | `String` | The helpText to set. |\n\n#### Return\n\n\n[TextArea](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `set``Id(id)`\n\nSets the unique ID for this configuration entry.\n\n#### Parameters\n\n| Name | Type | Description |\n|------|----------|----------------|\n| `id` | `String` | The ID to set. |\n\n#### Return\n\n\n[TextArea](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `set``Is``Dynamic(isDynamic)`\n\nSets the dynamic status for this configuration entry.\n\nIf a dynamic configuration entry is modified, subsequent configuration entries are cleared.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------------|-----------|----------------------------|\n| `is``Dynamic` | `Boolean` | The dynamic status to set. |\n\n#### Return\n\n\n[TextArea](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `set``Name(name)`\n\nSets the display name for this configuration entry.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|----------|------------------|\n| `name` | `String` | The name to set. |\n\n#### Return\n\n\n[TextArea](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `set``Placeholder(placeholder)`\n\nSets the placeholder text for this configuration entry.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------------|----------|------------------------------|\n| `placeholder` | `String` | The placeholder text to set. |\n\n#### Return\n\n\n[TextArea](#) --- This builder, for chaining."]]
