YMaps.Map

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

Конструктор

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

Поля

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

События

Имя Описание
AddLayer Добавление слоя на карту.
BalloonClose

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

BalloonOpen

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

BeforeClick

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

BeforeContextMenu

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

BeforeDblClick

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

BeforeDOMMouseScroll

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

BeforeMouseDown

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

BeforeMouseMove

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

BeforeMouseUp

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

BeforeMultiTouchEnd

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

BeforeMultiTouchMove

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

BeforeMultiTouchStart

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

BoundsChange Изменение границ видимой области карты.
Click

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

ContextMenu

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

DblClick

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

Destruct Карта удалена.
DOMMouseScroll

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

Drag Перетаскивание карты пользователем продолжается.
DragEnd Перетаскивание карты пользователем завершено.
DragStart Начало перетаскивания карты пользователем.
MouseDown

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

MouseMove

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

MouseUp

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

Move Движение карты продолжается.
MoveEnd Движение карты завершено.
MoveStart Начало движения карты.
MultiTouchEnd

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

MultiTouchMove

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

MultiTouchStart

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

Redraw Произошла перерисовка карты, вследствие изменения размеров карты или ее положения на странице.
RemoveLayer Удаление слоя с карты.
SmoothZoomEnd Окончание плавного масштабирования карты.
SmoothZoomStart Начало плавного масштабирования карты.
TypeChange Смена типа карты.
Update Перерисовка (обновление) карты (при изменении центра или коэффициента масштабирования).
ZoomRangeChange Изменился диапазон доступных масштабов карты.

Методы

Имя Возвращает Описание
addControl(control, controlPosition) Добавляет указанный элемент управления на карту.
addCopyright(copyright) Добавляет копирайт на карту.
addCursor(cursor)

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

addLayer(layer) Добавляет слой на карту.
addOverlay(overlay) Добавляет оверлей на карту.
closeBalloon() Boolean Закрывает балун, показываемый в данный момент на карте.
dblClickZoomEnabled() Boolean Проверяет, включена ли возможность изменения коэффициента масштабирования по двойному щелчку кнопкой мыши.
destructor() Удаляет карту и выбрасывает событие Destruct.
disableDblClickZoom()

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

disableDragging() Выключает возможность перетаскивания карты с помощью мыши (по умолчанию включена).
disableHotKeys() Выключает горячие клавиши для функций масштабирования и сдвига карты (по умолчанию выключены).
disableMagnifier() Выключает возможность изменения коэффициента масштабирования карты посредством выделения области на карте левой кнопкой мыши (по умолчанию выключена).
disableRightButtonMagnifier() Выключает возможность выделения области карты правой кнопкой (по умолчанию выключена).
disableRuler() Выключает инструмент "Линейка" на карте (по умолчанию выключен).
disableScrollZoom() Выключает возможность плавной прокрутки карты колесом мыши (по умолчанию выключена).
draggingEnabled() Boolean Проверяет, включена ли возможность перетаскивания карты с помощью мыши.
enableDblClickZoom(options)

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

enableDragging() Включает возможность перетаскивания карты с помощью мыши (по умолчанию включена).
enableHotKeys(options) Включает горячие клавиши для функций масштабирования и сдвига карты (по умолчанию выключены).
enableMagnifier(options) Включает возможность изменения коэффициента масштабирования карты посредством выделения области на карте левой кнопкой мыши (по умолчанию выключена).
enableRightButtonMagnifier(options) Включает возможность выделения области карты правой кнопкой (по умолчанию выключена).
enableRuler() Включает инструмент "Линейка" на карте (по умолчанию выключена).
enableScrollZoom(options) Включает возможность плавного масштабирования карты колесом мыши (по умолчанию выключена).
getBalloon() YMaps.Balloon Возвращает указатель на открытый балун.
getBounds(unbounded) YMaps.ICoordBounds Возвращает текущие границы видимой области карты (viewport).
getCenter(unbounded) YMaps.ICoordPoint Возвращает текущие координаты центра карты.
getContainer() HTMLElement Возвращает указатель на HTML-элемент, служащий контейнером для карты.
getContainerSize() YMaps.Size Возвращает размер HTML-контейнера, в котором размещена карта.
getMaxZoom(bounds, layersOnly) Integer

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

