gapi. cloudsearch. widget. searchbox. Compilador
Creador de un cuadro de búsqueda. Usa un compilador y no llames directamente al 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
organizar
build() muestra SearchBox
- Devuelve
-
non-null SearchBox
setAdapter
setAdapter(adapter) muestra Builder.
Obligatorio: Personaliza la experiencia de búsqueda del usuario con este adaptador.
Parámetro |
|
---|---|
adaptador |
Puedes anular parte de los métodos. El valor no debe ser nulo. |
- Devuelve
-
non-null Builder
esto
Ejemplo
const adapter = {
interceptSuggestRequest: function(request) {
// Change the request
}
}
builder.setAdapter(adapter).build();
setAnchor
setAnchor(ancla) muestra Builder.
Obligatorio: Debe ser un elemento HTMLElement válido que pueda contener nodos secundarios. Ancla de la superposición de búsqueda. La superposición se agrega como el último elemento secundario del ancla. La posición de la superposición es la parte inferior del ancla.
Parámetro |
|
---|---|
ancla |
HTMLElement El valor no debe ser nulo. |
- Funciones obsoletas
- En su lugar, usa `setAnchorElement`
- Devuelve
-
non-null Builder
esto
setAnchorElement
setAnchorElement(anchorElement) muestra Builder.
Obligatorio: Debe ser un elemento HTMLElement válido que pueda contener nodos secundarios. Ancla de la superposición de búsqueda. La superposición se agrega como el último elemento secundario del ancla. La posición de la superposición es la parte inferior del ancla.
Parámetro |
|
---|---|
anchorElement |
HTMLElement El valor no debe ser nulo. |
- Devuelve
-
non-null Builder
esto
setHints
setHints(hints) muestra Builder.
Opcional: Las sugerencias en el cuadro de búsqueda cuando el campo de entrada está vacío. Cuando la entrada está vacía, se elige una sugerencia aleatoria del array.
Parámetro |
|
---|---|
pistas |
Array de cadenas El valor no debe ser nulo. |
- Devuelve
-
non-null Builder
esto
setInput
setInput(input) muestra Builder.
Obligatorio: Es un elemento HTMLElement que el usuario ingresa en la consulta. Debe ser <input> o <textarea>.
Parámetro |
|
---|---|
salida |
HTMLElement El valor no debe ser nulo. |
- Funciones obsoletas
- En su lugar, usa `setInputElement`
- Devuelve
-
non-null Builder
esto
setInputElement
setInputElement(inputElement) muestra Builder.
Obligatorio: Es un elemento HTMLElement que el usuario ingresa en la consulta. Debe ser <input> o <textarea>.
Parámetro |
|
---|---|
inputElement |
HTMLElement El valor no debe ser nulo. |
- Devuelve
-
non-null Builder
esto
setResultsContainer
setResultsContainer(resultsContainer) muestra el compilador
Opcional: Es el contenedor para mostrar los resultados de la búsqueda. Si se configura, 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
- Devuelve
-
non-null Builder
esto
setSearchApplicationId
setSearchApplicationId(searchApplicationId) muestra Builder.
Opcional: Establece el ID de aplicación de búsqueda que se usará para las solicitudes. Debe tener el prefijo “searchapplications/”.
Parámetro |
|
---|---|
searchApplicationId |
cadena |
- Devuelve
-
non-null Builder
esto
setThrottleInterval
setThrottleInterval(throttleInterval) muestra Builder.
Opcional: El intervalo de limitación en ms tras la activación de una solicitud. El cuadro de búsqueda envía menos de una solicitud cada milésima de segundo de throttleInterval. Si throttleInternal es inferior a 200, el cuadro de búsqueda ignora el valor y usa 200 como intervalo.
Parámetro |
|
---|---|
throttleInterval |
número |
- Devuelve
-
non-null Builder
esto