Clase: Builder

gapi.cloudsearch.widget.searchbox.Builder

class   estática

Compilador de un cuadro de búsqueda. Usa un compilador y no llames directamente el constructor del cuadro de búsqueda.

Constructor

Builder

nuevo Builder()

Ejemplo

// 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étodos

build

build() returns SearchBox

Muestra

non-null SearchBox 

setAdapter

setAdapter(adapter) devuelve Builder

Obligatorio. Personaliza la experiencia de búsqueda del usuario con este adaptador.

Parámetro
adaptador	SearchBoxAdapter Puedes anular parte de los métodos. El valor no debe ser nulo.

Muestra

non-null Builder esta

Ejemplo

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

builder.setAdapter(adapter).build();

setAnchor

setAnchor(Anchor) devuelve Builder

Obligatorio. Debe ser un HTMLElement válido que pueda contener elementos secundarios nodos. Ancla de la superposición de búsqueda. Se agrega la superposición como el último elemento secundario en el ancla. La posición de la superposición es la inferior del ancla.

Parámetro
ancla	HTMLElement El valor no debe ser nulo.

Obsoleto

En su lugar, usa `setAnchorElement`

Muestra

non-null Builder esta

setAnchorElement

setAnchorElement(AnchoElement) devuelve Builder

Obligatorio. Debe ser un HTMLElement válido que pueda contener elementos secundarios nodos. Ancla de la superposición de búsqueda. Se agrega la superposición como el último elemento secundario en el ancla. La posición de la superposición es la inferior del ancla.

Parámetro
anchorElement	HTMLElement El valor no debe ser nulo.

Muestra

non-null Builder esta

setHints

setHints(hints) devuelve Builder

Opcional. Las sugerencias que aparecen en el cuadro de búsqueda cuando la entrada está vacía. Cuando la entrada está vacía, se elige una sugerencia aleatoria del array.

Parámetro
pistas	Array de cadena El valor no debe ser nulo.

Muestra

non-null Builder esta

setInput

setInput(input) muestra compilador.

Obligatorio. Un HTMLElement que el usuario ingresa la consulta. Debe ser <input> o <textarea>

Parámetro
entrada	HTMLElement El valor no debe ser nulo.

Obsoleto

En su lugar, usa `setInputElement`

Muestra

non-null Builder esta

setInputElement

setInputElement(inputElement) returns Builder

Obligatorio. Un HTMLElement que el usuario ingresa la consulta. Debe ser <input> o <textarea>

Parámetro
inputElement	HTMLElement El valor no debe ser nulo.

Muestra

non-null Builder esta

setResultsContainer

setResultsContainer(resultsContainer) devuelve Builder

Opcional. Contenedor para mostrar los resultados de la búsqueda. Si se establece, los resultados se renderizan en el contenedor de resultados de la búsqueda. Si no la estableces, los resultados se mostrarán en cloudsearch.google.com.

Parámetro
resultsContainer	gapi.cloudsearch.widget.resultscontainer.ResultsContainer El valor no debe ser nulo.

Consulta también

ResultsContainer

Muestra

non-null Builder esta

setSearchApplicationId

setSearchApplicationId(searchApplicationId) devuelve Builder

Opcional. Establece el ID de aplicación de búsqueda que se usará para las solicitudes. Indispensable tener el prefijo “aplicaciones/de búsqueda/”.

Parámetro
searchApplicationId	string

Muestra

non-null Builder esta

setThrottleInterval

setThrottleInterval(throttleInterval) devuelve compilador

Opcional. El intervalo de regulación en ms de la solicitud de activación. El cuadro de búsqueda envía menos de una solicitud cada throttleInterval milisegundos. Si throttleInternal es inferior a 200, el cuadro de búsqueda ignora el valor y, en su lugar, usa 200 como intervalo.

Parámetro
throttleInterval	número

Muestra

non-null Builder esta