getMinZoom(bounds, layersOnly) Integer

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

getRulerState() String

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

getType() YMaps.MapType Возвращает текущий тип карты.
getZoom() Integer Возвращает текущий коэффициент масштабирования карты.
hotKeysEnabled() Boolean Проверяет, включены ли горячие клавиши для функций масштабирования и сдвига карты.
magnifierEnabled() Boolean Проверяет, включена ли возможность изменения масштаба карты посредством выделения области левой кнопкой мыши.
moveBy(pixelsOffset, smooth, options)

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

openBalloon(point, content, options) Показывает балун на карте.
panTo(toPoint, options) Плавно перемещает центр карты в заданную географическую точку.
redraw(smoothCentering, callback)

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

removeAllOverlays() Удаляет все оверлеи с карты.
removeControl(control) Удаляет указанный элемент управления с карты.
removeCopyright(copyright) Удаляет копирайт с карты.
removeCursor(cursor)

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

removeLayer(layer) Удаляет слой с карты.
removeOverlay(overlay) Удаляет указанный оверлей с карты.
rightButtonMagnifierEnabled() Boolean Проверяет, включена ли функция выделения области карты правой кнопкой.
rulerEnabled() Boolean Проверяет, включен ли инструмент "Линейка" на карте.
scrollZoomEnabled() Boolean Проверяет, включена ли функция плавной прокрутки карты колесом мыши.
setBounds(geoBounds) Устанавливает центр карты и коэффициент масштабирования так, чтобы заданная с помощью объекта YMaps.ICoordBounds прямоугольная область, была видна в окне карты максимально крупно.
setCenter(center, zoom, mapType) Устанавливает центр карты.
setMaxZoom(maxZoom) Устанавливает максимальный коэффициент масштабирования карты.
setMinZoom(minZoom) Устанавливает минимальный коэффициент масштабирования карты.
setRulerState(rulerState) Устанавливает состояние инструмента "Линейка".
setType(mapType) Переключает карту на указанный тип.
setZoom(zoom, options) Устанавливает коэффициент масштабирования.
startMove(direction, options)

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

stopMove() Останавливает плавный сдвиг карты.
update() Обновляет содержимое карты.
zoomBy(zoomDiff, options) Изменяет коэффициент масштабирования карты на определенную величину.

Подробное описание конструктора

YMaps.Map(element, options)

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

Параметры:

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

Подробное описание полей

converter

YMaps.Converter converter

Преобразователь координат, см. YMaps.Converter.

coordSystem

YMaps.ICoordSystem coordSystem

Система координат YMaps.ICoordSystem.

Events

Object Events

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

hint

Всплывающая подсказка, см. YMaps.Hint.

tileCoordinates

YMaps.TileCoordinates tileCoordinates

Преобразователь пиксельных координат (рассчитаных при максимальном масштабе карты) в тайловые, см. YMaps.TileCoordinates.

Подробное описание событий

AddLayer

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

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

  • указатель на карту;
  • указатель на добавленный слой.

BalloonClose

BalloonClose

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

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

BalloonOpen

BalloonOpen

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

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

BeforeClick

BeforeClick

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

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

BeforeContextMenu

BeforeContextMenu

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

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

BeforeDblClick

BeforeDblClick

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

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

BeforeDOMMouseScroll

BeforeDOMMouseScroll

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

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

BeforeMouseDown

BeforeMouseDown

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

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

BeforeMouseMove

BeforeMouseMove

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

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

BeforeMouseUp

BeforeMouseUp

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

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

BeforeMultiTouchEnd

BeforeMultiTouchEnd

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

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

BeforeMultiTouchMove

BeforeMultiTouchMove

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

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

BeforeMultiTouchStart

BeforeMultiTouchStart

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

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

BoundsChange

BoundsChange

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

Click

Click

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

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

ContextMenu

ContextMenu

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

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

DblClick

DblClick

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

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

Destruct

Destruct

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

DOMMouseScroll

DOMMouseScroll

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

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

Drag

Drag
Перетаскивание карты пользователем продолжается.

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

  • указатель на карту;
  • объект YMaps.Point со значением смещения центра карты в пикселах относительно его предыдущего положения.

