YMaps.IGeocodeProvider

Интерфейс сервиса геокодирования. Используется объектом YMaps.Geocoder. Этот интерфейс требуется реализовать при задании пользовательского геокодера.

Конструктор

Имя Описание
YMaps.IGeocodeProvider() Интерфейс сервиса геокодирования, используется объектом YMaps.Geocoder.

Методы

Имя Описание
geocode(request, options, successCallback, failureCallback) Осуществляет геокодирование.

Подробное описание конструктора

YMaps.IGeocodeProvider()

Интерфейс сервиса геокодирования, используется объектом YMaps.Geocoder.

Пример:

var simpleProvider = {
   geocode: function (request, options, successCallback, failureCallback) {
       YMaps.jQuery.ajax({
           url: createUrl(request, options),
           dataType: 'jsonp',
           scriptCharset: 'utf-8',
           cache: 1,
           success: function (response) {
               if (response.error) {
                   failureCallback(response.error.message);
               } else {
                   successCallback({
                       found: response.found,
                       suggest: response.suggest,
                       results: createGeocoderResultsByJSON(response.results)
                   });
               }
           }
       });
   };

Подробное описание методов

geocode

geocode(request, options, successCallback, failureCallback)

Осуществляет геокодирование.

Параметры:

Имя Тип Описание
request String|YMaps.GeoPoint Запрос на геокодирование.
options Object Параметры геокодирования (см. YMaps.Geocoder).
successCallback Function Вызывается при завершении геокодирования. В качестве аргумента передается объект с тремя полями:
  • found - количество найденных по запросу результатов;
  • results - массив объектов типа YMaps.IInteractiveGeoObject;
  • suggest - если адрес был скорректирован, то данное поле будет содержать исправленный вариант.
failureCallback Function Вызывается если при геокодировании произошла ошибка. В качестве аргумента передается строка с описанием ошибки.