Документация
Справочник JavaScript API
2.1.56 (текущая версия)
collection
interactivityModel
Интерфейсы

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

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

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

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

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

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

Карта

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

map.action.Manager

map.behavior.manager

MapType

map.ZoomRange

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

map.Container

Статьи

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

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

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

Примеры

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

Метка

Линия

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

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

Круг

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

Коллекция геообъектов

map.GeoObjects

Статьи

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

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

Примеры

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

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

map.Balloon

geoObject.Balloon

map.Hint

geoObject.Hint

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

Статьи

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

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

Примеры

Балунт и хинт

geocode

geolocation

control.SearchControl

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

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

Статьи

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

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

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

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

option.presetStorage – набор стандартных иконок

ObjectManager

LoadingObjectManager

RemoteObjectManager

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

Статьи

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

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

Примеры

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

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

event.Manager

domEvent.manager

Event

DomEvent

MapEvent

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

Статьи

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

Примеры

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

geoQuery

GeoQueryResult

Статьи

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

Примеры

Пример работы с GeoQuery

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.Editor

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

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

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

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

control.RouteEditor

behavior.RouteEditor

Статьи

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

Примеры

Расчет стоимости доставки

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

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

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

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

option.presetStorage – набор стандартных иконок

Статьи

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

Примеры

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

Слои

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 – возвращает кратчайшее расстояние между двумя заданными точками