Class OptionBuilder
Stay organized with collections
Save and categorize content based on your preferences.
AI-generated Key Takeaways
-
OptionBuilderfacilitates the creation of options forSelectSingleandSelectMultipleelements in Data Studio. -
It provides methods like
setLabelandsetValueto define the display text and underlying value of each option. -
These options are then added to
SelectSingleorSelectMultiplecomponents for user interaction within a Data Studio connector. -
Using
OptionBuildersimplifies the process of creating interactive dropdown menus in your custom connectors.
A builder for creating options for Selects and Selects.
constcc=DataStudioApp.createCommunityConnector(); constconfig=cc.getConfig(); constoption1= config.newOptionBuilder().setLabel('option label').setValue('option_value'); constoption2=config.newOptionBuilder() .setLabel('second option label') .setValue('option_value_2'); constinfo1=config.newSelectSingle() .setId('api_endpoint') .setName('Data Type') .setHelpText('Select the data type you\'re interested in.') .addOption(option1) .addOption(option2);
Methods
| Method | Return type | Brief description |
|---|---|---|
set | Option | Sets the label of this option builder. |
set | Option | Sets the value of this option builder. |
Detailed documentation
setLabel(label)
Sets the label of this option builder. Labels are the text that the user sees when selecting one or more options from the dropdown.
Parameters
| Name | Type | Description |
|---|---|---|
label | String | The label to set. |
Return
Option — This builder, for chaining.
setValue(value)
Sets the value of this option builder. Values are what is passed to the code when a user selects one or more options from the dropdown.
Parameters
| Name | Type | Description |
|---|---|---|
value | String | The value to set. |
Return
Option — This builder, for chaining.