Класс: Строитель

гапи. поиск облаков. виджет. окно поиска . Строитель

класс статический

Создатель окна поиска. Используйте построитель и не вызывайте напрямую конструктор поля поиска.

Конструктор

Строитель

новый строитель()

Пример

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

Методы

строить

build() возвращает SearchBox

Возврат

non-null SearchBox

установитьАдаптер

setAdapter(адаптер) возвращает Builder

Необходимый . Настройте поиск пользователя с помощью этого адаптера.

Параметр
адаптер	Адаптер SearchBox Вы можете переопределить часть методов. Значение не должно быть нулевым.

Возврат

non-null Builder это

Пример

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

builder.setAdapter(adapter).build();

setAnchor

setAnchor(anchor) возвращает Builder

Необходимый . Должен быть действительным HTMLElement, который может содержать дочерние узлы. Привязка наложения поиска. Наложение добавляется как последний дочерний элемент привязки. Положение наложения — нижняя часть якоря.

Параметр
якорь	HTMLЭлемент Значение не должно быть нулевым.

Устарело

Вместо этого используйте `setAnchorElement`

Возврат

non-null Builder это

setAnchorElement

setAnchorElement(anchorElement) возвращает Builder

Необходимый . Должен быть действительным HTMLElement, который может содержать дочерние узлы. Привязка наложения поиска. Наложение добавляется как последний дочерний элемент привязки. Положение наложения — нижняя часть якоря.

Параметр
якорьЭлемент	HTMLЭлемент Значение не должно быть нулевым.

Возврат

non-null Builder это

setHints

setHints(hints) возвращает Builder

Необязательный . Подсказки в поле поиска, когда ввод пуст. Когда входные данные пусты, из массива выбирается случайная подсказка.

Параметр
намеки	Массив строк Значение не должно быть нулевым.

Возврат

non-null Builder это

setInput

setInput(input) возвращает Builder

Необходимый . HTMLElement, который пользователь вводит в запрос. Должно быть <input> или <textarea>.

Параметр
вход	HTMLЭлемент Значение не должно быть нулевым.

Устарело

Вместо этого используйте `setInputElement`

Возврат

non-null Builder это

SetInputElement

setInputElement(inputElement) возвращает Builder

Необходимый . HTMLElement, который пользователь вводит в запрос. Должно быть <input> или <textarea>.

Параметр
входной элемент	HTMLЭлемент Значение не должно быть нулевым.

Возврат

non-null Builder это

setResultsContainer

setResultsContainer(resultsContainer) возвращает Builder

Необязательный . Контейнер для отображения результатов поиска. Если установлено, результаты отображаются в контейнере результатов поиска. Если этот параметр не установлен, результаты отображаются на сайте Cloudsearch.google.com.

Параметр
результатыКонтейнер	gapi.cloudsearch.widget.resultscontainer.ResultsContainer Значение не должно быть нулевым.

См. также

Контейнер результатов

Возврат

non-null Builder это

setSearchApplicationId

setSearchApplicationId(searchApplicationId) возвращает Builder

Необязательный . Устанавливает идентификатор приложения поиска, который будет использоваться для запросов. Должен иметь префикс «searchapplications/».

Параметр
идентификатор поиска приложения	нить

Возврат

non-null Builder это

setThrottleInterval

setThrottleInterval(throttleInterval) возвращает Builder

Необязательный . Интервал газа в мс при запросе на срабатывание. Поле поиска отправляет менее одного запроса каждые миллисекунды throttleInterval. Если throttleInternal меньше 200, поле поиска игнорирует это значение и вместо этого использует 200 в качестве интервала.

Параметр
дроссельИнтервал	число

Возврат

non-null Builder это