Klasse: Builder

gapi.cloudsearch.widget.searchbox.Builder

class   static

Builder eines Suchfelds. Verwende einen Builder und rufe den Suchfeldkonstruktor nicht direkt auf.

Konstruktor

Builder

new Builder()

Beispiel

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

Methoden

Teamaufbau

build() gibt SearchBox zurück

Rückgaben

non-null SearchBox 

setAdapter

setAdapter(adapter) gibt Builder zurück

Erforderlich. Passen Sie die Suchfunktion mit diesem Adapter an.

Parameter
Netzteil	SearchBoxAdapter Sie können Teile der Methoden überschreiben. Der Wert darf nicht null sein.

Rückgaben

non-null Builder dieses

Beispiel

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

builder.setAdapter(adapter).build();

setAnchor

setAnchor(anchor) gibt Builder zurück

Erforderlich. Muss ein gültiges HTMLElement sein, das untergeordnete Knoten enthalten kann. Anker des Such-Overlays. Das Overlay wird im Anker als letztes untergeordnetes Element hinzugefügt. Die Position des Overlays ist der untere Teil des Ankers.

Parameter
anchor	HTMLElement Der Wert darf nicht null sein.

Eingestellte Funktionen

Stattdessen `setAnchorElement` verwenden

Rückgaben

non-null Builder dieses

setAnchorElement

setAnchorElement(anchorElement) gibt den Builder zurück

Erforderlich. Muss ein gültiges HTMLElement sein, das untergeordnete Knoten enthalten kann. Anker des Such-Overlays. Das Overlay wird im Anker als letztes untergeordnetes Element hinzugefügt. Die Position des Overlays ist der untere Teil des Ankers.

Parameter
anchorElement	HTMLElement Der Wert darf nicht null sein.

Rückgaben

non-null Builder dieses

setHints

setHints(hints) returns Builder

Optional: Hinweise im Suchfeld, wenn die Eingabe leer ist Wenn die Eingabe leer ist, wird ein zufälliger Hinweis aus dem Array ausgewählt.

Parameter
Hinweise	String-Array Der Wert darf nicht null sein.

Rückgaben

non-null Builder dieses

setInput

setInput(input) gibt den Builder zurück

Erforderlich. Ein HTMLElement, das der Nutzer in die Anfrage eingibt. Muss <input> oder <textarea> sein

Parameter
Eingabe	HTMLElement Der Wert darf nicht null sein.

Eingestellte Funktionen

Stattdessen „setInputElement“ verwenden

Rückgaben

non-null Builder dieses

setInputElement

setInputElement(inputElement) gibt Builder zurück

Erforderlich. Ein HTMLElement, das der Nutzer in die Anfrage eingibt. Muss <input> oder <textarea> sein

Parameter
inputElement	HTMLElement Der Wert darf nicht null sein.

Rückgaben

non-null Builder dieses

setResultsContainer

setResultsContainer(resultsContainer) gibt Builder zurück

Optional: Container zum Anzeigen von Suchergebnissen. Wenn festgelegt, werden die Ergebnisse im Suchergebniscontainer gerendert. Ist die Richtlinie nicht konfiguriert, werden die Ergebnisse auf cloudsearch.google.com angezeigt.

Parameter
resultsContainer	gapi.cloudsearch.widget.resultscontainer.ResultsContainer Der Wert darf nicht null sein.

Weitere Informationen

ResultsContainer

Rückgaben

non-null Builder dieses

setSearchApplicationId

setSearchApplicationId(searchApplicationId) returns Builder

Optional: Legt die Suchanwendungs-ID fest, die für Anfragen verwendet werden soll. Muss das Präfix „searchapplications/“ haben.

Parameter
searchApplicationId	String

Rückgaben

non-null Builder dieses

setThrottleInterval

setThrottleInterval(throttleInterval) gibt Builder zurück

Optional: Das Drosselungsintervall in ms beim Auslösen der Anfrage. Das Suchfeld sendet pro throttleInterval-Millisekunden weniger als eine Anfrage. Wenn „throttleInternal“ kleiner als 200 ist, ignoriert das Suchfeld den Wert und verwendet stattdessen „200“ als Intervall.

Parameter
throttleInterval	Zahl

Rückgaben

non-null Builder dieses