AI-generated Key Takeaways
-
Checkbox contains configuration information determining how it's displayed in Data Studio.
-
Methods available for Checkbox include setting allow override, help text, ID, dynamic status, and name.
-
Each method returns the Checkbox builder for chaining.
Contains checkbox information for the config. Its properties determine how the checkbox is displayed in 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 );
Methods
| Method | Return type | Brief description |
|---|---|---|
Checkbox
|
Enables overriding for this config entry. | |
Checkbox
|
Sets the help text for this configuration entry. | |
Checkbox
|
Sets the unique ID for this configuration entry. | |
Checkbox
|
Sets the dynamic status for this configuration entry. | |
Checkbox
|
Sets the display name for this configuration entry. |
Detailed documentation
set
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 |
|---|---|---|
allow
|
Boolean
|
Whether or not this config entry can be overridden in reports. |
Return
Checkbox
— This builder, for chaining.
set
Sets the help text for this configuration entry.
Parameters
| Name | Type | Description |
|---|---|---|
help
|
String
|
The helpText to set. |
Return
Checkbox
— This builder, for chaining.
set
Sets the unique ID for this configuration entry.
Parameters
| Name | Type | Description |
|---|---|---|
id
|
String
|
The ID to set. |
Return
Checkbox
— This builder, for chaining.
set
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
Checkbox
— This builder, for chaining.
set
Sets the display name for this configuration entry.
Parameters
| Name | Type | Description |
|---|---|---|
name
|
String
|
The name to set. |
Return
Checkbox
— This builder, for chaining.
