YMaps.ILayer

Интерфейс слоя карты.

См.: Создание пользовательского слоя карты

Конструктор

Имя Описание
YMaps.ILayer() Интерфейс слоя карты.

Методы

Имя Возвращает Описание
getCopyright(bounds, zoom) String Возвращает копирайт для заданной видимой области слоя при заданном коэффициенте масштабирования.
getZoomRange(bounds) Object Возвращает минимальный и максимальный коэффициенты масштабирования для заданной видимой области слоя карты, либо null, если в заданной области слой не виден.
onAddToMap(map, parentContainer) Вызывается при добавлении слоя на карту.
onMapUpdate() Обновление слоя, вызываемое при обновлении карты.
onMove(position, offset) Обработка смещения карты. Метод автоматически вызывается при каждом сдвиге карты.
onRemoveFromMap() Вызывается при удалении слоя с карты.
onSmoothZoomEnd() Вызывается в конце плавного масштабирования.
onSmoothZoomStart() Вызывается в начале плавного масштабирования.
onSmoothZoomTick(params) Вызывается при выполнении шага плавного масштабирования.

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

getCopyright

{String} getCopyright(bounds, zoom)

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

Параметры:

Имя Тип Описание
bounds YMaps.ICoordBounds Видимая область слоя.
zoom Integer Коэффициент масштабирования.

Возвращает:

Тип Описание
String Текст копирайта.

getZoomRange

{Object} getZoomRange(bounds)

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

Пример:

layer.getZoomRange(map.getBounds()) -> {min: 1, max: 15}

Параметры:

Имя Тип Описание
bounds YMaps.ICoordBounds Видимая область слоя.

Возвращает:

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

onAddToMap

onAddToMap(map, parentContainer)

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

Параметры:

Имя Тип Описание
map YMaps.Map Указатель на карту.
parentContainer HTMLElement Указатель на родительский HTML-элемент.

onMapUpdate

onMapUpdate()

Обновление слоя, вызываемое при обновлении карты.

onMove

onMove(position, offset)

Обработка смещения карты. Метод автоматически вызывается при каждом сдвиге карты.

Параметры:

Имя Тип Описание
position YMaps.Point Новая позиция (в пикселах).
offset YMaps.Point Смещение относительно предыдущей позиции (в пикселах).

onRemoveFromMap

onRemoveFromMap()

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

onSmoothZoomEnd

onSmoothZoomEnd()

Вызывается в конце плавного масштабирования.

onSmoothZoomStart

onSmoothZoomStart()

Вызывается в начале плавного масштабирования.

onSmoothZoomTick

onSmoothZoomTick(params)

Вызывается при выполнении шага плавного масштабирования.

Параметры:

Имя Тип Описание
params Object Параметры шага.
params.saveThisPosition YMaps.ICoordPoint Точка координатной системы, относительно которой производится масштабирование.
params.scaleCoefficient Number Коэффициент изменения размера относительно начального.