DragEnd

DragEnd

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

DragStart

DragStart

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

MouseDown

MouseDown

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

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

MouseMove

MouseMove

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

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

MouseUp

MouseUp

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

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

Move

Move
Движение карты продолжается.

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

  • указатель на карту;
  • объект YMaps.Point со значением смещения центра карты в пикселах относительно его предыдущего положения.

MoveEnd

MoveEnd

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

MoveStart

MoveStart

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

MultiTouchEnd

MultiTouchEnd

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

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

MultiTouchMove

MultiTouchMove

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

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

MultiTouchStart

MultiTouchStart

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

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

Redraw

Redraw

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

RemoveLayer

RemoveLayer
Удаление слоя с карты.

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

  • указатель на карту;
  • указатель на удаленный слой.

SmoothZoomEnd

SmoothZoomEnd

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

SmoothZoomStart

SmoothZoomStart

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

TypeChange

TypeChange

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

Update

Update

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

ZoomRangeChange

ZoomRangeChange
Изменился диапазон доступных масштабов карты.

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

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

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

Подробное описание методов

addControl

addControl(control, controlPosition)

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

Параметры:

Имя Тип Необязательный По умолчанию Описание
control YMaps.IControl Указатель на добавляемый элемент управления.
controlPosition YMaps.ControlPosition Расположение элемента управления.

addCopyright

addCopyright(copyright)

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

Параметры:

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

addCursor

addCursor(cursor)

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

Разрешается добавлять на карту произвольное количество курсоров, но применяется только один (тот, который был добавлен последним). Список доступных курсоров приводится в описании объекта YMaps.Cursor.

Удалить курсор можно с помощью метода YMaps.Map.removeCursor.

Пример:

// Добавляет на тулбар кнопку "Помощь", при нажатии на которую курсор будет меняться на значок вопроса ("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 Курсор.

addLayer

addLayer(layer)

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

Параметры:

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

addOverlay

addOverlay(overlay)

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

Параметры:

Имя Тип Описание
overlay YMaps.IOverlay Указатель на оверлей.

closeBalloon

{Boolean} closeBalloon()

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

Возвращает:

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

dblClickZoomEnabled

{Boolean} dblClickZoomEnabled()

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

Возвращает:

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

destructor

destructor()

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

disableDblClickZoom

disableDblClickZoom()

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

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

disableDragging

disableDragging()

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

disableHotKeys

disableHotKeys()

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

disableMagnifier

disableMagnifier()

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

disableRightButtonMagnifier

disableRightButtonMagnifier()

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

disableRuler

disableRuler()

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

disableScrollZoom

disableScrollZoom()

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

draggingEnabled

{Boolean} draggingEnabled()

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

Возвращает:

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

enableDblClickZoom

enableDblClickZoom(options)

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

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

Параметры:

Имя Тип Необязательный По умолчанию Описание
options Object Опции.
options.smooth Boolean true Плавное масштабирование.

enableDragging

enableDragging()

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

enableHotKeys

enableHotKeys(options)

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

См.: Горячие клавиши

Параметры:

Имя Тип Необязательный По умолчанию Описание
options Object Опции.
options.smooth Boolean false Плавное масштабирование.

enableMagnifier

enableMagnifier(options)

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

Параметры:

Имя Тип Необязательный По умолчанию Описание
options Object Опции.
options.smooth Boolean false Плавное масштабирование.

enableRightButtonMagnifier

enableRightButtonMagnifier(options)

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

Параметры:

Имя Тип Необязательный По умолчанию Описание
options Object Опции.
options.smooth Boolean false Плавное масштабирование.

enableRuler

enableRuler()

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

enableScrollZoom

enableScrollZoom(options)

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

Параметры:

Имя Тип Необязательный По умолчанию Описание
options Object Опции.
options.smooth Boolean true true - применять плавное масштабирование карты, false - нет.

getBalloon

{YMaps.Balloon} getBalloon()

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

Возвращает:

Тип Описание
YMaps.Balloon Указатель на открытый балун.

getBounds

{YMaps.ICoordBounds} getBounds(unbounded)

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

