Clase: Builder

gapi.cloudsearch.widget.searchbox.Builder

class   static

Es un creador de un cuadro de búsqueda. Usa un compilador y no llames directamente al constructor de searchbox.

Constructor

Builder

new 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() muestra 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 este

Ejemplo

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

builder.setAdapter(adapter).build();

setAnchor

setAnchor(anchor) muestra Builder

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

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

Obsoleto

Usa "setAnchorElement" en su lugar

Muestra

non-null Builder este

setAnchorElement

setAnchorElement(anchorElement) muestra Builder

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

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

Muestra

non-null Builder este

setHints

setHints(hints) devuelve Builder

Opcional. Las sugerencias 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
sugerencias	Array de cadenas El valor no debe ser nulo.

Muestra

non-null Builder este

setInput

setInput(input) muestra Builder.

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

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

Obsoleto

Usa "setInputElement" en su lugar

Muestra

non-null Builder este

setInputElement

setInputElement(inputElement) devuelve Builder

Obligatorio. Un HTMLElement en el 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 este

setResultsContainer

setResultsContainer(resultsContainer) devuelve Builder

Opcional. Recipiente 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 se establece, los resultados se muestran 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 este

setSearchApplicationId

setSearchApplicationId(searchApplicationId) muestra Builder

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

Parámetro
searchApplicationId	string

Muestra

non-null Builder este

setThrottleInterval

setThrottleInterval(throttleInterval) muestra Builder

Opcional. Es el intervalo de limitación en ms en 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 usa 200 como intervalo.

Parámetro
throttleInterval	número

Muestra

non-null Builder este