Class SelectSingle
Stay organized with collections
Save and categorize content based on your preferences.
SelectSingle
Contains select single information for the config. Its properties determine how the select single
is displayed in Data Studio.
const cc = DataStudioApp.createCommunityConnector();
const config = cc.getConfig();
const option1 =
config.newOptionBuilder().setLabel('option label').setValue('option_value');
const option2 = config.newOptionBuilder()
.setLabel('second option label')
.setValue('option_value_2');
const info1 = config.newSelectSingle()
.setId('api_endpoint')
.setName('Data Type')
.setHelpText('Select the data type you\'re interested in.')
.setAllowOverride(true)
.addOption(option1)
.addOption(option2);
Detailed documentation
addOption(optionBuilder)
Adds a new select option.
Parameters
| Name | Type | Description |
optionBuilder | OptionBuilder | A builder for an option. |
Return
SelectSingle — This builder, for chaining.
setAllowOverride(allowOverride)
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 |
allowOverride | Boolean | Whether or not this config entry can be overridden in reports. |
Return
SelectSingle — This builder, for chaining.
setHelpText(helpText)
Sets the help text for this configuration entry.
Parameters
| Name | Type | Description |
helpText | String | The helpText to set. |
Return
SelectSingle — 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
SelectSingle — 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 |
isDynamic | Boolean | The dynamic status to set. |
Return
SelectSingle — 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
SelectSingle — This builder, for chaining.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["\u003cp\u003e\u003ccode\u003eSelectSingle\u003c/code\u003e defines how a single-select dropdown menu appears and functions within a Data Studio configuration.\u003c/p\u003e\n"],["\u003cp\u003eIt allows developers to specify options, help text, and behavior such as allowing users to override the selection.\u003c/p\u003e\n"],["\u003cp\u003eMethods like \u003ccode\u003eaddOption\u003c/code\u003e, \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 are used to configure the dropdown's attributes and functionality.\u003c/p\u003e\n"],["\u003cp\u003eEach method returns the \u003ccode\u003eSelectSingle\u003c/code\u003e object itself, enabling chained method calls for streamlined configuration.\u003c/p\u003e\n"]]],["`SelectSingle` configures how a single selection is displayed in Data Studio. Key actions include adding options via `addOption`, enabling overrides with `setAllowOverride`, setting help text via `setHelpText`, defining a unique `id` with `setId`, specifying dynamic status using `setIsDynamic`, and setting the display `name` with `setName`. Each method returns the `SelectSingle` builder, enabling method chaining. This config determines the available choices and how users interact with the select field in Data Studio.\n"],null,["# Class SelectSingle\n\nSelectSingle\n\nContains select single information for the config. Its properties determine how the select single\nis displayed in Data Studio.\n\n```javascript\nconst cc = DataStudioApp.createCommunityConnector();\nconst config = cc.getConfig();\nconst option1 =\n config.newOptionBuilder().setLabel('option label').setValue('option_value');\n\nconst option2 = config.newOptionBuilder()\n .setLabel('second option label')\n .setValue('option_value_2');\n\nconst info1 = config.newSelectSingle()\n .setId('api_endpoint')\n .setName('Data Type')\n .setHelpText('Select the data type you\\'re interested in.')\n .setAllowOverride(true)\n .addOption(option1)\n .addOption(option2);\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|---------------------------------------------------------------|-------------------|-------------------------------------------------------|\n| [addOption(optionBuilder)](#addOption(OptionBuilder)) | [SelectSingle](#) | Adds a new select option. |\n| [setAllowOverride(allowOverride)](#setAllowOverride(Boolean)) | [SelectSingle](#) | Enables overriding for this config entry. |\n| [setHelpText(helpText)](#setHelpText(String)) | [SelectSingle](#) | Sets the help text for this configuration entry. |\n| [setId(id)](#setId(String)) | [SelectSingle](#) | Sets the unique ID for this configuration entry. |\n| [setIsDynamic(isDynamic)](#setIsDynamic(Boolean)) | [SelectSingle](#) | Sets the dynamic status for this configuration entry. |\n| [setName(name)](#setName(String)) | [SelectSingle](#) | Sets the display name for this configuration entry. |\n\nDetailed documentation\n----------------------\n\n### `add``Option(optionBuilder)`\n\nAdds a new select option.\n\n#### Parameters\n\n| Name | Type | Description |\n|-------------------|--------------------------------------------------------------------|--------------------------|\n| `option``Builder` | [OptionBuilder](/apps-script/reference/data-studio/option-builder) | A builder for an option. |\n\n#### Return\n\n\n[SelectSingle](#) --- This builder, for chaining.\n\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[SelectSingle](#) --- 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[SelectSingle](#) --- 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[SelectSingle](#) --- 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[SelectSingle](#) --- 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[SelectSingle](#) --- This builder, for chaining."]]
