Classe: Builder

gapi.cloudsearch.widget.searchbox.Builder

classe   static

Outil de création d'un champ de recherche. Utilisez un compilateur et n'appelez pas directement le constructeur du champ de recherche.

Constructeur

Builder

nouveau Compilateur()

Exemple 

// Builds a search box.
function onload() {
  gapi.client.init({
    &#x27;apiKey&#x27;: &#x27;<your api key>&#x27;,
    &#x27;clientId&#x27;: &#x27;<your client id>&#x27;,
    // Add additional scopes if needed
    &#x27;scope&#x27;: &#x27;https://www.googleapis.com/auth/cloud_search.query',
    &#x27;hosted_domain&#x27;: &#x27;<your G Suite domain>&#x27;,
  });

  const searchBox &#x3D; new gapi.cloudsearch.widget.searchbox.Builder()
    .setInput(document.getElementById(&#x27;input&#x27;))
    .setAnchor(document.getElementById(&#x27;input&#x27;).parentElement)
    .build();
}
gapi.load(&#x27;client:cloudsearch-widget&#x27;, onload);

Méthodes

build

build() returns SearchBox

Renvoie

non-null SearchBox 

setAdapter

setAdapter(adapter) renvoie Builder

Obligatoire. Personnalisez l'expérience de recherche des utilisateurs avec cet adaptateur.

Paramètre

adaptateur

SearchBoxAdapter

Vous pouvez remplacer une partie des méthodes.

La valeur ne doit pas être nulle.
Renvoie

non-null Builder ce

Exemple 

const adapter &#x3D; {
 interceptSuggestRequest: function(request) {
    // Change the request
  }
}

builder.setAdapter(adapter).build();

setAnchor

setAnchor(Anchor) renvoie Builder

Obligatoire. Doit être un élément HTMLElement valide pouvant contenir un enfant nœuds. Ancrage de la superposition de recherche La superposition est ajoutée comme dernier enfant dans l'ancre. La position de la superposition correspond le bas de l'ancre.

Paramètre

anchor

HTMLElement

La valeur ne doit pas être nulle.
Obsolète
Utilisez plutôt "setAnchorElement"
Renvoie

non-null Builder ce

setAnchorElement

setAnchorElement(AnchorElement) renvoie le compilateur

Obligatoire. Doit être un élément HTMLElement valide pouvant contenir un enfant nœuds. Ancrage de la superposition de recherche La superposition est ajoutée comme dernier enfant dans l'ancre. La position de la superposition correspond le bas de l'ancre.

Paramètre

anchorElement

HTMLElement

La valeur ne doit pas être nulle.
Renvoie

non-null Builder ce

setHints

setHints(hints) renvoie le constructeur

Facultatif. Indices du champ de recherche lorsque la saisie est vide. Lorsque l'entrée est vide, une suggestion aléatoire est sélectionnée dans le tableau.

Paramètre

Indices

Tableau de chaîne

La valeur ne doit pas être nulle.
Renvoie

non-null Builder ce

setInput

setInput(input) renvoie Builder

Obligatoire. Élément HTMLElement dans lequel l'utilisateur saisit la requête. Doit être <input> ou <textarea>

Paramètre

entrée

HTMLElement

La valeur ne doit pas être nulle.
Obsolète
Utilisez plutôt "setInputElement"
Renvoie

non-null Builder ce

setInputElement

setInputElement(inputElement) returns Builder

Obligatoire. Élément HTMLElement dans lequel l'utilisateur saisit la requête. Doit être <input> ou <textarea>

Paramètre

inputElement

HTMLElement

La valeur ne doit pas être nulle.
Renvoie

non-null Builder ce

setResultsContainer

setResultsContainer(resultsContainer) renvoie le compilateur

Facultatif. Conteneur permettant d'afficher les résultats de recherche. S'il est défini, les résultats sont affichés 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ètre

resultsContainer

gapi.cloudsearch.widget.resultscontainer.ResultsContainer

La valeur ne doit pas être nulle.
Voir aussi
ResultsContainer
Renvoie

non-null Builder ce

setSearchApplicationId

setSearchApplicationId(searchApplicationId) renvoie le compilateur

Facultatif. Définit l'identifiant de l'application de recherche à utiliser pour les requêtes. Doit être précédé du préfixe "searchapplications/".

Paramètre

searchApplicationId

chaîne
Renvoie

non-null Builder ce

setThrottleInterval

setThrottleInterval(throttleInterval) renvoie le compilateur

Facultatif. Intervalle de limitation en ms lors du déclenchement de la requête. Le champ de recherche envoie moins d'une requête à chaque throttleInterval. millisecondes. Si la valeur de throttleInternal est inférieure à 200, le champ de recherche ignore la valeur et utilise à la place 200 comme intervalle.

Paramètre

throttleInterval

Nombre
Renvoie

non-null Builder ce