Class SelectSingle

SelectSingle

Contains select single information for the config. Its properties determine how the select single is displayed in Data Studio.

var option1 = config.newOptionBuilder()
  .setLabel("option label")
  .setValue("option_value");

var option2 = config.newOptionBuilder()
  .setLabel("second option label")
  .setValue("option_value_2");

var info1 = config.newSelectSingle()
  .setId("api_endpoint")
  .setName("Data Type")
  .setHelpText("Select the data type you're interested in.")
  .setAllowOverride(true)
  .addOption(option1)
  .addOption(option2);

Methods

MethodReturn typeBrief description
addOption(optionBuilder)SelectSingleAdds a new select option.
setAllowOverride(allowOverride)SelectSingleEnables overriding for this config entry.
setHelpText(helpText)SelectSingleSets the help text for this configuration entry.
setId(id)SelectSingleSets the unique ID for this configuration entry.
setName(name)SelectSingleSets the display name for this configuration entry.

Detailed documentation

addOption(optionBuilder)

Adds a new select option.

Parameters

NameTypeDescription
optionBuilderOptionBuilderA 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

NameTypeDescription
allowOverrideBooleanWhether 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

NameTypeDescription
helpTextStringThe helpText to set.

Return

SelectSingle — This builder, for chaining.


setId(id)

Sets the unique ID for this configuration entry.

Parameters

NameTypeDescription
idStringThe ID to set.

Return

SelectSingle — This builder, for chaining.


setName(name)

Sets the display name for this configuration entry.

Parameters

NameTypeDescription
nameStringThe name to set.

Return

SelectSingle — This builder, for chaining.

Envoyer des commentaires concernant…

Besoin d'aide ? Consultez notre page d'assistance.