Class Checkbox

Caixa de seleção

Contém informações de caixa de seleção para a configuração. As propriedades determinam como a caixa de seleção é exibida no 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étodos

MétodoTipo de retornoBreve descrição
setAllowOverride(allowOverride)CheckboxPermite substituir esta entrada de configuração.
setHelpText(helpText)CheckboxDefine o texto de ajuda para essa entrada de configuração.
setId(id)CheckboxDefine o ID exclusivo para essa entrada de configuração.
setIsDynamic(isDynamic)CheckboxDefine o status dinâmico para esta entrada de configuração.
setName(name)CheckboxDefine o nome de exibição para essa entrada de configuração.

Documentação detalhada

setAllowOverride(allowOverride)

Permite substituir esta entrada de configuração. Quando definido como true, os criadores de fontes de dados têm a opção de ativar esse recurso para os editores de relatórios.

Parâmetros

NomeTipoDescrição
allowOverrideBooleanSe essa entrada de configuração pode ser substituída nos relatórios.

Retornar

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.

Retornar

Checkbox: este builder, para encadeamento.


setId(id)

Define o ID exclusivo para essa entrada de configuração.

Parâmetros

NomeTipoDescrição
idStringO ID a ser definido.

Retornar

Checkbox: este builder, para encadeamento.


setIsDynamic(isDynamic)

Define o status dinâmico para esta 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.

Retornar

Checkbox: este builder, para encadeamento.


setName(name)

Define o nome de exibição para essa entrada de configuração.

Parâmetros

NomeTipoDescrição
nameStringO nome a ser definido.

Retornar

Checkbox: este builder, para encadeamento.