См.: Преобразование координат

Параметры:

Имя Тип Необязательный По умолчанию Описание
unbounded Boolean false true - границы карты заданы неограниченными точками, false - ограниченными.

Возвращает:

Тип Описание
YMaps.ICoordBounds Границы видимой области карты.

getCenter

{YMaps.ICoordPoint} getCenter(unbounded)

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

См.: Преобразование координат

Параметры:

Имя Тип Необязательный По умолчанию Описание
unbounded Boolean false true - центр карты задан неограниченной точкой, false - ограниченной.

Возвращает:

Тип Описание
YMaps.ICoordPoint Координаты центра карты.

getContainer

{HTMLElement} getContainer()

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

Возвращает:

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

getContainerSize

{YMaps.Size} getContainerSize()

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

Возвращает:

Тип Описание
YMaps.Size Размер HTML-контейнера, в котором размещена карта.

getMaxZoom

{Integer} getMaxZoom(bounds, layersOnly)

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

Если не задан параметр layersOnly, то максимальный коэффициент масштабирования рассчитывается следующим образом: берется максимальный из всех текущих коэффициентов масштабирования слоев карты, затем расширяется значением maxZoom из YMaps.MapType, а затем ограничивается значением, заданным в YMaps.Map.setMaxZoom и максимальным масштабом текущей координатной системы.

Параметры:

Имя Тип Необязательный По умолчанию Описание
bounds YMaps.ICoordBounds Область, для которой требуется расчитать максимальный масштаб. По умолчанию берется текущая видимая область.
layersOnly Boolean false Использовать только данные по слоям, игнорируя дополнения и ограничения.

Возвращает:

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

getMinZoom

{Integer} getMinZoom(bounds, layersOnly)

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

Если не задан параметр layersOnly, то минимальный коэффициент масштабирования рассчитывается следующим образом: берется минимальный из всех текущих коэффициентов масштабирования слоев карты, затем расширяется значением minZoom из YMaps.MapType, а затем ограничивается значением, заданным в YMaps.Map.setMinZoom и 0.

Параметры:

Имя Тип Необязательный По умолчанию Описание
bounds YMaps.ICoordBounds Область, для которой требуется расчитать минимальный масштаб. По умолчанию берется текущая видимая область.
layersOnly Boolean false Использовать только данные по слоям, игнорируя дополнения и ограничения.

Возвращает:

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

getRulerState

{String} getRulerState()

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

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

Возвращает:

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

getType

{YMaps.MapType} getType()

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

Возвращает:

Тип Описание
YMaps.MapType Текущий тип карты.

getZoom

{Integer} getZoom()

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

Возвращает:

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

hotKeysEnabled

{Boolean} hotKeysEnabled()

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

Возвращает:

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

magnifierEnabled

{Boolean} magnifierEnabled()

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

Возвращает:

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

moveBy

moveBy(pixelsOffset, smooth, options)

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

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

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

Пример:

// Смещает центр карты на северо-северо-запад, по окончании смещения открывает балун.
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 Величина сдвига (в пикселах).
smooth Boolean false true - смещение происходит плавно, false - за один шаг.
options Object Параметры смещения.
options.speed Number 37 Итоговая скорость.
options.startSpeed Number 5 Начальная скорость.
options.speedUpTime Number 120 Время разгона (в миллисекундах).
options.callback Function Функция-обработчик для события окончания смещения карты. Параметром передается результат сдвига карты: YMaps.State.SUCCESS - успешно, YMaps.State.FAILURE - неуспешно.

openBalloon

openBalloon(point, content, options)

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

Пример:

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

Параметры:

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

panTo

panTo(toPoint, options)

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

Параметры:

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

redraw

redraw(smoothCentering, callback)

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

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

Параметры:

Имя Тип Необязательный По умолчанию Описание
smoothCentering Boolean true true - плавно сдвигать карту так, чтобы географические координаты ее центра после изменения размеров оставались прежними. false - не сдвигать карту.
callback Function Обработчик события окончания плавного центрирования карты. Параметром передается результат центрирования карты: YMaps.State.SUCCESS - успешно, YMaps.State.FAILURE - неуспешно.

removeAllOverlays

