YMaps.GeocoderResult

Внимание. Геокодирование доступно только в актуальных версиях API.

Как перейти на API 2.1

Расширяет YMaps.Placemark.

Результат геокодирования (специальная метка с опциями).

См.: Геокодирование

Конструктор

Имя Описание
YMaps.GeocoderResult(point, options) Создает результат геокодирования - метку с координатами найденного по запросу топонима и его описания.

Поля

Имя Описание
AddressDetails Структурированное представление адреса, согласно стандарту xAL.
kind

Вид топонима.

precision

Предполагаемая точность ответа.

text Адрес одной строкой.

Наследуемые поля

Из YMaps.Placemark:
Events
Из YMaps.IGeoObject:
description, id, metaDataProperty, name

Наследуемые события

Из YMaps.Placemark:
AddToMap, BalloonClose, BalloonOpen, Click, DblClick, Drag, DragEnd, DragStart, MouseEnter, MouseLeave, MouseMove, PositionChange, RemoveFromMap

Наследуемые методы

Из YMaps.Placemark:
getContentLayout, getCoordPoint, getGeoPoint, getIconContent, getIconLayout, getIconShadowLayout, getMap, getOptions, getParentContainer, setCoordPoint, setGeoPoint, setIconContent, setOptions
Из YMaps.IOverlay:
onAddToMap, onMapUpdate, onRemoveFromMap
Из YMaps.IInteractiveGeoObject:
closeBalloon, getBalloon, getBalloonContent, getBalloonOptions, getHintContent, getHintOptions, openBalloon, setBalloonContent, setBalloonOptions, setHintContent, setHintOptions, update
Из YMaps.IGeoObject:
getBounds, getComputedStyle, getParentGroup, getStyle, onAddToGroup, onRemoveFromGroup, setBounds, setStyle

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

YMaps.GeocoderResult(point, options)

Создает результат геокодирования - метку с координатами найденного по запросу топонима и его описания. Класс построен на основе класса метки YMaps.Placemark и отличается только наличием дополнительных полей. Можно сразу добавлять на карту.

См.: Геокодирование

Параметры:

Имя Тип Необязательный По умолчанию Описание
point YMaps.GeoPoint Геоточка, определяющая положение метки на карте.
options Object Опции метки. Подробнее см. описание конструктора YMaps.Placemark.

Подробное описание полей

AddressDetails

Object AddressDetails

Структурированное представление адреса, согласно стандарту xAL.

См.: Спецификация xAL

Пример:

// Структура, представляющая адрес Москва, Вавилова 40.
AddressDetails = {
  Country: {
    CountryName: "Россия",
    Locality:
      LocalityName: "Москва",
      Thoroughfare:
        ThoroughfareName: "улица Вавилова",
        Premise: {
           PremiseNumber: "40"
        }
      }
    }
  }
}

kind

String kind

Вид топонима.

Список возможных значений:

  • house - дом;
  • street - улица;
  • metro - метро;
  • district - район;
  • locality - населённый пункт;
  • province - область;
  • country - страна;
  • hydro - река, озеро, ручей, водохранилище...;
  • railway - ж.д. станция;
  • route - линия метро / шоссе / ж.д. линия;
  • vegetation - лес, парк...;
  • cemetery - кладбище;
  • bridge - мост;
  • km - километр шоссе;
  • other - разное.

precision

String precision

Предполагаемая точность ответа.

Список возможных значений:

  • exact - найден дом с точным совпадением номера (включая литеру, № корпуса, строения и т. д.);
  • number - найден дом с тем же номером (например: 12A по 12K1);
  • near - найден дом (на расстоянии не далее 10 номеров от запрошенного);
  • street - найдена улица;
  • other - найден некий топоним;
  • suggestion - слабая уверенность, уровень предположений "Быть может, вы искали".

text

String text

Адрес одной строкой.