Documentation
Reference
2.1.38 (current version)
collection
interactivityModel
Interfaces

About this reference guide

This reference guide describes the JavaScript API version 2.1.38.

This reference guide is intended for website developers who want to use interactive Yandex.Maps on their web pages.

The guide describes the public modules in the API and assumes that developers are familiar with JavaScript and the Yandex.Maps service. The modules are listed in alphabetical order.

The main groups of API modules are listed below:

MapGeo objectsBalloon and hintSearch on a map

Map

Auxiliary modules

map.action.Manager

map.behavior.manager

MapType

map.ZoomRange

map.Converter - converting global coordinates to local coordinates

map.Container

Articles

Creating a map

Map parameters

Working with behaviors

Examples

Creating and deleting maps

Placemark

Polyline

Polygon

Rectangle

Circle

option.presetStorage - a standard set of cluster placemarks

GeoObjectCollection

map.GeoObjects

Articles

Visually editing geo objects

Clusterization

Examples

Printing a list of map objects

Multistroke outline

map.Balloon

geoObject.Balloon

map.Hint

geoObject.Hint

Articles

Setting the placemark style

Balloon that goes off the map

Examples

Balloon and hint

geocode

geolocation

control.SearchControl

SuggestView - drop-down panel with search suggestions

suggest - handles requests for search suggestions

Articles

Multi-address geocoding

Searching for organizations

Working with a large number of objectsEventsGeoQueryControls

Clusterer

option.presetStorage - a standard set of cluster icons

ObjectManager

LoadingObjectManager

RemoteObjectManager

Articles

Object clustering

Object managers

Examples

Change to the clusterer settings

Adding objects to the map via ObjectManager

event.Manager

domEvent.manager

Event

DomEvent

MapEvent

Articles

Structure of the event object

Examples

Subscribing to DOM events

geoQuery

GeoQueryResult

Articles

Working with selections of geo objects

Examples

Example with GeoQuery

control.Manager

control.FullscreenControl

control.GeolocationControl

control.RouteEditor

control.RulerControl

control.SearchControl

control.TrafficControl

control.TypeSelector

control.ZoomControl

Articles

Controls

Examples

Adding standard controls

Custom control

RouterObject appearanceLayersGeoXML, YMapsML, KML

route

multiRouter.MultiRoute

Auxiliary modules

router.Editor

router.Route - object describing a route

router.Path - route path

router.Segment - route segment

router.ViaPoint - throughpoint

control.RouteEditor

behavior.RouteEditor

Articles

Build a route

Examples

Calculating the cost of a route

Building a driving route

Building a multi-stop route on public transport

templateLayoutFactory - a factory for creating layouts and templates

Template - template engine

option.presetStorage - standard set of icons

Articles

Layouts and templates

Examples

Custom button layout

Layer

map.layer.Manager

hotspot.Layer

geoXml.load

IMapState - description of the map state (only for YMapsML)

Articles

Using GeoXML

About YMapsML format

TrafficHotspotsEditing objectsCoordinates, projections, and distances

control.TrafficControl

traffic.provider.Actual

traffic.provider.Archive

traffic.provider.Forecast

Examples

Traffic layer without adding a button

hotspot.Layer

Articles

Working with hotspots

Examples

Using hotspots

geometryEditor.Point

geometryEditor.Polygon

geometryEditor.LineString

util.Dragger - allows dragging page elements

Examples

Dragging HTML elements using util.Dragger

coordSystem.cartesian - geometry of a Cartesian plane

coordSystem.geo - geometry of the earth's surface

projection.Cartesian - Cartesian projection of a rectangular area

projection.sphericalMercator - Mercator projection on a sphere

projection.wgs84Mercator - Mercator projection on a wgs84 reference ellipsoid

RegionsMap behaviorsLoading the API, modulesAuxiliary functions

regions.load

Articles

Using the “Regions” service

map.behavior.Manager

behavior.DblClickZoom

behavior.Drag

behavior.LeftMouseButtonMagnifier

behavior.MultiTouch

behavior.RightMouseButtonMagnifier

behavior.RouteEditor

behavior.Ruler

behavior.ScrollZoom

Articles

Working with map behaviors

ready - performs the specified function when the API is ready to be used

modules.require - loads API modules

Articles

Module system

Examples

Loading the necessary modules

vow.Promise

util.bounds

Monitor - tracking changes to the data fields of objects

collection.Item - base class of an item in a collection of map objects

coordSystem.geo.getDistance - returns the shortest distance between two specified points