gapi. cloudsearch. widget. searchbox. Builder
Compilateur d'un champ de recherche. Utilisez un compilateur et n'appelez pas directement le constructeur de champ de recherche.
Constructeur
Builder
new Builder()
Exemple
// 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éthodes
build
build() renvoie SearchBox
- Renvoie
-
non-null SearchBox
setAdapter
setAdapter(adapter) renvoie Builder
Obligatoire : Personnalisez l'expérience de recherche de l'utilisateur grâce à cet adaptateur.
Paramètres |
|
---|---|
adaptateur |
Vous pouvez ignorer une partie des méthodes. La valeur ne doit pas être nulle. |
- Renvoie
-
non-null Builder
ceci
Exemple
const adapter = {
interceptSuggestRequest: function(request) {
// Change the request
}
}
builder.setAdapter(adapter).build();
setAnchor
setAnchor(anchor) returns Builder
Obligatoire : Doit être un HTMLElement valide pouvant contenir des nœuds enfants. Ancrage de la superposition de recherche. La superposition est ajoutée en tant que dernier élément enfant de l'ancrage. La position de la superposition correspond au bas de l'ancre.
Paramètres |
|
---|---|
anchor |
HTMLElement La valeur ne doit pas être nulle. |
- Obsolète
- Utilisez plutôt "setAnchorElement"
- Renvoie
-
non-null Builder
ceci
setAnchorElement
setAnchorElement(anchorElement) renvoie Builder
Obligatoire : Doit être un HTMLElement valide pouvant contenir des nœuds enfants. Ancrage de la superposition de recherche. La superposition est ajoutée en tant que dernier élément enfant de l'ancrage. La position de la superposition correspond au bas de l'ancre.
Paramètres |
|
---|---|
anchorElement |
HTMLElement La valeur ne doit pas être nulle. |
- Renvoie
-
non-null Builder
ceci
setHints
setHints(hints) renvoie Builder
Facultatif. Suggestions dans le champ de recherche lorsque le champ de recherche n'est pas renseigné. Lorsque l'entrée est vide, une indication aléatoire est sélectionnée dans le tableau.
Paramètres |
|
---|---|
indices |
Tableau de chaînes La valeur ne doit pas être nulle. |
- Renvoie
-
non-null Builder
ceci
setInput
setInput(input) renvoie Builder
Obligatoire : Élément HTMLElement auquel l'utilisateur saisit la requête. Doit être <input> ou <textarea>
Paramètres |
|
---|---|
entrée |
HTMLElement La valeur ne doit pas être nulle. |
- Obsolète
- Utilisez plutôt "setInputElement"
- Renvoie
-
non-null Builder
ceci
setInputElement
setInputElement(inputElement) renvoie Builder
Obligatoire : Élément HTMLElement auquel l'utilisateur saisit la requête. Doit être <input> ou <textarea>
Paramètres |
|
---|---|
inputElement |
HTMLElement La valeur ne doit pas être nulle. |
- Renvoie
-
non-null Builder
ceci
setResultsContainer
setResultsContainer(resultsContainer) renvoie le compilateur
Facultatif. Conteneur permettant d'afficher les résultats de recherche. Si cette option est définie, les résultats s'affichent dans le conteneur des résultats de recherche. Si cette règle n'est pas configurée, les résultats s'affichent sur cloudsearch.google.com.
Paramètres |
|
---|---|
resultsContainer |
gapi.cloudsearch.widget.resultscontainer.ResultsContainer La valeur ne doit pas être nulle. |
- Voir aussi
- ResultsContainer
- Renvoie
-
non-null Builder
ceci
setSearchApplicationId
setSearchApplicationId(searchApplicationId) returns Builder
Facultatif. Définit l'ID d'application de recherche à utiliser pour les requêtes. Doit être précédé de "searchapplications/".
Paramètres |
|
---|---|
searchApplicationId |
chaîne |
- Renvoie
-
non-null Builder
ceci
setThrottleInterval
setThrottleInterval(throttleInterval) renvoie Builder
Facultatif. Intervalle de limitation en millisecondes lors du déclenchement d'une requête. Le champ de recherche envoie moins d'une requête toutes les millisecondes throttleInterval. Si throttleInternal est inférieur à 200, le champ de recherche ignore la valeur et utilise 200 comme intervalle à la place.
Paramètres |
|
---|---|
throttleInterval |
number |
- Renvoie
-
non-null Builder
ceci