О справочнике

Справочник содержит описание программного интерфейса JavaScript API версии 2.0.50.

Целевой аудиторией справочника являются разработчики сайтов, которые хотят использовать интерактивные Яндекс.Карты на своих веб-страницах.

Справочник содержит описания открытых классов и методов API и рассчитан на разработчиков, знакомых с JavaScript и сервисом Яндекс.Карты. Классы перечислены в алфавитном порядке.

Ниже перечислены группы основных классов API:

Карта Геообъекты Балун и хинт Поиск по карте

Map

Дополнительные классы

map.behavior.manager

MapType

map.ZoomRange

map.Converter - преобразование глобальных координат в локальные

map.Container

Статьи

Создание карты

Параметры карты

Работа с поведениями

Примеры

Создание и удаление карты

Placemark

Polyline

Polygon

Rectangle

Circle

option.presetStorage - набор стандартных значков меток

GeoObjectCollection

map.GeoObjects

Дополнительные классы

geometryEditor.Point

geometryEditor.Polygon

Статьи

Визуальное редактирование геообъектов

Кластеризация

Примеры

Вывод списка объектов карты

map.Balloon

geoObject.Balloon

map.Hint

geoObject.Hint

Дополнительные классы

hotspot.layer.Hint

cluster.Balloon

Статьи

Задание стиля метки

Балун, выходящий за пределы карты

geocode

geolocation

control.SearchControl

Примеры

Поиск по своим объектам

Кластеризатор События GeoQuery Элементы управления

Clusterer

option.presetStorage - набор стандартных значков кластеров

Дополнительные классы

cluster.Balloon

Статьи

Кластеризация объектов

Примеры

Изменение параметров кластеризатора

event.Manager

domEvent.manager

Event

DomEvent

MapEvent

Дополнительные классы

domEvent.MultiTouch

domEvent.Ponter

domEvent.Touch

Статьи

Структура объекта-события

geoQuery

GeoQueryResult

Статьи

Работа с выборками геообъектов

map.controlManager

control.MapTools

control.MiniMap

control.RouteEditor

control.ScaleLine

control.SearchControl

control.SmallZoomControl

control.ToolBar

control.TrafficControl

control.TypeSelector

control.ZoomControl

Маршрутизатор Внешний вид объектов Слои GeoXML, YMapsML, KML

route

Дополнительные классы

router.Route - объект, описывающий проложенный маршрут

router.Path - путь маршрута

router.Segment - сегмент маршрута

router.ViaPoint - транзитная точка

control.RouteEditor

behavior.RouteEditor

Статьи

Построение маршрута

Примеры

Расчет стоимости маршрута

templateLayoutFactory - фабрика для создания макетов и шаблонов

option.presetStorage - стандартный набор иконок

Статьи

Макеты и шаблоны

Layer

map.layer.Manager

hotspot.Layer

Примеры

Создание карты с собственным слоем

geoXml.load

IMapState - описание состояния карты (только для YMapsML)

Статьи

Использование GeoXML

О формате YMapsML

Пробки Активные области Редактирование объектов Координаты, проекции, расстояния

control.TrafficControl

traffic.provider.Actual

traffic.provider.Archive

Примеры

Слой пробок без добавления кнопки

hotspot.Layer

hotspot.ObjectSource

Статьи

Работа с активными областями

Примеры

Использование активных областей

geometryEditor.Point

geometryEditor.Polygon

geometryEditor.LineString

util.Dragger - позволяет осуществлять перетаскивание элементов на странице

Примеры

Перетаскивание HTML-элементов с помощью util.Dragger

coordSystem.cartesian - геометрия декартовой плоскости

coordSystem.geo - геометрия земной поверхности

projection.Cartesian - декартова проекция прямоугольной области

projection.sphericalMercator - меркаторовская проекция на сферу

projection.wgs84Mercator - меркаторовская проекция на референсный эллипсоид wgs84

Регионы Поведения карты Загрузка API, модулей Вспомогательные функции

regions.load

Статьи

Использование сервиса «Регионы»

map.behavior.Manager

behavior.DblClickZoom

behavior.Drag

behavior.LeftMouseButtonMagnifier

behavior.MultiTouch

behavior.RightMouseButtonMagnifier

behavior.RouteEditor

behavior.Ruler

behavior.ScrollZoom

Статьи

Работа с поведениями карты

ready - выполняет заданную функцию, когда API готов к использованию

load - загружает модули API

util.Promise

util.bounds

Monitor - отслеживание изменения полей данных у объектов

collection.Item - базовый класс элемента коллекции объектов карты

coordSystem.geo.getDistance - возвращает кратчайшее расстояние между двумя заданными точками