Class Checkbox

  • Checkbox contains configuration information determining how it's displayed in Data Studio.

  • Methods available for Checkbox include setting allow override, help text, ID, dynamic status, and name.

  • Each method returns the Checkbox builder for chaining.
Checkbox

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

const config = DataStudioApp.createCommunityConnector().getConfig();
const checkbox = config.newCheckbox()
                     .setId('use_https')
                     .setName('Use Https?')
                     .setHelpText('Whether or not https should be used.')
                     .setAllowOverride(true);

Methods

MethodReturn typeBrief description
setAllowOverride(allowOverride)CheckboxEnables overriding for this config entry.
setHelpText(helpText)CheckboxSets the help text for this configuration entry.
setId(id)CheckboxSets the unique ID for this configuration entry.
setIsDynamic(isDynamic)CheckboxSets the dynamic status for this configuration entry.
setName(name)CheckboxSets the display name for this configuration entry.

Detailed documentation

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

Checkbox — This builder, for chaining.

setHelpText(helpText)

Sets the help text for this configuration entry.

Parameters

NameTypeDescription
helpTextStringThe helpText to set.

Return

Checkbox — This builder, for chaining.

setId(id)

Sets the unique ID for this configuration entry.

Parameters

NameTypeDescription
idStringThe ID to set.

Return

Checkbox — 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

NameTypeDescription
isDynamicBooleanThe dynamic status to set.

Return

Checkbox — This builder, for chaining.

setName(name)

Sets the display name for this configuration entry.

Parameters

NameTypeDescription
nameStringThe name to set.

Return

Checkbox — This builder, for chaining.