IGeocodeProvider

Интерфейс провайдера геокодера.

Конструктор

IGeocodeProvider()

Методы

Имя

Возвращает

Описание

geocode(request[, options])

vow.Promise

Отправляет запрос на геокодирование. Добавить функцию-обработчик для обработки результата геокодирования можно через возвращаемый объект-promise. Объект, поступающий на вход функции-обработчика может содержать поля только следующего вида: geoObjects, layers, mapState, metaData.

suggest(request[, options])

vow.Promise

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

Этот метод является опциональным.

Описание методов

geocode

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

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

Параметры:

Параметр	Значение по умолчанию	Описание
`request`*	—	Тип: String Строка запроса.
`options`	—	Тип: Object Опции.
`options.boundedBy`	—	Тип: Number[][] Прямоугольная область на карте, где предположительно находится искомый объект. Должна быть задана как массив, например [[30, 40], [50, 50]].
`options.results`	—	Тип: Number Максимальное количество возвращаемых результатов.
`options.skip`	—	Тип: Number Число результатов, которое необходимо пропустить.
`options.strictBounds`	—	Тип: Boolean Искать только внутри области, заданной опцией boundedBy.

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

suggest

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