removeAllOverlays()

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

removeControl

removeControl(control)

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

Параметры:

Имя Тип Описание
control YMaps.IControl Указатель на удаляемый элемент управления.

removeCopyright

removeCopyright(copyright)

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

Параметры:

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

removeCursor

removeCursor(cursor)

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

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

Параметры:

Имя Тип Описание
cursor YMaps.Cursor Курсор.

removeLayer

removeLayer(layer)

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

Параметры:

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

removeOverlay

removeOverlay(overlay)

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

Параметры:

Имя Тип Описание
overlay YMaps.IOverlay Указатель на оверлей.

rightButtonMagnifierEnabled

{Boolean} rightButtonMagnifierEnabled()

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

Возвращает:

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

rulerEnabled

{Boolean} rulerEnabled()

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

Возвращает:

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

scrollZoomEnabled

{Boolean} scrollZoomEnabled()

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

Возвращает:

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

setBounds

setBounds(geoBounds)

Устанавливает центр карты и коэффициент масштабирования так, чтобы заданная с помощью объекта YMaps.ICoordBounds прямоугольная область, была видна в окне карты максимально крупно.

Параметры:

Имя Тип Описание
geoBounds YMaps.ICoordBounds Границы, которые необходимо установить карте.

setCenter

setCenter(center, zoom, mapType)

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

Параметры:

Имя Тип Необязательный По умолчанию Описание
center YMaps.ICoordPoint Координаты центра карты.
zoom Integer Коэффициент масштабирования.
mapType YMaps.MapType Тип карты.

setMaxZoom

setMaxZoom(maxZoom)

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

Параметры:

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

setMinZoom

setMinZoom(minZoom)

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

Параметры:

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

setRulerState

setRulerState(rulerState)

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

Параметры:

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

setType

setType(mapType)

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

Параметры:

Имя Тип Описание
mapType YMaps.MapType Тип карты.

setZoom

setZoom(zoom, options)

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

Параметры:

Имя Тип Необязательный По умолчанию Описание
zoom Integer Коэффициент масштабирования.
options Object Опции.
options.smooth Boolean false Флаг, указывающий, что масштабирование должно происходить плавно.
options.position YMaps.ICoordPoint Позиция, сохраняемая при плавной установке коэффициента масштабирования.
options.centering Boolean false Флаг, указывающий, что по окончании плавного масштабирования позиция, заданная в options.position, должна совпасть с центром карты.
options.callback Function Обработчик окончания изменения коэффициента масштабирования. Параметром передается результат изменения: YMaps.State.SUCCESS - успешно, YMaps.State.FAILURE - неуспешно.

startMove

startMove(direction, options)

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

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

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

Пример:

// Плавно сдвигает центр карты по направлению на юго-юго-запад, по окончании сдвига открывает балун.
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 Вектор направления сдвига.
options Object Параметры движения.
options.speed Number 37 Конечная скорость разгона.
options.startSpeed Number 5 Начальная скорость разгона.
options.speedUpTime Number 120 Время разгона карты до конечной скорости (в миллисекундах).
options.callback Function Обработчик события окончания сдвига карты. Параметром передается результат сдвига карты: YMaps.State.SUCCESS - успешно, YMaps.State.FAILURE - неуспешно.

stopMove

stopMove()
Останавливает плавный сдвиг карты.
Внимание. Перед использованием данного метода следует инициализировать карту.

update

update()

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

zoomBy

zoomBy(zoomDiff, options)

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

Параметры:

Имя Тип Необязательный По умолчанию Описание
zoomDiff Integer Величина, на которую изменяется коэффициент масштабирования.
options Object Опции.
options.smooth Boolean false Флаг, указывающий, что масштабирование должно происходить плавно.
options.position YMaps.ICoordPoint Позиция, сохраняемая при плавной установке коэффициента масштабирования.
options.centering Boolean false Флаг, указывающий, что позиция, заданная в options.position, должна по окончании плавного масштабирования совпасть с центром карты.
options.callback Function Обработчик окончания изменения коэффициента масштабирования. Параметром передается результат изменения коэффициента масштабирования: YMaps.State.SUCCESS - успешно, YMaps.State.FAILURE - неуспешно.