Class TextInput

Entrada detexto

Contém informações de entrada de texto para a configuração. As propriedades determinam como a entrada de texto é exibida no Data Studio.

const cc = DataStudioApp.createCommunityConnector();
const config = cc.getConfig();

const info1 = config.newTextInput()
                  .setId('info1')
                  .setName('Search')
                  .setHelpText('for example, Coldplay')
                  .setAllowOverride(true)
                  .setPlaceholder('Search for an artist for all songs.');

Métodos

MétodoTipo de retornoBreve descrição
setAllowOverride(allowOverride)TextInputPermite substituir esta entrada de configuração.
setHelpText(helpText)TextInputDefine o texto de ajuda para essa entrada de configuração.
setId(id)TextInputDefine o ID exclusivo para essa entrada de configuração.
setIsDynamic(isDynamic)TextInputDefine o status dinâmico para esta entrada de configuração.
setName(name)TextInputDefine o nome de exibição para essa entrada de configuração.
setPlaceholder(placeholder)TextInputDefine o texto do marcador de posição para esta 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

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

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

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

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

TextInput: este builder, para encadeamento.


setPlaceholder(placeholder)

Define o texto do marcador de posição para esta entrada de configuração.

Parâmetros

NomeTipoDescrição
placeholderStringO texto do marcador de posição a ser definido.

Retornar

TextInput: este builder, para encadeamento.