Classe: Costruttore

gapi.cloudsearch.widget.searchbox.Builder

class   static

Generatore di una casella di ricerca. Utilizza un generatore e non chiamare direttamente il costruttore della casella di ricerca.

Costruttore

Builder

new Builder()

Esempio

// 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);

Metodi

build

build() restituisce SearchBox

Resi

non-null SearchBox 

setAdapter

setAdapter(adapter) restituisce Builder

Required. Personalizza l'esperienza di ricerca dell'utente con questo adattatore.

Parametro
adapter	SearchBoxAdapter Puoi sostituire parte dei metodi. Il valore non deve essere null.

Resi

non-null Builder questo

Esempio

const adapter = {
 interceptSuggestRequest: function(request) {
    // Change the request
  }
}

builder.setAdapter(adapter).build();

setAnchor

setAnchor(anchor) restituisce Builder

Required. Deve essere un HTMLElement valido che può contenere nodi figli. Ancora dell'overlay di ricerca. L'overlay viene aggiunto come ultimo elemento secondario nell'ancoraggio. La posizione dell'overlay è la parte inferiore dell'ancoraggio.

Parametro
anchor	HTMLElement Il valore non deve essere null.

Deprecato

Utilizza "setAnchorElement"

Resi

non-null Builder questo

setAnchorElement

setAnchorElement(anchorElement) restituisce Builder

Required. Deve essere un HTMLElement valido che può contenere nodi figli. Ancora dell'overlay di ricerca. L'overlay viene aggiunto come ultimo elemento secondario nell'ancoraggio. La posizione dell'overlay è la parte inferiore dell'ancoraggio.

Parametro
anchorElement	HTMLElement Il valore non deve essere null.

Resi

non-null Builder questo

setHints

setHints(hints) restituisce Builder

Facoltativo. I suggerimenti nella casella di ricerca quando l'input è vuoto. Quando l'input è vuoto, viene scelto un suggerimento casuale dall'array.

Parametro
suggerimenti	Array di stringhe Il valore non deve essere null.

Resi

non-null Builder questo

setInput

setInput(input) restituisce Builder

Required. Un HTMLElement in cui l'utente inserisce la query. Deve essere <input> o <textarea>

Parametro
input	HTMLElement Il valore non deve essere null.

Deprecato

Utilizza invece "setInputElement"

Resi

non-null Builder questo

setInputElement

setInputElement(inputElement) restituisce Builder

Required. Un HTMLElement in cui l'utente inserisce la query. Deve essere <input> o <textarea>

Parametro
inputElement	HTMLElement Il valore non deve essere null.

Resi

non-null Builder questo

setResultsContainer

setResultsContainer(resultsContainer) restituisce Builder

Facoltativo. Contenitore per la visualizzazione dei risultati di ricerca. Se impostato, i risultati vengono visualizzati nel contenitore dei risultati di ricerca. Se non è impostato, i risultati vengono visualizzati in cloudsearch.google.com.

Parametro
resultsContainer	gapi.cloudsearch.widget.resultscontainer.ResultsContainer Il valore non deve essere null.

Vedi anche

ResultsContainer

Resi

non-null Builder questo

setSearchApplicationId

setSearchApplicationId(searchApplicationId) restituisce Builder

Facoltativo. Imposta l'ID applicazione di ricerca da utilizzare per le richieste. Deve essere obbligatoriamente preceduto dal prefisso "searchapplications/".

Parametro
searchApplicationId	stringa

Resi

non-null Builder questo

setThrottleInterval

setThrottleInterval(throttleInterval) restituisce Builder

Facoltativo. L'intervallo di throttling in ms al momento dell'invio della richiesta. La casella di ricerca invia meno di una richiesta ogni millisecondi di throttleInterval. Se throttleInternal è inferiore a 200, la casella di ricerca ignora il valore e utilizza 200 come intervallo.

Parametro
throttleInterval	numero

Resi

non-null Builder questo