ILayer

Расширяет IChildOnMap, ICustomizable, IEventEmitter.

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

Конструктор | Поля | События | Методы

Конструктор

ILayer()

Поля

Имя Тип Описание
events IEventManager

Менеджер событий.

Унаследовано от IEventEmitter.

options IOptionManager

Менеджер опций.

Унаследовано от ICustomizable.

События

Имя Описание
brightnesschange

Событие изменения яркости слоя.

copyrightschange

Событие изменения доступной информации об авторских правах.

mapchange
Сменилась карта. Поля данных:
  • oldMap - старая карта;
  • newMap - новая карта.

Унаследовано от IChildOnMap.

optionschange

Изменение в опциях объекта.

Унаследовано от ICustomizable.

parentchange

Сменился родительский объект.

Поля данных:

  • oldParent - старый родитель;
  • newParent - новый родитель.

Унаследовано от IChild.

zoomrangechange

Событие изменения доступной информации о диапазоне уровней масштабирования.

Методы

Имя Возвращает Описание
getBrightness()

Number

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

getCopyrights(coords, zoom)

util.Promise

Необязательный метод. Запрашивает информацию об авторских правах в указанной точке с указанным коэффициентом масштабирования. Возвращает объект-promise, который будет подтверждён и передаст в качестве результата массив строк или DOM-элементов с информацией об авторских правах.

getParent()

IParentOnMap

Returns ссылку на родительский объект.

Унаследован от IChildOnMap.

getZoomRange(point)

util.Promise

Необязательный метод. Определяет доступный в указанной точке диапазон уровней масштабирования. Если данные есть, то возвращенный объект-promise будет подтвержден и передаст в качестве результата массив из двух чисел - минимальный и максимальный доступный в точке уровень масштабирования. Если данных нет, то promise отклоняется с указанием ошибки.

setParent(parent)

IChildOnMap

Устанавливает родительский объект.

Унаследован от IChildOnMap.

Описание событий

brightnesschange

Событие изменения яркости слоя.

copyrightschange

Событие изменения доступной информации об авторских правах.

zoomrangechange

Событие изменения доступной информации о диапазоне уровней масштабирования.

Описание методов

getBrightness

{Number} getBrightness()

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

Returns значение яркости от 0 до 1 (0 - нулевая яркость, 1 - максимальная яркость).

getCopyrights

{util.Promise} getCopyrights(coords, zoom)

Необязательный метод. Запрашивает информацию об авторских правах в указанной точке с указанным коэффициентом масштабирования. Возвращает объект-promise, который будет подтверждён и передаст в качестве результата массив строк или DOM-элементов с информацией об авторских правах.

Returns объект-promise.

Параметры:

Параметр Значение по умолчанию Описание
coords *

Тип: Number[]

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

zoom *

Тип: Number

Уровень масштабирования, для которого запрашивается информация об авторских правах.

* Обязательный параметр/опция.

getZoomRange

{util.Promise} getZoomRange(point)

Необязательный метод. Определяет доступный в указанной точке диапазон уровней масштабирования. Если данные есть, то возвращенный объект-promise будет подтвержден и передаст в качестве результата массив из двух чисел - минимальный и максимальный доступный в точке уровень масштабирования. Если данных нет, то promise отклоняется с указанием ошибки.

Returns объект-promise.

Параметры:

Параметр Значение по умолчанию Описание
point *

Тип: Number[]

Точка

* Обязательный параметр/опция.