Yandex Maps JavaScript API 2.1

https://yandex.com/dev/jsapi-v2-1/doc/
Admin
Yandex Maps JavaScript API 2.1 is a mapping library that enables developers to embed interactive...
Tokens:1,995,824
Snippets:8,646
Trust Score:9.6
Update:1 day ago
Show doc for...
Tokens:
Raw
### start

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/util.Dragger

Starts the dragging operation.

```APIDOC
## start

### Description
Starts the dragging operation.

### Method
`start()`

### Parameters
None

### Returns
None
```

--------------------------------

### start([event])

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/util.Dragger

Starts the dragger. This method is automatically called on the mousedown event of the autoStartElement if it is set. Can be used for on-demand initialization, for example, when receiving a response from the server. For correct operation with on-demand initialization, the passed event must support the 'position' field in the get method.

```APIDOC
## start([event])

### Description
Starts the dragger. This method is automatically called on the mousedown event of the autoStartElement if it is set. Can be used for on-demand initialization, for example, when receiving a response from the server. For correct operation with on-demand initialization, the passed event must support the 'position' field in the get method.

### Method
start

### Parameters
#### Optional Parameters
- **event** (Event) - Optional - The event that triggered the start. Must support the 'position' field in the get method for on-demand initialization.

### Returns
None
```

--------------------------------

### start(options)

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/router.Editor

Включает редактор маршрута. Принимает необязательный объект опций.

```APIDOC
## start(options)

### Description
Включает редактор маршрута.

### Method
start

### Parameters
#### Options
- **options** (Object) - Optional - Объект опций для включения редактора.

### Returns
Не указано в документации.
```

--------------------------------

### start

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.EditorAddon

Enables the editor with an optional initial state.

```APIDOC
## start(state)

### Description
Enables the editor. The state parameter is required and specifies the initial state of the editor.

### Method
start

### Parameters
- **state** (Object) - Required - Initial state of the editor.

### Returns
- **{}** - No return value.
```

--------------------------------

### IDataManager.get example

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDataManager

Example usage of the get method with a path containing a dot and a default value.

```javascript
dataManager.get("icon.shadow.size", [10, 10]);
```

--------------------------------

### get: Asynchronous example - get southern and northern objects

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoQueryResult

Shows how to use the get method with asynchronous processing. Waits for the geocode result to be ready before accessing elements.

```javascript
// Пример при асинхронной обработке.
var result = ymaps.geoQuery(ymaps.geocode('кафе Москва')).sort('lat');
// Нужно дождаться готовности результата для дальнейшей обработки.
result.then(function () {
    // Самый южный объект.
    var southObject = result.get(0),
    // Самый северный объект.
    var northObject = result.get(result.getLength() - 1);
});
```

--------------------------------

### startFraming()

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/geometryEditor.Polygon

Enables the scaling mode for the polygon. The enabling happens asynchronously.

```APIDOC
## startFraming()

### Description
Enables the scaling mode for the polygon. The enabling happens asynchronously.

### Method
startFraming

### Returns
vow.Promise
```

--------------------------------

### Usage example: ymaps.map.addon.hint.get(myMap)

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.addon.hint

Example call to get the hint manager for a map instance. The map parameter is required.

```javascript
ymaps.map.addon.hint.get(myMap)
```

--------------------------------

### Dynamic copyright provider example

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.Copyrights

Example of creating a dynamic copyright provider that fetches copyright information from a remote server and adding it to the map.

```javascript
// Создание динамического поставщика информации об авторских правах
// что позволит получить актуальную информацию об авторских правах для
// конкретная точка на карте с удаленного сервера.
var myProvider = {
    getCopyrights: function (center, zoom) {
        var deferred = ymaps.vow.defer();
        $.ajax('http://some.server/copyrights/?ll=' + center.join(',') + '&z=' + zoom, {
            // Сервер должен возвращать массив строк
            success: function (res) {
                deferred.resolve(res);
            }
        });
        return deferred.promise();
    }
};
// Добавление поставщика на карту; теперь, когда центр или масштаб меняются, 
// менеджер информации об авторских правах на карту будет
// запросить обновленную информацию с удаленного сервера и отобразить ее
// полученные данные автоматически.
map.copyrights.addProvider(myProvider);
```

