IGeocodeProvider

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

Конструктор | Методы

Конструктор

IGeocodeProvider()

Методы

Имя Возвращает Описание
geocode(request[, options])

util.Promise

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

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

geocode

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

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

Параметры:

Параметр Значение по умолчанию Описание
request *

Тип: String

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

options

Тип: Object

Опции.

options.boundedBy

Тип: Number[][]

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

options.results

Тип: Number

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

options.skip

Тип: Number

Число результатов, которое необходимо пропустить.

options.strictBounds

Тип: Boolean

Искать только внутри области, заданной опцией boundedBy.

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