Contém informações da área de texto para a configuração. As propriedades dela determinam como a entrada de texto é mostrada no Data Studio.
Uso:
const cc = DataStudioApp.createCommunityConnector(); const config = cc.getConfig(); const textArea1 = config.newTextArea() .setId('textArea1') .setName('Search') .setHelpText('for example, Coldplay') .setAllowOverride(true) .setPlaceholder('Search for an artist for all songs.');
Métodos
| Método | Tipo de retorno | Breve descrição |
|---|---|---|
set | Text | Permite modificar essa entrada de configuração. |
set | Text | Define o texto de ajuda para essa entrada de configuração. |
set | Text | Define o ID exclusivo para essa entrada de configuração. |
set | Text | Define o status dinâmico para essa entrada de configuração. |
set | Text | Define o nome de exibição para essa entrada de configuração. |
set | Text | Define o texto do marcador de posição para essa entrada de configuração. |
Documentação detalhada
setAllowOverride(allowOverride)
Permite modificar essa entrada de configuração. Quando definido como true, os criadores da fonte de dados têm a opção de ativar esse recurso para os editores de relatórios.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
allow | Boolean | Indica se essa entrada de configuração pode ser modificada nos relatórios. |
Retornar
TextArea — esse builder, para encadeamento.
setHelpText(helpText)
Define o texto de ajuda para essa entrada de configuração.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
help | String | O texto de ajuda a ser definido. |
Retornar
TextArea — esse builder, para encadeamento.
setId(id)
Define o ID exclusivo para essa entrada de configuração.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
id | String | O ID a ser definido. |
Retornar
TextArea — esse 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
| Nome | Tipo | Descrição |
|---|---|---|
is | Boolean | O status dinâmico a ser definido. |
Retornar
TextArea — esse builder, para encadeamento.
setName(name)
Define o nome de exibição para essa entrada de configuração.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
name | String | O nome a ser definido. |
Retornar
TextArea — esse builder, para encadeamento.
setPlaceholder(placeholder)
Define o texto do marcador de posição para essa entrada de configuração.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
placeholder | String | O texto do marcador de posição a ser definido. |
Retornar
TextArea — esse builder, para encadeamento.