Class Checkbox

Caixa de seleção

Contém informações da caixa de seleção para a configuração. Suas propriedades determinam como essa caixa de seleção é exibida no 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 retornoBreve descrição
setAllowOverride(allowOverride)CheckboxAtiva a substituição dessa entrada de configuração.
setHelpText(helpText)CheckboxDefine o texto de ajuda para essa entrada de configuração.
setId(id)CheckboxDefine o ID exclusivo dessa entrada de configuração.
setIsDynamic(isDynamic)CheckboxDefine o status dinâmico dessa entrada de configuração.
setName(name)CheckboxDefine o nome de exibição desta entrada de configuração.

Documentação detalhada

setAllowOverride(allowOverride)

Ativa a substituição dessa entrada de configuração. Se definido como true, os criadores de fontes de dados terão a opção de ativar esse recurso para os editores de relatórios.

Parâmetros

NomeTipoDescrição
allowOverrideBooleanIndica se a entrada de configuração pode ou não ser substituída nos relatórios.

Retorno

Checkbox: este builder, para encadeamento.


setHelpText(helpText)

Define o texto de ajuda para essa entrada de configuração.

Parâmetros

NomeTipoDescrição
helpTextStringO helpText a ser definido.

Retorno

Checkbox: este builder, para encadeamento.


setId(id)

Define o ID exclusivo dessa entrada de configuração.

Parâmetros

NomeTipoDescrição
idStringO ID a ser definido.

Retorno

Checkbox: este builder, para encadeamento.


setIsDynamic(isDynamic)

Define o status dinâmico dessa entrada de configuração.

Se uma entrada de configuração dinâmica for modificada, as entradas de configuração subsequentes serão apagadas.

Parâmetros

NomeTipoDescrição
isDynamicBooleanO status dinâmico a ser definido.

Retorno

Checkbox: este builder, para encadeamento.


setName(name)

Define o nome de exibição desta entrada de configuração.

Parâmetros

NomeTipoDescrição
nameStringNome a ser definido.

Retorno

Checkbox: este builder, para encadeamento.