Class TextArea

TextArea

Contains text area information for the config. Its properties determine how the text input is displayed in Data Studio.

Usage:

var cc = DataStudioApp.createCommunityConnector();
var config = cc.getConfig();

var textArea1 = config.newTextArea()
  .setId("textArea1")
  .setName("Search")
  .setHelpText("for example, Coldplay")
  .setAllowOverride(true)
  .setPlaceholder("Search for an artist for all songs.");

Methods

MethodReturn typeBrief description
setAllowOverride(allowOverride)TextAreaEnables overriding for this config entry.
setHelpText(helpText)TextAreaSets the help text for this configuration entry.
setId(id)TextAreaSets the unique ID for this configuration entry.
setName(name)TextAreaSets the display name for this configuration entry.
setPlaceholder(placeholder)TextAreaSets the placeholder text 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

TextArea — This builder, for chaining.


setHelpText(helpText)

Sets the help text for this configuration entry.

Parameters

NameTypeDescription
helpTextStringThe helpText to set.

Return

TextArea — This builder, for chaining.


setId(id)

Sets the unique ID for this configuration entry.

Parameters

NameTypeDescription
idStringThe ID to set.

Return

TextArea — This builder, for chaining.


setName(name)

Sets the display name for this configuration entry.

Parameters

NameTypeDescription
nameStringThe name to set.

Return

TextArea — This builder, for chaining.


setPlaceholder(placeholder)

Sets the placeholder text for this configuration entry.

Parameters

NameTypeDescription
placeholderStringThe placeholder text to set.

Return

TextArea — This builder, for chaining.

Send feedback about...

Apps Script
Apps Script
Need help? Visit our support page.