Class TextInput

TextInput

Contient des informations de saisie de texte pour la configuration. Ses propriétés déterminent la façon dont la saisie de texte s'affiche dans Data Studio.

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

const info1 = config.newTextInput()
                  .setId('info1')
                  .setName('Search')
                  .setHelpText('for example, Coldplay')
                  .setAllowOverride(true)
                  .setPlaceholder('Search for an artist for all songs.');

Méthodes

MéthodeType renvoyéBrève description
setAllowOverride(allowOverride)TextInputPermet de remplacer cette entrée de configuration.
setHelpText(helpText)TextInputDéfinit le texte d'aide pour cette entrée de configuration.
setId(id)TextInputDéfinit l'ID unique pour cette entrée de configuration.
setIsDynamic(isDynamic)TextInputDéfinit l'état dynamique pour cette entrée de configuration.
setName(name)TextInputDéfinit le nom à afficher pour cette entrée de configuration.
setPlaceholder(placeholder)TextInputDéfinit le texte d'espace réservé pour cette entrée de configuration.

Documentation détaillée

setAllowOverride(allowOverride)

Permet de remplacer cette entrée de configuration. Si la valeur est définie sur true, les créateurs de sources de données peuvent activer cette option pour les éditeurs de rapports.

Paramètres

NomTypeDescription
allowOverrideBooleanIndique si cette entrée de configuration peut être remplacée ou non dans les rapports.

Renvois

TextInput : ce compilateur, pour le chaînage.


setHelpText(helpText)

Définit le texte d'aide pour cette entrée de configuration.

Paramètres

NomTypeDescription
helpTextStringLe texte d'aide à définir.

Renvois

TextInput : ce compilateur, pour le chaînage.


setId(id)

Définit l'ID unique pour cette entrée de configuration.

Paramètres

NomTypeDescription
idStringL'ID à définir.

Renvois

TextInput : ce compilateur, pour le chaînage.


setIsDynamic(isDynamic)

Définit l'état dynamique pour cette entrée de configuration.

Si une entrée de configuration dynamique est modifiée, les entrées de configuration suivantes sont effacées.

Paramètres

NomTypeDescription
isDynamicBooleanL'état dynamique à définir.

Renvois

TextInput : ce compilateur, pour le chaînage.


setName(name)

Définit le nom à afficher pour cette entrée de configuration.

Paramètres

NomTypeDescription
nameStringLe nom à définir.

Renvois

TextInput : ce compilateur, pour le chaînage.


setPlaceholder(placeholder)

Définit le texte d'espace réservé pour cette entrée de configuration.

Paramètres

NomTypeDescription
placeholderStringLe texte d'espace réservé à définir.

Renvois

TextInput : ce compilateur, pour le chaînage.