Class Checkbox
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Pole wyboru
Zawiera informacje o poleceniach wyboru w konfiguracji. Jej właściwości określają sposób wyświetlania pola wyboru w Studiu danych.
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);
Szczegółowa dokumentacja
setAllowOverride(allowOverride)
Umożliwia zastąpienie tego wpisu konfiguracji. Jeśli ustawisz tę opcję na true, twórcy źródeł danych będą mogli włączyć tę opcję dla edytorów raportów.
Parametry
| Nazwa | Typ | Opis |
allowOverride | Boolean | Określa, czy ten wpis konfiguracji może być zastąpiony w raportach. |
Powrót
Checkbox – ten kreator do łańcuchowania.
setHelpText(helpText)
Ustawia tekst pomocy dla tego wpisu konfiguracji.
Parametry
| Nazwa | Typ | Opis |
helpText | String | Tekst pomocy do ustawienia. |
Powrót
Checkbox – ten kreator do łańcuchowania.
setId(id)
Ustawia unikalny identyfikator tego wpisu konfiguracji.
Parametry
| Nazwa | Typ | Opis |
id | String | Identyfikator do ustawienia. |
Powrót
Checkbox – ten kreator do łańcuchowania.
setIsDynamic(isDynamic)
Ustawia dynamiczny stan dla tego wpisu konfiguracji.
Jeśli wpis konfiguracji dynamicznej zostanie zmodyfikowany, kolejne wpisy konfiguracji zostaną wyczyszczone.
Parametry
| Nazwa | Typ | Opis |
isDynamic | Boolean | Stan dynamiczny do ustawienia. |
Powrót
Checkbox – ten kreator do łańcuchowania.
setName(name)
Ustawia wyświetlaną nazwę tego wpisu konfiguracji.
Parametry
| Nazwa | Typ | Opis |
name | String | Nazwa do ustawienia. |
Powrót
Checkbox – ten kreator do łańcuchowania.
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-26 UTC.
[null,null,["Ostatnia aktualizacja: 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."]]
