Class Checkbox

Checkbox

Contiene información de la casilla de verificación para la configuración. Sus propiedades determinan cómo se muestra la casilla de verificación en Data Studio.

var checkbox = config.newCheckbox()
  .setId("use_https")
  .setName("Use Https?")
  .setHelpText("Whether or not https should be used.")
  .setAllowOverride(true);

Métodos

MétodoTipo de datos que se muestraDescripción breve
setAllowOverride(allowOverride)CheckboxHabilita la anulación para esta entrada de configuración.
setHelpText(helpText)CheckboxEstablece el texto de ayuda para esta entrada de configuración.
setId(id)CheckboxEstablece el ID único para esta entrada de configuración.
setIsDynamic(isDynamic)CheckboxEstablece el estado dinámico para esta entrada de configuración.
setName(name)CheckboxEstablece el nombre visible de esta entrada de configuración.

Documentación detallada

setAllowOverride(allowOverride)

Habilita la anulación para esta entrada de configuración. Si se configura como true, los creadores de fuentes de datos tienen la opción de habilitar esta opción para los editores de informes.

Parámetros

NombreTipoDescripción
allowOverrideBooleanIndica si se puede anular o no esta entrada de configuración en los informes.

Devolvedor

Checkbox: Este compilador se usa para encadenar.


setHelpText(helpText)

Establece el texto de ayuda para esta entrada de configuración.

Parámetros

NombreTipoDescripción
helpTextStringEl helpText que se establecerá.

Devolvedor

Checkbox: Este compilador se usa para encadenar.


setId(id)

Establece el ID único para esta entrada de configuración.

Parámetros

NombreTipoDescripción
idStringEl ID que se establecerá.

Devolvedor

Checkbox: Este compilador se usa para encadenar.


setIsDynamic(isDynamic)

Establece el estado dinámico para esta entrada de configuración.

Si se modifica una entrada de configuración dinámica, se borran las entradas de configuración posteriores.

Parámetros

NombreTipoDescripción
isDynamicBooleanEl estado dinámico que se establecerá.

Devolvedor

Checkbox: Este compilador se usa para encadenar.


setName(name)

Establece el nombre visible de esta entrada de configuración.

Parámetros

NombreTipoDescripción
nameStringEl nombre que se establecerá.

Devolvedor

Checkbox: Este compilador se usa para encadenar.