Class TextInput

Saisie de texte

Contient des informations sur la saisie de texte pour la configuration. Ses propriétés déterminent la façon dont la saisie de texte est affichée 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)TextInputActive le forçage pour 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 de cette entrée de configuration.
setIsDynamic(isDynamic)TextInputDéfinit l'état dynamique de 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)

Active le forçage pour cette entrée de configuration. Si la valeur est true, les créateurs de sources de données peuvent l'activer pour les éditeurs de rapports.

Paramètres

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

Renvois

TextInput : ce générateur, pour le chaînage.


setHelpText(helpText)

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

Paramètres

NomTypeDescription
helpTextStringTexte d'aide à définir.

Renvois

TextInput : ce générateur, pour le chaînage.


setId(id)

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

Paramètres

NomTypeDescription
idStringID à définir.

Renvois

TextInput : ce générateur, pour le chaînage.


setIsDynamic(isDynamic)

Définit l'état dynamique de 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
isDynamicBooleanÉtat dynamique à définir.

Renvois

TextInput : ce générateur, pour le chaînage.


setName(name)

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

Paramètres

NomTypeDescription
nameStringNom à définir.

Renvois

TextInput : ce générateur, pour le chaînage.


setPlaceholder(placeholder)

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

Paramètres

NomTypeDescription
placeholderStringTexte de l'espace réservé à définir.

Renvois

TextInput : ce générateur, pour le chaînage.