Class SelectSingle

SelectSingle

Contém informações de seleção única para a configuração. As propriedades determinam como a seleção única é mostrada no Data Studio.

const cc = DataStudioApp.createCommunityConnector();
const config = cc.getConfig();
const option1 =
    config.newOptionBuilder().setLabel('option label').setValue('option_value');

const option2 = config.newOptionBuilder()
                    .setLabel('second option label')
                    .setValue('option_value_2');

const info1 = config.newSelectSingle()
                  .setId('api_endpoint')
                  .setName('Data Type')
                  .setHelpText('Select the data type you\'re interested in.')
                  .setAllowOverride(true)
                  .addOption(option1)
                  .addOption(option2);

Métodos

MétodoTipo de retornoBreve descrição
addOption(optionBuilder)SelectSingleAdiciona uma nova opção de seleção.
setAllowOverride(allowOverride)SelectSinglePermite a substituição dessa entrada de configuração.
setHelpText(helpText)SelectSingleDefine o texto de ajuda para essa entrada de configuração.
setId(id)SelectSingleDefine o ID exclusivo para essa entrada de configuração.
setIsDynamic(isDynamic)SelectSingleDefine o status dinâmico para essa entrada de configuração.
setName(name)SelectSingleDefine o nome de exibição para essa entrada de configuração.

Documentação detalhada

addOption(optionBuilder)

Adiciona uma nova opção de seleção.

Parâmetros

NomeTipoDescrição
optionBuilderOptionBuilderUm builder para uma opção.

Retornar

SelectSingle — Este builder, para encadeamento.


setAllowOverride(allowOverride)

Permite a substituição dessa entrada de configuração. Se definido como true, os criadores da fonte de dados têm a opção de ativar esse recurso para editores de relatórios.

Parâmetros

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

Retornar

SelectSingle — Este builder, para encadeamento.


setHelpText(helpText)

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

Parâmetros

NomeTipoDescrição
helpTextStringO texto de ajuda a ser definido.

Retornar

SelectSingle — 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

SelectSingle — Este builder, para encadeamento.


setIsDynamic(isDynamic)

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

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

Parâmetros

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

Retornar

SelectSingle — 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

SelectSingle — Este builder, para encadeamento.