Class Checkbox
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Checkbox
Contiene información de la casilla de verificación para la configuración. Sus propiedades determinan cómo se muestra la casilla de verificación en Data Studio.
const config = DataStudioApp.createCommunityConnector().getConfig();
const checkbox = config.newCheckbox()
.setId('use_https')
.setName('Use Https?')
.setHelpText('Whether or not https should be used.')
.setAllowOverride(true);
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
Checkbox: 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
Checkbox: 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
Checkbox: 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
Checkbox: 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
Checkbox: 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\u003eThe \u003ccode\u003eCheckbox\u003c/code\u003e object configures checkbox properties for display in Data Studio.\u003c/p\u003e\n"],["\u003cp\u003eKey properties include ID, name, help text, and override settings, all set using designated methods.\u003c/p\u003e\n"],["\u003cp\u003eMethods like \u003ccode\u003esetAllowOverride\u003c/code\u003e, \u003ccode\u003esetHelpText\u003c/code\u003e, \u003ccode\u003esetId\u003c/code\u003e, \u003ccode\u003esetIsDynamic\u003c/code\u003e, and \u003ccode\u003esetName\u003c/code\u003e allow customization of the checkbox's functionality and appearance.\u003c/p\u003e\n"],["\u003cp\u003eEach method takes specific parameters, like \u003ccode\u003eallowOverride\u003c/code\u003e (boolean), \u003ccode\u003ehelpText\u003c/code\u003e (string), and \u003ccode\u003eid\u003c/code\u003e (string), to define the checkbox's behavior and presentation.\u003c/p\u003e\n"],["\u003cp\u003eAll Checkbox methods return the Checkbox object itself, enabling chained method calls for efficient configuration.\u003c/p\u003e\n"]]],[],null,["# Class Checkbox\n\nCheckbox\n\nContains checkbox information for the config. Its properties determine how the checkbox is\ndisplayed in Data Studio.\n\n```javascript\nconst config = DataStudioApp.createCommunityConnector().getConfig();\nconst checkbox = config.newCheckbox()\n .setId('use_https')\n .setName('Use Https?')\n .setHelpText('Whether or not https should be used.')\n .setAllowOverride(true);\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|---------------------------------------------------------------|---------------|-------------------------------------------------------|\n| [setAllowOverride(allowOverride)](#setAllowOverride(Boolean)) | [Checkbox](#) | Enables overriding for this config entry. |\n| [setHelpText(helpText)](#setHelpText(String)) | [Checkbox](#) | Sets the help text for this configuration entry. |\n| [setId(id)](#setId(String)) | [Checkbox](#) | Sets the unique ID for this configuration entry. |\n| [setIsDynamic(isDynamic)](#setIsDynamic(Boolean)) | [Checkbox](#) | Sets the dynamic status for this configuration entry. |\n| [setName(name)](#setName(String)) | [Checkbox](#) | Sets the display name 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[Checkbox](#) --- 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[Checkbox](#) --- 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[Checkbox](#) --- 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[Checkbox](#) --- 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[Checkbox](#) --- This builder, for chaining."]]
