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

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

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

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

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

Карта Геообъекты Балун и всплывающая подсказка Поиск по карте

Карта

Вспомогательные модули

map.behavior.manager

MapType

map.ZoomRange

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

map.Container

Статьи

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

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

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

Примеры

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

Метка

Ломаная

Многоугольник

Прямоугольник

Круг

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

GeoObjectCollection

map.GeoObjects

Статьи

Режим визуального редактирования геообъектов

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

Примеры

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

Множественная обводка

map.Balloon

geoObject.Balloon

map.Hint

geoObject.Hint

Вспомогательные модули

hotspot.layer.Hint

clusterer.Balloon

clusterer.Hint

Статьи

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

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

Примеры

Балун и всплывающая подсказка

Геокодирование

Определение местоположения

control.SearchControl

SuggestView – выпадающая панель с поисковыми подсказками

suggest – обрабатывает запросы за поисковыми подсказками

Статьи

Множественное геокодирование

Поиск по организациями

Работа с большим числом объектов События Выборка объектов Элементы управления

Кластеризатор

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

ObjectManager

LoadingObjectManager

RemoteObjectManager

Вспомогательные модули

clusterer.Balloon

clusterer.Hint

Статьи

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

Менеджеры объектов

Примеры

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

Добавление объектов на карту через ObjectManager

event.Manager

domEvent.manager

Event

DomEvent

MapEvent

Вспомогательные модули

domEvent.MultiTouch

domEvent.Pointer

domEvent.Touch

Статьи

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

Примеры

Подписка на DOM-события

geoQuery

GeoQueryResult

Статьи

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

Примеры

Примеры

control.Manager

control.FullscreenControl

control.GeolocationControl

control.RouteEditor

control.RulerControl

control.SearchControl

control.TrafficControl

control.TypeSelector

control.ZoomControl

Вспомогательные модули

Статьи

Элементы управления

Примеры

Добавление стандартных элементов управления

Пользовательские элементы управления

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

route

multiRouter.MultiRoute

Вспомогательные модули

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

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

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

router.ViaPoint – транзитная точка маршрута

control.RouteEditor

behavior.RouteEditor

Статьи

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

Примеры

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

Построение автомобильной маршрутизации

Построение мультимаршрута на общественном транспорте

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

Template – шаблонизатор

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

Статьи

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

Примеры

Пользовательский макет кнопки

Layer

map.layer.Manager

hotspot.Layer

geoXml.load

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

Статьи

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

Формат YMapsML

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

control.TrafficControl

traffic.provider.Actual

traffic.provider.Archive

traffic.provider.Forecast

Примеры

Отображение пробок без добавления кнопки на карту

hotspot.Layer

Статьи

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

Примеры

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

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

Статьи

Использование модуля «Regions»

map.behavior.Manager

behavior.DblClickZoom

behavior.Drag

behavior.LeftMouseButtonMagnifier

behavior.MultiTouch

behavior.RightMouseButtonMagnifier

behavior.RouteEditor

behavior.Ruler

behavior.ScrollZoom

Статьи

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

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

modules.require – загружает модули API

Статьи

Модульная система

Примеры

Загрузка необходимых модулей

vow.Promise

util.bounds

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

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

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