gapi. cloudsearch. widget. searchbox. Builder
Costruttore di una casella di ricerca. Utilizza uno strumento per la creazione 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
- Ritorni
-
non-null SearchBox
setAdapter
setAdapter(adapter) restituisce Builder
Obbligatorio. Personalizza l'esperienza di ricerca dell'utente con questo adattatore.
Parametro |
|
---|---|
adattatore |
Puoi eseguire l'override di parte dei metodi. Il valore non deve essere nullo. |
- Ritorni
-
non-null Builder
questo
Esempio
const adapter = {
interceptSuggestRequest: function(request) {
// Change the request
}
}
builder.setAdapter(adapter).build();
setAnchor
setAnchor(anchor) restituisce Builder
Obbligatorio. Deve essere un elemento HTMLElement valido che può contenere nodi figlio. Ancoraggio dell'overlay di ricerca. L'overlay viene aggiunto come ultimo elemento secondario dell'ancoraggio. La posizione dell'overlay è la parte inferiore dell'ancoraggio.
Parametro |
|
---|---|
anchor |
HTMLElement Il valore non deve essere nullo. |
- Deprecata
- Usa invece "setAnchorElement"
- Ritorni
-
non-null Builder
questo
setAnchorElement
setAnchorElement(anchorElement) restituisce Builder
Obbligatorio. Deve essere un elemento HTMLElement valido che può contenere nodi figlio. Ancoraggio dell'overlay di ricerca. L'overlay viene aggiunto come ultimo elemento secondario dell'ancoraggio. La posizione dell'overlay è la parte inferiore dell'ancoraggio.
Parametro |
|
---|---|
anchorElement |
HTMLElement Il valore non deve essere nullo. |
- Ritorni
-
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 stringa Il valore non deve essere nullo. |
- Ritorni
-
non-null Builder
questo
setInput
setInput(input) restituisce Builder
Obbligatorio. Un elemento HTMLElement che l'utente inserisce nella query. Deve essere <input> o <textarea>
Parametro |
|
---|---|
input |
HTMLElement Il valore non deve essere nullo. |
- Deprecata
- Usa invece "setInputElement"
- Ritorni
-
non-null Builder
questo
setInputElement
setInputElement(inputElement) restituisce Builder
Obbligatorio. Un elemento HTMLElement che l'utente inserisce nella query. Deve essere <input> o <textarea>
Parametro |
|
---|---|
inputElement |
HTMLElement Il valore non deve essere nullo. |
- Ritorni
-
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 viene configurato, i risultati vengono mostrati in cloudsearch.google.com.
Parametro |
|
---|---|
resultsContainer |
gapi.cloudsearch.widget.resultscontainer.ResultsContainer Il valore non deve essere nullo. |
- Vedi anche
- ResultsContainer
- Ritorni
-
non-null Builder
questo
setSearchApplicationId
setSearchApplicationId(searchApplicationId) restituisce Builder
(Facoltativo) Imposta l'ID dell'applicazione di ricerca da utilizzare per le richieste. Deve essere preceduto dal prefisso "searchapplications/".
Parametro |
|
---|---|
searchApplicationId |
stringa |
- Ritorni
-
non-null Builder
questo
setThrottleInterval
setThrottleRange(throttleIntervallo) restituisce Builder
(Facoltativo) Intervallo di limitazione in ms alla richiesta di attivazione. La casella di ricerca invia meno di una richiesta ogni throttleIntervallo millisecondi. Se throttleInternal è inferiore a 200, la casella di ricerca ignora il valore e utilizza invece 200 come intervallo.
Parametro |
|
---|---|
throttleInterval |
numero |
- Ritorni
-
non-null Builder
questo