suggest

Важно

Чтобы использовать саджест в JS API:

  1. Получите ключ для саджеста в Кабинете разработчика.
  2. Укажите его при подключении JS API в формате https://api-maps.yandex.ru/2.1/?lang=ru_RU&apikey=<ваш ключ для JS API>&suggest_apikey=<ваш ключ для Suggest API>.

Статическая функция.

Обрабатывает запросы за поисковыми подсказками. Возвращает объект Promise, который будет либо отклонён с ошибкой, либо подтверждён массивом объектов вида { displayName: "Мытищи, Московская область", value: "Россия, Московская область, Мытищи " }. Поле displayName отвечает за представление топонима в удобном для чтения пользователем виде, поле value — значение, которое необходимо подставить в поле ввода после выбора пользователем данной подсказки.

Возвращает объект Promise.

{ vow.Promise } suggest(request[, options])

Параметры:

Параметр

Значение по умолчанию

Описание

request*

Тип: String

Строка запроса.

options

Тип: Object

Опции.

options.boundedBy

Тип: Number[][]

Прямоугольная область на карте, где предположительно находится искомый объект. Должна быть задана как массив, например [[30, 40], [50, 50]].

options.provider

'yandex#map'

Тип: ISuggestProvider|String

Провайдер поисковых подсказок. Можно воспользоваться встроенным провайдером подсказок для объектов карты 'yandex#map' или задать собственный.

options.results

Тип: Number

Максимальное количество возвращаемых результатов.

* Обязательный параметр/опция.

Пример:

ymaps.suggest('мыт').then(function (items) {
    // items - массив поисковых подсказок.
});
Предыдущая
Следующая