Class SelectMultiple
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
SélectionnerPlusieurs
Contient plusieurs informations sélectionnées pour la configuration. Ses propriétés déterminent la façon dont la sélection multiple s'affiche dans Data Studio.
Utilisation :
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);
Documentation détaillée
addOption(optionBuilder)
Ajoute une nouvelle option de sélection.
Paramètres
| Nom | Type | Description |
optionBuilder | OptionBuilder | Compilateur d'une option. |
Renvois
SelectMultiple : ce générateur, pour le chaînage.
setAllowOverride(allowOverride)
Active le forçage pour cette entrée de configuration. Si la valeur est true, les créateurs de sources de données peuvent l'activer pour les éditeurs de rapports.
Paramètres
| Nom | Type | Description |
allowOverride | Boolean | Indique si cette entrée de configuration peut être ignorée dans les rapports. |
Renvois
SelectMultiple : ce générateur, pour le chaînage.
setHelpText(helpText)
Définit le texte d'aide pour cette entrée de configuration.
Paramètres
| Nom | Type | Description |
helpText | String | Texte d'aide à définir. |
Renvois
SelectMultiple : ce générateur, pour le chaînage.
setId(id)
Définit l'ID unique de cette entrée de configuration.
Paramètres
| Nom | Type | Description |
id | String | ID à définir. |
Renvois
SelectMultiple : ce générateur, pour le chaînage.
setIsDynamic(isDynamic)
Définit l'état dynamique de cette entrée de configuration.
Si une entrée de configuration dynamique est modifiée, les entrées de configuration suivantes sont effacées.
Paramètres
| Nom | Type | Description |
isDynamic | Boolean | État dynamique à définir. |
Renvois
SelectMultiple : ce générateur, pour le chaînage.
setName(name)
Définit le nom à afficher pour cette entrée de configuration.
Paramètres
| Nom | Type | Description |
name | String | Nom à définir. |
Renvois
SelectMultiple : ce générateur, pour le chaînage.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/26 (UTC).
[null,null,["Dernière mise à jour le 2025/07/26 (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."]]