--------------------------------

### startFraming()

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/geometryEditor.LineString

Enables the scaling mode for the polyline. The enabling is asynchronous.

```APIDOC
## startFraming()

### Description
Enables the scaling mode for the polyline. The enabling is asynchronous.

### Method
POST

### Endpoint
geometryEditor.LineString.startFraming()

### Parameters
None

### Response
#### Success Response
- **vow.Promise** - A promise that resolves when the mode is enabled.

```

--------------------------------

### Example: ymaps.geoObject.addon.editor.get(geoObject)

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/geoObject.addon.editor

Example call to the get method of the geoObject.addon.editor module, passing a geoObject. The geoObject parameter is required.

```javascript
ymaps.geoObject.addon.editor.get(geoObject)
```

--------------------------------

### IRoutePanel.enable()

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IRoutePanel

Loads all dependencies of the route panel.

```APIDOC
## enable()

### Description
Loads all dependencies of the route panel.

### Method
enable

### Parameters
None

### Returns
None
```

--------------------------------

### get: Synchronous example - get southern and northern objects

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoQueryResult

Shows how to use the get method with synchronous processing. Sorts geoQuery results by latitude and retrieves the first and last elements.

```javascript
// Пример при синхронной обработке.
var result = ymaps.geoQuery(placemarks).sort('lat'),
// Самый южный объект.
southObject = result.get(0),
// Самый северный объект.
northObject = result.get(result.getLength() - 1);
```

--------------------------------

### getPixelGeometry example: get pixel coordinates with options

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeometry

Gets the pixel representation of the geometry with geodesic enabled and simplification disabled, then returns its coordinates.

```javascript
// Получаем пиксельное представление геометрии с учетом геодезии, но без оптимизации удаления невидимых точек.
myGeometry.getPixelGeometry({
    geodesic: true,
    simplification: false
}).getCoordinates();
```

--------------------------------

### enable()

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IRoutePanel

Loads all dependencies of the route panel.

```APIDOC
## enable()

### Description
Loads all dependencies of the route panel.

### Method
enable

### Signature
`{} enable()`

### Parameters
None.

### Returns
None.
```

--------------------------------

### Call get method on objectManager.addon.objectsBalloon

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.addon.objectsBalloon

Example call to the get method, passing myMap as the collection parameter. This returns the balloon manager for the object manager.

```javascript
ymaps.objectManager.addon.objectsBalloon.get(myMap)
```

--------------------------------

### start([options])

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/router.Editor

Enables the route editor. Accepts an optional options object to control adding, editing, and removing of waypoints and via points.

```APIDOC
## start([options])

### Description
Enables the route editor.

### Method
start

### Signature
`{} start([options])`

### Parameters
#### options (Object) - Optional
Options for the editor.

- **addViaPoints** (Boolean) - Optional - Default: true - If true, adding transit points is allowed; if false, prohibited.
- **addWayPoints** (Boolean) - Optional - Default: false - If true, adding waypoints by clicking on the map is allowed; if false, prohibited.
- **editViaPoints** (Boolean) - Optional - Default: true - If true, editing (moving) transit points is allowed; if false, prohibited.
- **editWayPoints** (Boolean) - Optional - Default: true - If true, editing (moving) waypoints is allowed; if false, prohibited.
- **removeViaPoints** (Boolean) - Optional - Default: true - If true, removing transit points by double-click is allowed; if false, prohibited.
- **removeWayPoints** (Boolean) - Optional - Default: false - If true, removing waypoints by double-click is allowed; if false, prohibited.

### Response
Returns an empty object `{}`.
```

