Class SelectMultiple
Stay organized with collections
Save and categorize content based on your preferences.
SelectMultiple
Contains select multiple information for the config. Its properties determine how the select
multiple is displayed in Data Studio.
Usage:
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.newSelectMultiple()
.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
SelectMultiple — 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
SelectMultiple — This builder, for chaining.
setHelpText(helpText)
Sets the help text for this configuration entry.
Parameters
| Name | Type | Description |
helpText | String | The help text to set. |
Return
SelectMultiple — 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
SelectMultiple — 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
SelectMultiple — 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
SelectMultiple — 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\u003eSelectMultiple\u003c/code\u003e defines how a multi-select dropdown appears in Data Studio, allowing users to choose multiple options from a list.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use methods 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 to customize the select multiple element.\u003c/p\u003e\n"],["\u003cp\u003eEach option in the select multiple is built using \u003ccode\u003eOptionBuilder\u003c/code\u003e to set labels and values.\u003c/p\u003e\n"],["\u003cp\u003eConfiguration options like allowing overrides, providing help text, and setting a dynamic status further refine the behavior of the select multiple element.\u003c/p\u003e\n"]]],["The `SelectMultiple` config allows defining how multiple selections are displayed in Data Studio. Key actions include: adding options using `addOption()`, setting override permissions with `setAllowOverride()`, providing help text via `setHelpText()`, and establishing a unique ID with `setId()`. You can control the dynamic behavior using `setIsDynamic()`. Furthermore, the display name is set by `setName()`, all allowing chaining. This is exemplified by the creation of a new multiple select config with two options in the code.\n"],null,["# Class SelectMultiple\n\nSelectMultiple\n\nContains select multiple information for the config. Its properties determine how the select\nmultiple is displayed in Data Studio.\n\nUsage:\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.newSelectMultiple()\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)) | [SelectMultiple](#) | Adds a new select option. |\n| [setAllowOverride(allowOverride)](#setAllowOverride(Boolean)) | [SelectMultiple](#) | Enables overriding for this config entry. |\n| [setHelpText(helpText)](#setHelpText(String)) | [SelectMultiple](#) | Sets the help text for this configuration entry. |\n| [setId(id)](#setId(String)) | [SelectMultiple](#) | Sets the unique ID for this configuration entry. |\n| [setIsDynamic(isDynamic)](#setIsDynamic(Boolean)) | [SelectMultiple](#) | Sets the dynamic status for this configuration entry. |\n| [setName(name)](#setName(String)) | [SelectMultiple](#) | 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[SelectMultiple](#) --- 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[SelectMultiple](#) --- 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 help text to set. |\n\n#### Return\n\n\n[SelectMultiple](#) --- 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[SelectMultiple](#) --- 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[SelectMultiple](#) --- 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[SelectMultiple](#) --- This builder, for chaining."]]
