gapi. cloudsearch. widget. searchbox. Builder
Construtor de uma caixa de pesquisa. Use um builder e não chame diretamente o construtor da caixa de pesquisa.
Construtor
Builder
novo Builder()
Exemplo
// Builds a search box.
function onload() {
gapi.client.init({
'apiKey': '<your api key>',
'clientId': '<your client id>',
// Add additional scopes if needed
'scope': 'https://www.googleapis.com/auth/cloud_search.query',
'hosted_domain': '<your G Suite domain>',
});
const searchBox = new gapi.cloudsearch.widget.searchbox.Builder()
.setInput(document.getElementById('input'))
.setAnchor(document.getElementById('input').parentElement)
.build();
}
gapi.load('client:cloudsearch-widget', onload);
Métodos
formar
build() retorna SearchBox
- Retorna
-
non-null SearchBox
setAdapter
setAdapter(adapter) retorna o Builder
Obrigatório. Personalize a experiência de pesquisa do usuário com esse adaptador.
Parâmetro |
|
---|---|
adaptador |
É possível substituir parte dos métodos. O valor não pode ser nulo. |
- Retorna
-
non-null Builder
isso
Exemplo
const adapter = {
interceptSuggestRequest: function(request) {
// Change the request
}
}
builder.setAdapter(adapter).build();
setAnchor
setAnchor(anchor) retorna Builder
Obrigatório. Precisa ser um HTMLElement válido que possa conter nós filhos. Âncora da sobreposição de pesquisa. A sobreposição é adicionada como o último filho na âncora. A posição da sobreposição é a parte inferior da âncora.
Parâmetro |
|
---|---|
âncora |
HTMLElement O valor não pode ser nulo. |
- Descontinuado
- Use "setAnchorElement" em vez disso
- Retorna
-
non-null Builder
isso
setAnchorElement
setAnchorElement(anchorElement) retorna Builder
Obrigatório. Precisa ser um HTMLElement válido que possa conter nós filhos. Âncora da sobreposição de pesquisa. A sobreposição é adicionada como o último filho na âncora. A posição da sobreposição é a parte inferior da âncora.
Parâmetro |
|
---|---|
anchorElement |
HTMLElement O valor não pode ser nulo. |
- Retorna
-
non-null Builder
isso
setHints
setHints(hints) retorna Builder
Opcional: As dicas na caixa de pesquisa quando a entrada está vazia. Quando a entrada está vazia, uma dica aleatória é escolhida na matriz.
Parâmetro |
|
---|---|
dicas |
Matriz de strings O valor não pode ser nulo. |
- Retorna
-
non-null Builder
isso
setInput
setInput(input) retorna Builder
Obrigatório. Um HTMLElement que o usuário insere na consulta. Precisa ser <input> ou <textarea>
Parâmetro |
|
---|---|
entrada |
HTMLElement O valor não pode ser nulo. |
- Descontinuado
- Use "setInputElement" em vez disso
- Retorna
-
non-null Builder
isso
setInputElement
setInputElement(inputElement) retorna Builder
Obrigatório. Um HTMLElement que o usuário insere na consulta. Precisa ser <input> ou <textarea>
Parâmetro |
|
---|---|
inputElement |
HTMLElement O valor não pode ser nulo. |
- Retorna
-
non-null Builder
isso
setResultsContainer
setResultsContainer(resultsContainer) retorna Builder
Opcional: Contêiner para mostrar resultados da pesquisa. Se definido, os resultados vão ser renderizados no contêiner de resultados da pesquisa. Se ela não for definida, os resultados serão exibidos em cloudsearch.google.com.
Parâmetro |
|
---|---|
resultsContainer |
gapi.cloudsearch.widget.resultscontainer.ResultsContainer O valor não pode ser nulo. |
- Veja também
- ResultsContainer
- Retorna
-
non-null Builder
isso
setSearchApplicationId
setSearchApplicationId(searchApplicationId) retorna Builder
Opcional: Define o ID do aplicativo de pesquisa a ser usado para solicitações. Precisa ser prefixado com "searchapplications/".
Parâmetro |
|
---|---|
searchApplicationId |
string |
- Retorna
-
non-null Builder
isso
setThrottleInterval
setThrottleInterval(PodAutoscalerInterval) retorna o builder.
Opcional: O intervalo de limitação em ms na solicitação de disparo. A caixa de pesquisa envia menos de uma solicitação a cada milissegundos do LimiteInterval. Se LimitarInternal for menor que 200, a caixa de pesquisa vai ignorar o valor e usar 200 como intervalo.
Parâmetro |
|
---|---|
throttleInterval |
number |
- Retorna
-
non-null Builder
isso