--------------------------------

### IRoutePanel options

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IRoutePanel

Менеджер опций панели маршрута. Позволяет настраивать поведение панели: отображение кнопки смены точек, обратное геокодирование, автоматическое изменение отступов карты и доступные типы маршрутизации.

```APIDOC
## IRoutePanel options

### Description
Менеджер опций панели маршрута. Позволяет настраивать поведение панели: отображение кнопки смены точек, обратное геокодирование, автоматическое изменение отступов карты и доступные типы маршрутизации.

### Properties
- **allowSwitch** (Boolean) - Опционально, по умолчанию true. Показывать на панели кнопку, позволяющую менять местами начальную и конечную точки маршрута.
- **reverseGeocoding** (Boolean) - Опционально, по умолчанию true. Включить ли обратное геокодирование при построении маршрута.
- **adjustMapMargin** (Boolean) - Опционально, по умолчанию false. Будет ли панель маршрута регистрировать свои размеры в map.margin.Manager.
- **types** (Object) - Опционально, по умолчанию { auto: true, masstransit: true, pedestrian: true, bicycle: true, taxi: false }. Типы маршрутизации, доступные для выбора пользователю. При изменении опции возможных типов маршрута, текущий выбранный тип автоматически меняется. Доступные типы отображаются в панели только если задано два или более типа. Для использования типа "такси" требуется обновить правила CSP.
```

--------------------------------

### getExtremeObject: synchronous example

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoQueryResult

Shows how to get the northernmost object synchronously and open its balloon.

```javascript
// Пример работы при синхронных операциях.
// Откроем балун на самом северном объекте.
var topObject = ymaps.geoQuery(myMap.geoObjects).getExtremeObject('top');
topObject.balloon.open();
```

--------------------------------

### Full example with require and get

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/util.AsyncStorage

Creates an AsyncStorage instance, defines multiple keys with dependencies, then uses require and get to retrieve values. Demonstrates that after asynchronous access, values are available synchronously.

```javascript
var asyncStorage = new ymaps.util.AsyncStorage();
asyncStorage
    .define('red', function (provide) {
        provide('#FF0000');
     })
    .define('green', function (provide) {
        setTimeout(function () {
            provide('#008000');
        }, 400);
    })
    .define('yellow', function (provide) {
         provide('#FFFF00');
    })
    .define('violet', ['yellow'], function (provide, yellow) {
        setTimeout(function () {
            provide('#9B30FF');
        }, 400);
    });
// Запрашиваетм
asyncStorage.require(['red', 'green', 'violet'])
    .spread(function (red, green, violet) {
         // Выводит #FF0000, #008000, #9B30FF.
         console.log(red, green, violet);
         // После первого асинхронного доступа значения можно получить через синхронный интерфейс.
         // Выводит #FF0000 #008000.
         console.log(asyncStorage.get('red'), asyncStorage.get('green'), asyncStorage.get('violet'));
         // Значение ключа 'yellow' теперь тоже содержится в хранилище, 
        // так как было необходимо для определения 'violet'.

         // Выводит #FFFF00.
         console.log(asyncStorage.get('yellow'));
    });
```

--------------------------------

### begin

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.action.Manager

Event triggered when an action starts. Provides an Event instance with the 'action' field containing the started action.

```APIDOC
## Event: begin

### Description
Event triggered when an action starts.

### Event Name
begin

### Event Object
Instance of [Event](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event).

### Fields (via Event.get)
- **action** - The started action.

```

--------------------------------

### getById: Get overlay by object id and set zIndex

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection

Retrieves an overlay by the object's id, then sets its zIndex option to 100. The example uses the 'mouseenter' event to get the objectId.

```javascript
objectManager.objects.add('mouseenter', function (e) {
    var objectId = e.get('objectId'),
        overlay = objectManager.objects.overlays.getById(objectId);
    overlay.options.set('zIndex', 100);
});
```

--------------------------------

