Class SelectMultiple

AI-generated Key Takeaways

• SelectMultiple defines how a multi-select dropdown appears in Data Studio, allowing users to choose multiple options from a list.

• Developers can use methods like addOption, setAllowOverride, setHelpText, setId, setIsDynamic, and setName to customize the select multiple element.

• Each option in the select multiple is built using OptionBuilder to set labels and values.

• Configuration options like allowing overrides, providing help text, and setting a dynamic status further refine the behavior of the select multiple element.

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);

Methods

Method	Return type	Brief description
addOption(optionBuilder)	SelectMultiple	Adds a new select option.
setAllowOverride(allowOverride)	SelectMultiple	Enables overriding for this config entry.
setHelpText(helpText)	SelectMultiple	Sets the help text for this configuration entry.
setId(id)	SelectMultiple	Sets the unique ID for this configuration entry.
setIsDynamic(isDynamic)	SelectMultiple	Sets the dynamic status for this configuration entry.
setName(name)	SelectMultiple	Sets the display name for this configuration entry.

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.