Class Checkbox

AI-generated Key Takeaways

• The Checkbox object configures checkbox properties for display in Data Studio.

• Key properties include ID, name, help text, and override settings, all set using designated methods.

• Methods like setAllowOverride, setHelpText, setId, setIsDynamic, and setName allow customization of the checkbox's functionality and appearance.

• Each method takes specific parameters, like allowOverride (boolean), helpText (string), and id (string), to define the checkbox's behavior and presentation.

• All Checkbox methods return the Checkbox object itself, enabling chained method calls for efficient configuration.

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

Method	Return type	Brief description
setAllowOverride(allowOverride)	Checkbox	Enables overriding for this config entry.
setHelpText(helpText)	Checkbox	Sets the help text for this configuration entry.
setId(id)	Checkbox	Sets the unique ID for this configuration entry.
setIsDynamic(isDynamic)	Checkbox	Sets the dynamic status for this configuration entry.
setName(name)	Checkbox	Sets 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

Name	Type	Description
allowOverride	Boolean	Whether 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

Name	Type	Description
helpText	String	The helpText to set.

Return

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

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

Name	Type	Description
isDynamic	Boolean	The dynamic status to set.

Return

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

Checkbox — This builder, for chaining.