### startFraming

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/geometryEditor.LineString

Enables scaling mode for the polyline. The enabling is asynchronous.

```APIDOC
## startFraming

### Description
Enables scaling mode for the polyline. The enabling is asynchronous.

### Method
`{vow.Promise} startFraming()`

### Returns
- **vow.Promise** - A promise that resolves when scaling mode actually starts.
```

--------------------------------

### execute(action)

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.action.Manager

Запускает выполнение действия на карте. Если в этот момент на карте выполняется какое-то другое движение, то оно останавливается (вызывается метод end). Новое движение запускается посредством вызова метода begin.

```APIDOC
## execute(action)

### Description
Запускает выполнение действия на карте. Если в этот момент на карте выполняется какое-то другое движение, то оно останавливается (вызывается метод end). Новое движение запускается посредством вызова метода begin.

### Method
execute

### Endpoint
map.action.Manager.execute(action)

### Parameters
#### Параметры
- **action** - Обязательный - Действие, которое необходимо выполнить на карте.

### Response
Нет возвращаемого значения.
```

--------------------------------

### getExtreme: synchronous example

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoQueryResult

Shows how to get the northernmost coordinate from a GeoQueryResult synchronously using the 'top' key.

```javascript
// Пример работы при синхронных операциях.
alert('Самая северная координата: ', ymaps.geoQuery(myMap.geoObjects).getExtreme('top'));
```

--------------------------------

### enable

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.behavior.Manager

Включает указанные поведения карты.

```APIDOC
## enable

### Description
Включает указанные поведения карты.

### Method
- (не указано)

### Endpoint
- (не указано)

### Parameters
- (не указано)

### Request Example
- (не указано)

### Response
- (не указано)
```

--------------------------------

### getAll: Get array of overlays

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection

Returns an array of all overlay objects in the collection. The example stores the result in a variable.

```javascript
var clusterOverlayArray = objectManager.clusters.overlays.getAll();
```

--------------------------------

### getExtreme: asynchronous example

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoQueryResult

Shows how to get the northernmost coordinate after an asynchronous geocode operation, waiting for the server response.

```javascript
// Пример работы при асинхронных операциях.
var result = ymaps.geoQuery(ymaps.geocode('Новгород'));
// Дождемся ответа от сервера и получим самую северную координату.
result.then(function () {
    alert('Самая северная координата в ответе: ' + result.getExtreme('top'));
});
```

--------------------------------

### startEditing

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/geometryEditor.LineString

Enables editing mode. The enabling is asynchronous.

```APIDOC
## startEditing

### Description
Enables editing mode. The enabling is asynchronous.

### Method
`{vow.Promise} startEditing()`

### Returns
- **vow.Promise** - A promise that resolves when editing mode actually starts, or rejects with the following error code:
  - `Canceled` - editing mode is disabled before it actually starts.
```

--------------------------------

### start([state])

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.EditorAddon

Включает редактор. Необязательный параметр state позволяет задать начальное состояние редактора.

```APIDOC
## start([state])

### Description
Включает редактор.

### Method
start

### Parameters
#### Optional Parameters
- **state** ({data.Manager}) - Менеджер состояния редактора маршрута.

### Returns
Нет возвращаемого значения.

```

--------------------------------

### Get a behavior instance with myMap.behaviors.get

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.behavior.Manager

Returns the behavior instance associated with the given behavior name. The example retrieves the 'drag' behavior.

```javascript
myMap.behaviors.get('drag');
```

--------------------------------

### Enable route editor with ymaps.route

Source: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/router.Route

Example showing how to enable the route editor on a route created with ymaps.route. The editor is started and then stopped after editing.

```javascript
// Включение редактора маршрута.
ymaps.route(['Москва', 'Санкт-Петербург'], function (route) {
    route.editor.start();
    // ...
    // Завершение редактирования маршрута.
    route.editor.stop();
});
```
Tokens:
Raw