Class Checkbox

Case à cocher

Contient des informations sur les cases à cocher pour la configuration. Ses propriétés déterminent la façon dont la case à cocher s'affiche dans 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);

Méthodes

MéthodeType renvoyéBrève description
setAllowOverride(allowOverride)CheckboxActive le forçage pour cette entrée de configuration.
setHelpText(helpText)CheckboxDéfinit le texte d'aide pour cette entrée de configuration.
setId(id)CheckboxDéfinit l'ID unique de cette entrée de configuration.
setIsDynamic(isDynamic)CheckboxDéfinit l'état dynamique de cette entrée de configuration.
setName(name)CheckboxDéfinit le nom à afficher 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

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

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

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

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

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