---
metadata:
  - name: generator
    content: Diplodoc Platform v5.37.1
alternate:
  - https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/map.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/jsapi-v1-1/doc/ru/llms.txt

# YMaps.Map

Класс для создания и управления картой.
## Конструктор

Имя | Описание
----- | -----
[YMaps.Map](map.md#constructor)(element, options) | Создает карту в указанном HTML-контейнере.


## Поля

Имя | Описание
----- | -----
[converter](map.md#converter) | Преобразователь координат, см. [YMaps.Converter](converter.md).
[coordSystem](map.md#coordSystem) | Система координат [YMaps.ICoordSystem](icoordsystem.md).
[Events](map.md#Events) | Список обрабатываемых событий карты.
[hint](map.md#hint) | Всплывающая подсказка, см. [YMaps.Hint](hint.md).
[tileCoordinates](map.md#tileCoordinates) | Преобразователь пиксельных координат (рассчитаных при максимальном масштабе карты) в тайловые, см. [YMaps.TileCoordinates](tilecoordinates.md).

## События

Имя | Описание
----- | -----
[AddLayer](map.md#event-AddLayer) | Добавление слоя на карту.
[BalloonClose](map.md#event-BalloonClose) | Закрытие балуна.
[BalloonOpen](map.md#event-BalloonOpen) | Открытие балуна.
[BeforeClick](map.md#event-BeforeClick) | Пред-событие, возникает непосредственно перед обработкой картой события щелчка мыши по карте.
[BeforeContextMenu](map.md#event-BeforeContextMenu) | Пред-событие, возникает непосредственно перед обработкой картой события щелчка правой кнопкой мыши по карте.
[BeforeDblClick](map.md#event-BeforeDblClick) | Пред-событие, возникает непосредственно перед обработкой картой события двойного щелчка мыши по карте.
[BeforeDOMMouseScroll](map.md#event-BeforeDOMMouseScroll) | Пред-событие, возникает непосредственно перед обработкой картой события прокрутки колесом мыши.
[BeforeMouseDown](map.md#event-BeforeMouseDown) | Пред-событие, возникает непосредственно перед обработкой картой события нажатия кнопки мыши.
[BeforeMouseMove](map.md#event-BeforeMouseMove) | Пред-событие, возникает непосредственно перед обработкой картой события движения мышью.
[BeforeMouseUp](map.md#event-BeforeMouseUp) | Пред-событие, возникает непосредственно перед обработкой картой события отпускания нажатой кнопки мыши.
[BeforeMultiTouchEnd](map.md#event-BeforeMultiTouchEnd) | Пред-событие, которое возникает непосредственно перед обработкой картой события окончания мультисенсорного ввода.
[BeforeMultiTouchMove](map.md#event-BeforeMultiTouchMove) | Пред-событие, которое возникает непосредственно перед обработкой картой события мультисенсорного ввода.
[BeforeMultiTouchStart](map.md#event-BeforeMultiTouchStart) | Пред-событие, которое возникает непосредственно перед обработкой картой события начала мультисенсорного ввода.
[BoundsChange](map.md#event-BoundsChange) | Изменение границ видимой области карты.
[Click](map.md#event-Click) | Щелчок мыши по карте.
[ContextMenu](map.md#event-ContextMenu) | Щелчок правой кнопкой мыши по карте.
[DblClick](map.md#event-DblClick) | Двойной щелчок мыши по карте.
[Destruct](map.md#event-Destruct) | Карта удалена.
[DOMMouseScroll](map.md#event-DOMMouseScroll) | Прокрутка колесом мыши.
[Drag](map.md#event-Drag) | Перетаскивание карты пользователем продолжается.
[DragEnd](map.md#event-DragEnd) | Перетаскивание карты пользователем завершено.
[DragStart](map.md#event-DragStart) | Начало перетаскивания карты пользователем.
[MouseDown](map.md#event-MouseDown) | Нажатие кнопки мыши.
[MouseMove](map.md#event-MouseMove) | Движение мышью.
[MouseUp](map.md#event-MouseUp) | Нажатая кнопка мыши отпущена.
[Move](map.md#event-Move) | Движение карты продолжается.
[MoveEnd](map.md#event-MoveEnd) | Движение карты завершено.
[MoveStart](map.md#event-MoveStart) | Начало движения карты.
[MultiTouchEnd](map.md#event-MultiTouchEnd) | Окончание мультисенсорного ввода.
[MultiTouchMove](map.md#event-MultiTouchMove) | Мультисенсорный ввод на карте.
[MultiTouchStart](map.md#event-MultiTouchStart) | Начало мультисенсорного ввода на карте.
[Redraw](map.md#event-Redraw) | Произошла перерисовка карты, вследствие изменения размеров карты или ее положения на странице.
[RemoveLayer](map.md#event-RemoveLayer) | Удаление слоя с карты.
[SmoothZoomEnd](map.md#event-SmoothZoomEnd) | Окончание плавного масштабирования карты.
[SmoothZoomStart](map.md#event-SmoothZoomStart) | Начало плавного масштабирования карты.
[TypeChange](map.md#event-TypeChange) | Смена типа карты.
[Update](map.md#event-Update) | Перерисовка (обновление) карты (при изменении центра или коэффициента масштабирования).
[ZoomRangeChange](map.md#event-ZoomRangeChange) | Изменился диапазон доступных масштабов карты.

## Методы

Имя | Возвращает | Описание
----- | ----- | -----
[addControl](map.md#addControl)(control, controlPosition) |  | Добавляет указанный элемент управления на карту.
[addCopyright](map.md#addCopyright)(copyright) |  | Добавляет копирайт на карту.
[addCursor](map.md#addCursor)(cursor) |  | Добавляет на карту новый курсор.
[addLayer](map.md#addLayer)(layer) |  | Добавляет слой на карту.
[addOverlay](map.md#addOverlay)(overlay) |  | Добавляет оверлей на карту.
[closeBalloon](map.md#closeBalloon)() | Boolean | Закрывает балун, показываемый в данный момент на карте.
[dblClickZoomEnabled](map.md#dblClickZoomEnabled)() | Boolean | Проверяет, включена ли возможность изменения коэффициента масштабирования по двойному щелчку кнопкой мыши.
[destructor](map.md#destructor)() |  | Удаляет карту и выбрасывает событие Destruct.
[disableDblClickZoom](map.md#disableDblClickZoom)() |  | Выключает возможность изменения коэффициента масштабирования с помощью двойного щелчка кнопкой мыши (по умолчанию включена).
[disableDragging](map.md#disableDragging)() |  | Выключает возможность перетаскивания карты с помощью мыши (по умолчанию включена).
[disableHotKeys](map.md#disableHotKeys)() |  | Выключает горячие клавиши для функций масштабирования и сдвига карты (по умолчанию выключены).
[disableMagnifier](map.md#disableMagnifier)() |  | Выключает возможность изменения коэффициента масштабирования карты посредством выделения области на карте левой кнопкой мыши (по умолчанию выключена).
[disableRightButtonMagnifier](map.md#disableRightButtonMagnifier)() |  | Выключает возможность выделения области карты правой кнопкой (по умолчанию выключена).
[disableRuler](map.md#disableRuler)() |  | Выключает инструмент "Линейка" на карте (по умолчанию выключен).
[disableScrollZoom](map.md#disableScrollZoom)() |  | Выключает возможность плавной прокрутки карты колесом мыши (по умолчанию выключена).
[draggingEnabled](map.md#draggingEnabled)() | Boolean | Проверяет, включена ли возможность перетаскивания карты с помощью мыши.
[enableDblClickZoom](map.md#enableDblClickZoom)(options) |  | Включает возможность изменения коэффициента масштабирования с помощью двойного щелчка кнопкой мыши (по умолчанию включена).
[enableDragging](map.md#enableDragging)() |  | Включает возможность перетаскивания карты с помощью мыши (по умолчанию включена).
[enableHotKeys](map.md#enableHotKeys)(options) |  | Включает горячие клавиши для функций масштабирования и сдвига карты (по умолчанию выключены).
[enableMagnifier](map.md#enableMagnifier)(options) |  | Включает возможность изменения коэффициента масштабирования карты посредством выделения области на карте левой кнопкой мыши (по умолчанию выключена).
[enableRightButtonMagnifier](map.md#enableRightButtonMagnifier)(options) |  | Включает возможность выделения области карты правой кнопкой (по умолчанию выключена).
[enableRuler](map.md#enableRuler)() |  | Включает инструмент "Линейка" на карте (по умолчанию выключена).
[enableScrollZoom](map.md#enableScrollZoom)(options) |  | Включает возможность плавного масштабирования карты колесом мыши (по умолчанию выключена).
[getBalloon](map.md#getBalloon)() | [YMaps.Balloon](balloon.md) | Возвращает указатель на открытый балун.
[getBounds](map.md#getBounds)(unbounded) | [YMaps.ICoordBounds](icoordbounds.md) | Возвращает текущие границы видимой области карты (viewport).
[getCenter](map.md#getCenter)(unbounded) | [YMaps.ICoordPoint](icoordpoint.md) | Возвращает текущие координаты центра карты.
[getContainer](map.md#getContainer)() | HTMLElement | Возвращает указатель на HTML-элемент, служащий контейнером для карты.
[getContainerSize](map.md#getContainerSize)() | [YMaps.Size](size.md) | Возвращает размер HTML-контейнера, в котором размещена карта.
[getMaxZoom](map.md#getMaxZoom)(bounds, layersOnly) | Integer | Возвращает максимальный коэффициент масштабирования карты, доступный для заданной области.
[getMinZoom](map.md#getMinZoom)(bounds, layersOnly) | Integer | Возвращает минимальный коэффициент масштабирования карты, доступный для заданной области.
[getRulerState](map.md#getRulerState)() | String | Возвращает строковое представление состояния инструмента "Линейка".
[getType](map.md#getType)() | [YMaps.MapType](maptype.md) | Возвращает текущий тип карты.
[getZoom](map.md#getZoom)() | Integer | Возвращает текущий коэффициент масштабирования карты.
[hotKeysEnabled](map.md#hotKeysEnabled)() | Boolean | Проверяет, включены ли горячие клавиши для функций масштабирования и сдвига карты.
[magnifierEnabled](map.md#magnifierEnabled)() | Boolean | Проверяет, включена ли возможность изменения масштаба карты посредством выделения области левой кнопкой мыши.
[moveBy](map.md#moveBy)(pixelsOffset, smooth, options) |  | Смещает центр карты на заданное количество пикселов.
[openBalloon](map.md#openBalloon)(point, content, options) |  | Показывает балун на карте.
[panTo](map.md#panTo)(toPoint, options) |  | Плавно перемещает центр карты в заданную географическую точку.
[redraw](map.md#redraw)(smoothCentering, callback) |  | Перерисовывает карту.
[removeAllOverlays](map.md#removeAllOverlays)() |  | Удаляет все оверлеи с карты.
[removeControl](map.md#removeControl)(control) |  | Удаляет указанный элемент управления с карты.
[removeCopyright](map.md#removeCopyright)(copyright) |  | Удаляет копирайт с карты.
[removeCursor](map.md#removeCursor)(cursor) |  | Удаляет с карты один из ранее добавленных курсоров.
[removeLayer](map.md#removeLayer)(layer) |  | Удаляет слой с карты.
[removeOverlay](map.md#removeOverlay)(overlay) |  | Удаляет указанный оверлей с карты.
[rightButtonMagnifierEnabled](map.md#rightButtonMagnifierEnabled)() | Boolean | Проверяет, включена ли функция выделения области карты правой кнопкой.
[rulerEnabled](map.md#rulerEnabled)() | Boolean | Проверяет, включен ли инструмент "Линейка" на карте.
[scrollZoomEnabled](map.md#scrollZoomEnabled)() | Boolean | Проверяет, включена ли функция плавной прокрутки карты колесом мыши.
[setBounds](map.md#setBounds)(geoBounds) |  | Устанавливает центр карты и коэффициент масштабирования так, чтобы заданная с помощью объекта [YMaps.ICoordBounds](icoordbounds.md) прямоугольная область, была видна в окне карты максимально крупно.
[setCenter](map.md#setCenter)(center, zoom, mapType) |  | Устанавливает центр карты.
[setMaxZoom](map.md#setMaxZoom)(maxZoom) |  | Устанавливает максимальный коэффициент масштабирования карты.
[setMinZoom](map.md#setMinZoom)(minZoom) |  | Устанавливает минимальный коэффициент масштабирования карты.
[setRulerState](map.md#setRulerState)(rulerState) |  | Устанавливает состояние инструмента "Линейка".
[setType](map.md#setType)(mapType) |  | Переключает карту на указанный тип.
[setZoom](map.md#setZoom)(zoom, options) |  | Устанавливает коэффициент масштабирования.
[startMove](map.md#startMove)(direction, options) |  | Начинает плавный сдвиг карты в заданном направлении и с заданной "скоростью".
[stopMove](map.md#stopMove)() |  | Останавливает плавный сдвиг карты.
[update](map.md#update)() |  | Обновляет содержимое карты.
[zoomBy](map.md#zoomBy)(zoomDiff, options) |  | Изменяет коэффициент масштабирования карты на определенную величину.


## Подробное описание конструктора {#constructor}

```javascript
YMaps.Map(element, options)
```

Создает карту в указанном HTML-контейнере.

**Параметры:**

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`element` | HTMLElement |  |  | Указатель на DOM-элемент, который послужит контейнером для карты.
`options` | Object | ![](../_images/check.png) |  | Опции карты.
`options.ignoreResize` | Boolean | ![](../_images/check.png) | false | true - игнорировать события, связанные с изменением размеров страницы, false - обрабатывать.
`options.coordSystem` | [YMaps.ICoordSystem](icoordsystem.md) | ![](../_images/check.png) | YMaps.GeoCoordSystem | Координатная система карты. По умолчанию принята стандартная географическая система координат.
`options.propagateEvents` | Boolean | ![](../_images/check.png) | false | true - разрешить распространение всех событий, обрабатываемых картой, вверх по DOM-структуре документа, false - запретить.

## Подробное описание полей {#field_detail}

### converter {#converter}

```javascript
YMaps.Converter converter
```

Преобразователь координат, см. [YMaps.Converter](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/converter.md).
### coordSystem {#coordSystem}

```javascript
YMaps.ICoordSystem coordSystem
```

Система координат [YMaps.ICoordSystem](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/icoordsystem.md).
### Events {#Events}

```javascript
Object Events
```

Список обрабатываемых событий карты.
### hint {#hint}

```javascript
YMaps.Hint hint
```

Всплывающая подсказка, см. [YMaps.Hint](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hint.md).
### tileCoordinates {#tileCoordinates}

```javascript
YMaps.TileCoordinates tileCoordinates
```

Преобразователь пиксельных координат (рассчитаных при максимальном масштабе карты) в тайловые, см. [YMaps.TileCoordinates](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/tilecoordinates.md).

## Подробное описание событий {#event_detail}

### AddLayer {#event-AddLayer}

```javascript
AddLayer
```
 Добавление слоя на карту. 
В callback-функцию передаются два аргумента:

- указатель на карту;
- указатель на добавленный слой.
### BalloonClose {#event-BalloonClose}

```javascript
BalloonClose
```

Закрытие балуна.

В callback-функцию передается указатель на карту, для которой был вызван обработчик.
### BalloonOpen {#event-BalloonOpen}

```javascript
BalloonOpen
```

Открытие балуна.

В callback-функцию передается указатель на карту, для которой был вызван обработчик.
### BeforeClick {#event-BeforeClick}

```javascript
BeforeClick
```

Пред-событие, возникает непосредственно перед обработкой картой события щелчка мыши по карте.

В callback-функцию передаются два аргумента:

- указатель на карту;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md).
### BeforeContextMenu {#event-BeforeContextMenu}

```javascript
BeforeContextMenu
```

Пред-событие, возникает непосредственно перед обработкой картой события щелчка правой кнопкой мыши по карте.

В callback-функцию передаются два аргумента:

- указатель на карту;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md).
### BeforeDblClick {#BeforeDblClick}

```javascript
BeforeDblClick
```

Пред-событие, возникает непосредственно перед обработкой картой события двойного щелчка мыши по карте.

В callback-функцию передаются два аргумента:

- указатель на карту;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md).
### BeforeDOMMouseScroll {#event-BeforeDOMMouseScroll}

```javascript
BeforeDOMMouseScroll
```

Пред-событие, возникает непосредственно перед обработкой картой события прокрутки колесом мыши.

В callback-функцию передаются два аргумента:

- указатель на карту;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md).
### BeforeMouseDown {#event-BeforeMouseDown}

```javascript
BeforeMouseDown
```

Пред-событие, возникает непосредственно перед обработкой картой события нажатия кнопки мыши.

В callback-функцию передаются два аргумента:

- указатель на карту;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md).
### BeforeMouseMove {#event-BeforeMouseMove}

```javascript
BeforeMouseMove
```

Пред-событие, возникает непосредственно перед обработкой картой события движения мышью.

В callback-функцию передаются два аргумента:

- указатель на карту;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md).
### BeforeMouseUp {#event-BeforeMouseUp}

```javascript
BeforeMouseUp
```

Пред-событие, возникает непосредственно перед обработкой картой события отпускания нажатой кнопки мыши.

В callback-функцию передаются два аргумента:

- указатель на карту;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md).
### BeforeMultiTouchEnd {#event-BeforeMultiTouchEnd}

```javascript
BeforeMultiTouchEnd
```

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

В callback-функцию передаются два аргумента:

- указатель на карту;
- объект [YMaps.MultiTouchEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/multitouchevent.md).
### BeforeMultiTouchMove {#event-BeforeMultiTouchMove}

```javascript
BeforeMultiTouchMove
```

Пред-событие, которое возникает непосредственно перед обработкой картой события мультисенсорного ввода.

В callback-функцию передаются два аргумента:

- указатель на карту;
- объект [YMaps.MultiTouchEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/multitouchevent.md).
### BeforeMultiTouchStart {#event-BeforeMultiTouchStart}

```javascript
BeforeMultiTouchStart
```

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

В callback-функцию передаются два аргумента:

- указатель на карту;
- объект [YMaps.MultiTouchEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/multitouchevent.md).
### BoundsChange {#event-BoundsChange}

```javascript
BoundsChange
```

Изменение границ видимой области карты. В callback-функцию передается указатель на карту.
### Click {#event-Click}

```javascript
Click
```

Щелчок мыши по карте.

В callback-функцию передаются два аргумента:

- указатель на карту;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md).
### ContextMenu {#event-ContextMenu}

```javascript
ContextMenu
```

Щелчок правой кнопкой мыши по карте.

В callback-функцию передаются два аргумента:

- указатель на карту;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md).
### DblClick {#event-DblClick}

```javascript
DblClick
```

Двойной щелчок мыши по карте.

В callback-функцию передаются два аргумента:

- указатель на карту;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md).
### Destruct {#event-Destruct}

```javascript
Destruct
```

Карта удалена. В callback-функцию передается указатель на карту.
### DOMMouseScroll {#event-DOMMouseScroll}

```javascript
DOMMouseScroll
```

Прокрутка колесом мыши.

В callback-функцию передаются два аргумента:

- указатель на карту;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md).
### Drag {#event-Drag}

```javascript
Drag
```
 Перетаскивание карты пользователем продолжается. 
В callback-функцию передаются два аргумента:

- указатель на карту;
- объект [YMaps.Point](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/point.md) со значением смещения центра карты в пикселах относительно его предыдущего положения.
### DragEnd {#event-DragEnd}

```javascript
DragEnd
```

Перетаскивание карты пользователем завершено. В callback-функцию передается указатель на карту.
### DragStart {#event-DragStart}

```javascript
DragStart
```

Начало перетаскивания карты пользователем. В callback-функцию передается указатель на карту.
### MouseDown {#event-MouseDown}

```javascript
MouseDown
```

Нажатие кнопки мыши.

В callback-функцию передаются два аргумента:

- указатель на карту;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md).
### MouseMove {#event-MouseMove}

```javascript
MouseMove
```

Движение мышью.

В callback-функцию передаются два аргумента:

- указатель на карту;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md).
### MouseUp {#event-MouseUp}

```javascript
MouseUp
```

Нажатая кнопка мыши отпущена.

В callback-функцию передаются два аргумента:

- указатель на карту;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md).
### Move {#event-Move}

```javascript
Move
```
 Движение карты продолжается. 
В callback-функцию передаются два аргумента:

- указатель на карту;
- объект [YMaps.Point](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/point.md) со значением смещения центра карты в пикселах относительно его предыдущего положения.
### MoveEnd {#event-MoveEnd}

```javascript
MoveEnd
```

Движение карты завершено. В callback-функцию передается указатель на карту.
### MoveStart {#event-MoveStart}

```javascript
MoveStart
```

Начало движения карты. В callback-функцию передается указатель на карту.
### MultiTouchEnd {#event-MultiTouchEnd}

```javascript
MultiTouchEnd
```

Окончание мультисенсорного ввода.

В callback-функцию передаются два аргумента:

- указатель на карту;
- объект [YMaps.MultiTouchEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/multitouchevent.md).
### MultiTouchMove {#event-MultiTouchMove}

```javascript
MultiTouchMove
```

Мультисенсорный ввод на карте.

В callback-функцию передаются два аргумента:

- указатель на карту;
- объект [YMaps.MultiTouchEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/multitouchevent.md).
### MultiTouchStart {#event-MultiTouchStart}

```javascript
MultiTouchStart
```

Начало мультисенсорного ввода на карте.

В callback-функцию передаются два аргумента:

- указатель на карту;
- объект [YMaps.MultiTouchEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/multitouchevent.md).
### Redraw {#event-Redraw}

```javascript
Redraw
```

Произошла перерисовка карты, вследствие изменения размеров карты или ее положения на странице. В callback-функцию передается указатель на карту.
### RemoveLayer {#event-RemoveLayer}

```javascript
RemoveLayer
```
 Удаление слоя с карты. 
В callback-функцию передаются два аргумента:

- указатель на карту;
- указатель на удаленный слой.
### SmoothZoomEnd {#event-SmoothZoomEnd}

```javascript
SmoothZoomEnd
```

Окончание плавного масштабирования карты. В callback-функцию передается указатель на карту.
### SmoothZoomStart {#event-SmoothZoomStart}

```javascript
SmoothZoomStart
```

Начало плавного масштабирования карты. В callback-функцию передается указатель на карту.
### TypeChange {#event-TypeChange}

```javascript
TypeChange
```

Смена типа карты. В callback-функцию передается указатель на карту.
### Update {#event-Update}

```javascript
Update
```

Перерисовка (обновление) карты (при изменении центра или коэффициента масштабирования). В callback-функцию передается указатель на карту.
### ZoomRangeChange {#event-ZoomRangeChange}

```javascript
ZoomRangeChange
```
 Изменился диапазон доступных масштабов карты. 
Диапазон рассчитывается с учетом ограничений коэффициента масштабирования, установленных для типа карты и самой карты.

В callback-функцию передаются два аргумента:

- указатель на карту;
- Объект с полями min и max, указывающими минимальный и максимальный коэффициенты масштабирования для видимой области карты.
## Подробное описание методов {#method_detail}

### AddControl {#AddControl}

```javascript
addControl(control, controlPosition)
```

Добавляет указанный элемент управления на карту.

**Параметры:**

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`control` | [YMaps.IControl](icontrol.md) |  |  | Указатель на добавляемый элемент управления.
`controlPosition` | [YMaps.ControlPosition](controlposition.md) | ![](../_images/check.png) |  | Расположение элемента управления.

### addCopyright {#addCopyright}

```javascript
addCopyright(copyright)
```

Добавляет копирайт на карту.

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`copyright` | String | Tекст копирайта.

### addCursor {#addCursor}

```javascript
addCursor(cursor)
```

Добавляет на карту новый курсор.

Разрешается добавлять на карту произвольное количество курсоров, но применяется только один (тот, который был добавлен последним). Список доступных курсоров приводится в описании объекта [YMaps.Cursor](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/cursor.md).

Удалить курсор можно с помощью метода [YMaps.Map.removeCursor](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/map.md#removeCursor).

**Пример:**

```javascript
// Добавляет на тулбар кнопку "Помощь", при нажатии на которую курсор будет меняться на значок вопроса ("help").
var toolBar = new YMaps.ToolBar(),
    helpButton = new YMaps.ToolBarToggleButton({ caption: 'Помощь' });
toolBar.add(helpButton);
YMaps.Events.observe(helpButton, helpButton.Events.Select, function () {
    map.addCursor(YMaps.Cursor.HELP);
});
YMaps.Events.observe(helpButton, helpButton.Events.Deselect, function () {
    map.removeCursor(YMaps.Cursor.HELP);
});
map.addControl(toolBar);
```

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`cursor` | [YMaps.Cursor](cursor.md) | Курсор.

### addLayer {#addLayer}

```javascript
addLayer(layer)
```

Добавляет слой на карту.

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`layer` | [YMaps.ILayer](ilayer.md)|String | Слой, который нужно добавить на карту. Слой может быть задан как ключом, так и указателем на экземпляр.

### addOverlay {#addOverlay}

```javascript
addOverlay(overlay)
```

Добавляет оверлей на карту.

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`overlay` | [YMaps.IOverlay](ioverlay.md) | Указатель на оверлей.

### closeBalloon {#closeBalloon}

```javascript
{Boolean} closeBalloon()
```

Закрывает балун, показываемый в данный момент на карте.

**Возвращает:**

Тип | Описание
----- | -----
Boolean | true - балун закрыт.

### dblClickZoomEnabled {#dblClickZoomEnabled}

```javascript
{Boolean} dblClickZoomEnabled()
```

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

**Возвращает:**

Тип | Описание
----- | -----
Boolean | true - включена, false - выключена.

### destructor {#destructor}

```javascript
destructor()
```

Удаляет карту и выбрасывает событие Destruct.
### disableDblClickZoom {#disableDblClickZoom}

```javascript
disableDblClickZoom()
```

Выключает возможность изменения коэффициента масштабирования с помощью двойного щелчка кнопкой мыши (по умолчанию включена).

Двойной щелчок левой кнопкой - увеличить коэффициент масштабирования (+), правой кнопкой - уменьшить коэффициент масштабирования (-).
### disableDragging {#disableDragging}

```javascript
disableDragging()
```

Выключает возможность перетаскивания карты с помощью мыши (по умолчанию включена).
### disableHotKeys {#disableHotKeys}

```javascript
disableHotKeys()
```

Выключает горячие клавиши для функций масштабирования и сдвига карты (по умолчанию выключены).
### disableMagnifier {#disableMagnifier}

```javascript
disableMagnifier()
```

Выключает возможность изменения коэффициента масштабирования карты посредством выделения области на карте левой кнопкой мыши (по умолчанию выключена).
### disableRightButtonMagnifier {#disableRightButtonMagnifier}

```javascript
disableRightButtonMagnifier()
```

Выключает возможность выделения области карты правой кнопкой (по умолчанию выключена).
### disableRuler {#disableRuler}

```javascript
disableRuler()
```

Выключает инструмент "Линейка" на карте (по умолчанию выключен).
### disableScrollZoom {#disableScrollZoom}

```javascript
disableScrollZoom()
```

Выключает возможность плавной прокрутки карты колесом мыши (по умолчанию выключена).
### draggingEnabled {#draggingEnabled}

```javascript
{Boolean} draggingEnabled()
```

Проверяет, включена ли возможность перетаскивания карты с помощью мыши.

**Возвращает:**

Тип | Описание
----- | -----
Boolean | true - включена, false - выключена.

### enableDblClickZoom {#enableDblClickZoom}

```javascript
enableDblClickZoom(options)
```

Включает возможность изменения коэффициента масштабирования с помощью двойного щелчка кнопкой мыши (по умолчанию включена).

Двойной щелчок левой кнопкой - увеличить коэффициент масштабирования (+), правой кнопкой - уменьшить коэффициент масштабирования (-).

**Параметры:**

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`options` | Object | ![](../_images/check.png) |  | Опции.
`options.smooth` | Boolean | ![](../_images/check.png) | true | Плавное масштабирование.

### enableDragging {#enableDragging}

```javascript
enableDragging()
```

Включает возможность перетаскивания карты с помощью мыши (по умолчанию включена).
### enableHotKeys {#enableHotKeys}

```javascript
enableHotKeys(options)
```

Включает горячие клавиши для функций масштабирования и сдвига карты (по умолчанию выключены).

**См.:** [Горячие клавиши](https://yandex.ru/dev/jsapi-v1-1/doc/ru/dg/concepts/map-controls-built-in.md)

**Параметры:**

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`options` | Object | ![](../_images/check.png) |  | Опции.
`options.smooth` | Boolean | ![](../_images/check.png) | false | Плавное масштабирование.

### enableMagnifier {#enableMagnifier}

```javascript
enableMagnifier(options)
```

Включает возможность изменения коэффициента масштабирования карты посредством выделения области на карте левой кнопкой мыши (по умолчанию выключена).

**Параметры:**

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`options` | Object | ![](../_images/check.png) |  | Опции.
`options.smooth` | Boolean | ![](../_images/check.png) | false | Плавное масштабирование.

### enableRightButtonMagnifier {#enableRightButtonMagnifier}

```javascript
enableRightButtonMagnifier(options)
```

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

**Параметры:**

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`options` | Object | ![](../_images/check.png) |  | Опции.
`options.smooth` | Boolean | ![](../_images/check.png) | false | Плавное масштабирование.

### enableRuler {#enableRuler}

```javascript
enableRuler()
```

Включает инструмент "Линейка" на карте (по умолчанию выключена).
### enableScrollZoom {#enableScrollZoom}

```javascript
enableScrollZoom(options)
```

Включает возможность плавного масштабирования карты колесом мыши (по умолчанию выключена).

**Параметры:**

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`options` | Object | ![](../_images/check.png) |  | Опции.
`options.smooth` | Boolean | ![](../_images/check.png) | true | true - применять плавное масштабирование карты, false - нет.

### getBalloon {#getBalloon}

```javascript
{YMaps.Balloon} getBalloon()
```

Возвращает указатель на открытый балун.

**Возвращает:**

Тип | Описание
----- | -----
[YMaps.Balloon](balloon.md) | Указатель на открытый балун.

### getBounds {#getBounds}

```javascript
{YMaps.ICoordBounds} getBounds(unbounded)
```

Возвращает текущие границы видимой области карты (viewport).

**См.:** [Преобразование координат](https://yandex.ru/dev/jsapi-v1-1/doc/ru/dg/concepts/coordinates_conversion.md)

**Параметры:**

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`unbounded` | Boolean | ![](../_images/check.png) | false | true - границы карты заданы неограниченными точками, false - ограниченными.


**Возвращает:**

Тип | Описание
----- | -----
[YMaps.ICoordBounds](icoordbounds.md) | Границы видимой области карты.

### getCenter {#getCenter}

```javascript
{YMaps.ICoordPoint} getCenter(unbounded)
```

Возвращает текущие координаты центра карты.

**См.:** [Преобразование координат](https://yandex.ru/dev/jsapi-v1-1/doc/ru/dg/concepts/coordinates_conversion.md)

**Параметры:**

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`unbounded` | Boolean | ![](../_images/check.png) | false | true - центр карты задан неограниченной точкой, false - ограниченной.


**Возвращает:**

Тип | Описание
----- | -----
[YMaps.ICoordPoint](icoordpoint.md) | Координаты центра карты.

### getContainer {#getContainer}

```javascript
{HTMLElement} getContainer()
```

Возвращает указатель на HTML-элемент, служащий контейнером для карты.

**Возвращает:**

Тип | Описание
----- | -----
HTMLElement | Указатель на HTML-элемент, служащий контейнером для карты.

### getContainerSize {#getContainerSize}

```javascript
{YMaps.Size} getContainerSize()
```

Возвращает размер HTML-контейнера, в котором размещена карта.

**Возвращает:**

Тип | Описание
----- | -----
[YMaps.Size](size.md) | Размер HTML-контейнера, в котором размещена карта.

### getMaxZoom {#getMaxZoom}

```javascript
{Integer} getMaxZoom(bounds, layersOnly)
```

Возвращает максимальный коэффициент масштабирования карты, доступный для заданной области.

Если не задан параметр layersOnly, то максимальный коэффициент масштабирования рассчитывается следующим образом: берется максимальный из всех текущих коэффициентов масштабирования слоев карты, затем расширяется значением maxZoom из [YMaps.MapType](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/maptype.md), а затем ограничивается значением, заданным в [YMaps.Map.setMaxZoom](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/map.md#setMaxZoom) и максимальным масштабом текущей координатной системы.

**Параметры:**

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`bounds` | [YMaps.ICoordBounds](icoordbounds.md) | ![](../_images/check.png) |  | Область, для которой требуется расчитать максимальный масштаб. По умолчанию берется текущая видимая область.
`layersOnly` | Boolean | ![](../_images/check.png) | false | Использовать только данные по слоям, игнорируя дополнения и ограничения.


**Возвращает:**

Тип | Описание
----- | -----
Integer | Коэффициент масштабирования карты или null, если установлен флаг layersOnly и данные по слоям не были найдены.

### getMinZoom {#getMinZoom}

```javascript
{Integer} getMinZoom(bounds, layersOnly)
```

Возвращает минимальный коэффициент масштабирования карты, доступный для заданной области.

Если не задан параметр layersOnly, то минимальный коэффициент масштабирования рассчитывается следующим образом: берется минимальный из всех текущих коэффициентов масштабирования слоев карты, затем расширяется значением minZoom из [YMaps.MapType](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/maptype.md), а затем ограничивается значением, заданным в [YMaps.Map.setMinZoom](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/map.md#setMinZoom) и 0.

**Параметры:**

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`bounds` | [YMaps.ICoordBounds](icoordbounds.md) | ![](../_images/check.png) |  | Область, для которой требуется расчитать минимальный масштаб. По умолчанию берется текущая видимая область.
`layersOnly` | Boolean | ![](../_images/check.png) | false | Использовать только данные по слоям, игнорируя дополнения и ограничения.


**Возвращает:**

Тип | Описание
----- | -----
Integer | Коэффициент масштабирования карты или null, если установлен флаг layersOnly и данные по слоям не были найдены.

### getRulerState {#getRulerState}

```javascript
{String} getRulerState()
```

Возвращает строковое представление состояния инструмента "Линейка".

Если инструментом не было проставлено ни одной метки на карте, то метод вернет пустую строку. Если метки были проставлены, то в строке будут перечислены координаты проставленных меток, причем, для первой метки географические координаты будут указаны целиком, а для всех остальных - заданы в виде смещения относительно первой метки. В качестве разделителя меток используется тильда (~).

**Возвращает:**

Тип | Описание
----- | -----
String | Состояние инструмента "Линейка".

### getType {#getType}

```javascript
{YMaps.MapType} getType()
```

Возвращает текущий тип карты.

**Возвращает:**

Тип | Описание
----- | -----
[YMaps.MapType](maptype.md) | Текущий тип карты.

### getZoom {#getZoom}

```javascript
{Integer} getZoom()
```

Возвращает текущий коэффициент масштабирования карты.

**Возвращает:**

Тип | Описание
----- | -----
Integer | Коэффициент масштабирования карты.

### hotKeysEnabled {#hotKeysEnabled}

```javascript
{Boolean} hotKeysEnabled()
```

Проверяет, включены ли горячие клавиши для функций масштабирования и сдвига карты.

**Возвращает:**

Тип | Описание
----- | -----
Boolean | true - включены, false - выключены.

### magnifierEnabled {#magnifierEnabled}

```javascript
{Boolean} magnifierEnabled()
```

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

**Возвращает:**

Тип | Описание
----- | -----
Boolean | true - включена, false - нет.

### moveBy {#moveBy}

```javascript
moveBy(pixelsOffset, smooth, options)
```

Смещает центр карты на заданное количество пикселов.

В зависимости от параметров вызова смещение может происходить плавно или за один шаг. Скорость - это дистанция в пикселах, которую преодолевает карта на каждом шаге плавного движения.


{% note alert %}

Перед использованием данного метода следует инициализировать карту.

{% endnote %}


**Пример:**

```javascript
// Смещает центр карты на северо-северо-запад, по окончании смещения открывает балун.
map.moveBy(new YMaps.Point(1000,-2000), true, {
    speed: 20,
    startSpeed: 10,
    speedUpTime: 200,
    callback: function (state) {
        if (state == YMaps.State.SUCCESS) {
            map.openBalloon(map.getCenter(), 'Приехали!');
        }
    }
});
```

**Параметры:**

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`pixelsOffset` | [YMaps.Point](point.md) |  |  | Величина сдвига (в пикселах).
`smooth` | Boolean | ![](../_images/check.png) | false | true - смещение происходит плавно, false - за один шаг.
`options` | Object | ![](../_images/check.png) |  | Параметры смещения.
`options.speed` | Number | ![](../_images/check.png) | 37 | Итоговая скорость.
`options.startSpeed` | Number | ![](../_images/check.png) | 5 | Начальная скорость.
`options.speedUpTime` | Number | ![](../_images/check.png) | 120 | Время разгона (в миллисекундах).
`options.callback` | Function | ![](../_images/check.png) |  | Функция-обработчик для события окончания смещения карты. Параметром передается результат сдвига карты: [YMaps.State.SUCCESS](state.md#SUCCESS) - успешно, [YMaps.State.FAILURE](state.md#FAILURE) - неуспешно.

### openBalloon {#openBalloon}

```javascript
openBalloon(point, content, options)
```

Показывает балун на карте.

**Пример:**

```javascript
// Показывает балун в центре Москвы.
map.openBalloon(new YMaps.GeoPoint(37.616485,55.751635), 'Москва', {hasCloseButton: false, mapAutoPan: 0});
```

**Параметры:**

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`point` | [YMaps.ICoordPoint](icoordpoint.md) |  |  | Координаты "хвостика" балуна на карте.
`content` | HTMLElement|String |  |  | Содержимое балуна (может быть как текстом, так и указателем на HTML-элемент).
`options` | [YMaps.MapBalloonOptions](mapballoonoptions.md) | ![](../_images/check.png) |  | Опции балуна.

### panTo {#panTo}

```javascript
panTo(toPoint, options)
```

Плавно перемещает центр карты в заданную географическую точку. Если расстояние между текущим центром и заданной точкой в три раза больше размера карты, то функция работает как setCenter, либо имитирует полет из одной точки в другую (если flying = true).

**Параметры:**

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`toPoint` | [YMaps.ICoordPoint](icoordpoint.md)|[YMaps.ICoordPoint](icoordpoint.md)[] |  |  | Координаты точки, в которую должен переместиться центр. карты. Если передан массив точек, то центр карты будет перемещаться в них последовательно.
`options` | Object | ![](../_images/check.png) |  | Параметры перемещения.
`options.flying` | Boolean | ![](../_images/check.png) | false | Использовать имитацию полета, если расстояние между центром карты и заданной точкой превышает размер карты более чем в три раза.
`options.callback` | Function | ![](../_images/check.png) |  | Обработчик события окончания перемещения. Параметром передается результат перемещения центра карты: [YMaps.State.SUCCESS](state.md#SUCCESS) - успешно, [YMaps.State.FAILURE](state.md#FAILURE) - неуспешно.

### redraw {#redraw}

```javascript
redraw(smoothCentering, callback)
```

Перерисовывает карту.

Необходимо вызывать каждый раз при программном изменении размера карты или ее положения на странице. Самостоятельно отслеживает случаи изменения размеров самой страницы с картой (эта возможность отключается опцией карты ignoreResize).

**Параметры:**

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`smoothCentering` | Boolean | ![](../_images/check.png) | true | true - плавно сдвигать карту так, чтобы географические координаты ее центра после изменения размеров оставались прежними. false - не сдвигать карту.
`callback` | Function | ![](../_images/check.png) |  | Обработчик события окончания плавного центрирования карты. Параметром передается результат центрирования карты: [YMaps.State.SUCCESS](state.md#SUCCESS) - успешно, [YMaps.State.FAILURE](state.md#FAILURE) - неуспешно.

### removeAllOverlays {#removeAllOverlays}

```javascript
removeAllOverlays()
```

Удаляет все оверлеи с карты.
### removeControl {#removeControl}

```javascript
removeControl(control)
```

Удаляет указанный элемент управления с карты.

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`control` | [YMaps.IControl](icontrol.md) | Указатель на удаляемый элемент управления.

### removeCopyright {#removeCopyright}

```javascript
removeCopyright(copyright)
```

Удаляет копирайт с карты.

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`copyright` | String | Текст копирайта.

### removeCursor {#removeCursor}

```javascript
removeCursor(cursor)
```

Удаляет с карты один из ранее добавленных курсоров.

Если удаляемый курсор является активным, то активным становится предыдущий добавленный (и не удаленный) курсор. Если было добавлено несколько курсоров с одним именем, то удаляется тот, который был добавлен позже других.

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`cursor` | [YMaps.Cursor](cursor.md) | Курсор.

### removeLayer {#removeLayer}

```javascript
removeLayer(layer)
```

Удаляет слой с карты.

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`layer` | [YMaps.ILayer](ilayer.md)|String | Слой карты, который нужно удалить. Слой может быть задан как ключом, так и указателем на экземпляр.

### removeOverlay {#removeOverlay}

```javascript
removeOverlay(overlay)
```

Удаляет указанный оверлей с карты.

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`overlay` | [YMaps.IOverlay](ioverlay.md) | Указатель на оверлей.

### rightButtonMagnifierEnabled {#rightButtonMagnifierEnabled}

```javascript
{Boolean} rightButtonMagnifierEnabled()
```

Проверяет, включена ли функция выделения области карты правой кнопкой.

**Возвращает:**

Тип | Описание
----- | -----
Boolean | true - включена, false - выключена.

### rulerEnabled {#rulerEnabled}

```javascript
{Boolean} rulerEnabled()
```

Проверяет, включен ли инструмент "Линейка" на карте.

**Возвращает:**

Тип | Описание
----- | -----
Boolean | true - включен, false - выключен.

### scrollZoomEnabled {#scrollZoomEnabled}

```javascript
{Boolean} scrollZoomEnabled()
```

Проверяет, включена ли функция плавной прокрутки карты колесом мыши.

**Возвращает:**

Тип | Описание
----- | -----
Boolean | true - включена, false - выключена.

### setBounds {#setBounds}

```javascript
setBounds(geoBounds)
```

Устанавливает центр карты и коэффициент масштабирования так, чтобы заданная с помощью объекта [YMaps.ICoordBounds](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/icoordbounds.md) прямоугольная область, была видна в окне карты максимально крупно.

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`geoBounds` | [YMaps.ICoordBounds](icoordbounds.md) | Границы, которые необходимо установить карте.

### setCenter {#setCenter}

```javascript
setCenter(center, zoom, mapType)
```

Устанавливает центр карты.

**Параметры:**

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`center` | [YMaps.ICoordPoint](icoordpoint.md) |  |  | Координаты центра карты.
`zoom` | Integer | ![](../_images/check.png) |  | Коэффициент масштабирования.
`mapType` | [YMaps.MapType](maptype.md) | ![](../_images/check.png) |  | Тип карты.

### setMaxZoom {#setMaxZoom}

```javascript
setMaxZoom(maxZoom)
```

Устанавливает максимальный коэффициент масштабирования карты.

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`maxZoom` | Integer | Максимальный коэффициент масштабирования.

### setMinZoom {#setMinZoom}

```javascript
setMinZoom(minZoom)
```

Устанавливает минимальный коэффициент масштабирования карты.

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`minZoom` | Integer | Минимальный коэффициент масштабирования.

### setRulerState {#setRulerState}

```javascript
setRulerState(rulerState)
```

Устанавливает состояние инструмента "Линейка".

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`rulerState` | String | Строковое представление состояния инструмента "Линейка".

### setType {#setType}

```javascript
setType(mapType)
```

Переключает карту на указанный тип.

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`mapType` | [YMaps.MapType](maptype.md) | Тип карты.

### setZoom {#setZoom}

```javascript
setZoom(zoom, options)
```

Устанавливает коэффициент масштабирования.

**Параметры:**

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`zoom` | Integer |  |  | Коэффициент масштабирования.
`options` | Object | ![](../_images/check.png) |  | Опции.
`options.smooth` | Boolean | ![](../_images/check.png) | false | Флаг, указывающий, что масштабирование должно происходить плавно.
`options.position` | [YMaps.ICoordPoint](icoordpoint.md) | ![](../_images/check.png) |  | Позиция, сохраняемая при плавной установке коэффициента масштабирования.
`options.centering` | Boolean | ![](../_images/check.png) | false | Флаг, указывающий, что по окончании плавного масштабирования позиция, заданная в options.position, должна совпасть с центром карты.
`options.callback` | Function | ![](../_images/check.png) |  | Обработчик окончания изменения коэффициента масштабирования. Параметром передается результат изменения: [YMaps.State.SUCCESS](state.md#SUCCESS) - успешно, [YMaps.State.FAILURE](state.md#FAILURE) - неуспешно.

### startMove {#startMove}

```javascript
startMove(direction, options)
```

Начинает плавный сдвиг карты в заданном направлении и с заданной "скоростью".

Скорость движения карты - это дистанция в пикселах, которую преодолевает карта за каждый шаг плавного сдвига.


{% note alert %}

Перед использованием данного метода следует инициализировать карту.

{% endnote %}


**Пример:**

```javascript
// Плавно сдвигает центр карты по направлению на юго-юго-запад, по окончании сдвига открывает балун.
map.startMove(new YMaps.Point(1,2), {
    speed: 20,
    startSpeed: 10,
    speedUpTime: 200,
    callback: function() {
        if (state == YMaps.State.SUCCESS) {
            map.openBalloon(map.getCenter(), 'Приехали!');
        }
    }
});
// Остановка через 3 секунды.
window.setTimeout(function(){ map.stopMove(); }, 3000);
```

**Параметры:**

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`direction` | [YMaps.Point](point.md) |  |  | Вектор направления сдвига.
`options` | Object | ![](../_images/check.png) |  | Параметры движения.
`options.speed` | Number | ![](../_images/check.png) | 37 | Конечная скорость разгона.
`options.startSpeed` | Number | ![](../_images/check.png) | 5 | Начальная скорость разгона.
`options.speedUpTime` | Number | ![](../_images/check.png) | 120 | Время разгона карты до конечной скорости (в миллисекундах).
`options.callback` | Function | ![](../_images/check.png) |  | Обработчик события окончания сдвига карты. Параметром передается результат сдвига карты: [YMaps.State.SUCCESS](state.md#SUCCESS) - успешно, [YMaps.State.FAILURE](state.md#FAILURE) - неуспешно.

### stopMove {#stopMove}

```javascript
stopMove()
```
 Останавливает плавный сдвиг карты. 

{% note alert %}

Перед использованием данного метода следует инициализировать карту.

{% endnote %}

### update {#update}

```javascript
update()
```

Обновляет содержимое карты.
### zoomBy {#zoomBy}

```javascript
zoomBy(zoomDiff, options)
```

Изменяет коэффициент масштабирования карты на определенную величину.

**Параметры:**

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`zoomDiff` | Integer |  |  | Величина, на которую изменяется коэффициент масштабирования.
`options` | Object | ![](../_images/check.png) |  | Опции.
`options.smooth` | Boolean | ![](../_images/check.png) | false | Флаг, указывающий, что масштабирование должно происходить плавно.
`options.position` | [YMaps.ICoordPoint](icoordpoint.md) | ![](../_images/check.png) |  | Позиция, сохраняемая при плавной установке коэффициента масштабирования.
`options.centering` | Boolean | ![](../_images/check.png) | false | Флаг, указывающий, что позиция, заданная в options.position, должна по окончании плавного масштабирования совпасть с центром карты.
`options.callback` | Function | ![](../_images/check.png) |  | Обработчик окончания изменения коэффициента масштабирования. Параметром передается результат изменения коэффициента масштабирования: [YMaps.State.SUCCESS](state.md#SUCCESS) - успешно, [YMaps.State.FAILURE](state.md#FAILURE) - неуспешно.