Classe: Builder

gapi.cloudsearch.widget.searchbox.Builder

class   static

Outil de création d'un champ de recherche. Utilisez un générateur et n'appelez pas directement le constructeur de la zone 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 un compilateur

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

Paramètre
adapter	SearchBoxAdapter Vous pouvez remplacer une partie des méthodes. La valeur ne doit pas être nulle.

Renvoie

non-null Builder ce

Exemple

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

builder.setAdapter(adapter).build();

setAnchor

setAnchor(ancre) renvoie Builder

Obligatoire. Doit être un élément HTML valide pouvant contenir des nœuds enfants. Ancrage de la superposition de recherche. La superposition est ajoutée en tant que dernier enfant de l'ancrage. La position de la superposition est en bas de l'ancrage.

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 Builder

Obligatoire. Doit être un élément HTML valide pouvant contenir des nœuds enfants. Ancrage de la superposition de recherche. La superposition est ajoutée en tant que dernier enfant de l'ancrage. La position de la superposition est en bas de l'ancrage.

Paramètre
anchorElement	HTMLElement La valeur ne doit pas être nulle.

Renvoie

non-null Builder ce

setHints

setHints(hints) renvoie un compilateur

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

Paramètre
indices	Tableau de chaînes La valeur ne doit pas être nulle.

Renvoie

non-null Builder ce

setInput

setInput(input) renvoie Builder

Obligatoire. 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) renvoie Builder

Obligatoire. 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 Builder

Facultatif. Conteneur permettant d'afficher les résultats de recherche. Si cette valeur est définie, les résultats sont affichés dans le conteneur des résultats de recherche. Si ce paramètre n'est pas défini, les résultats s'affichent sur la page 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 Builder

Facultatif. Définit l'ID 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 Builder

Facultatif. Intervalle de régulation en ms lors de l'envoi de la requête. La zone de recherche n'envoie pas plus d'une requête tous les millièmes de seconde throttleInterval. Si throttleInternal est inférieur à 200, la zone de recherche ignore la valeur et utilise 200 comme intervalle à la place.

Paramètre
throttleInterval	Total

Renvoie

non-null Builder ce