Документация
Справочник JavaScript API
2.1.65 (текущая версия)
collection
interactivityModel
Интерфейсы

ILayer

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

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

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

Конструктор

ILayer()

Поля

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

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

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

options IOptionManager

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

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

События

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

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

copyrightschange

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

optionschange

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

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

parentchange

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

Поля данных:

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

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

tileloadchange

Событие, которые возникает при изменении состояния загрузки тайлов. Например, событие возникает, если изменилось число загруженных тайлов, а также если изменилось общее количество тайлов, попадающих в область видимости карты. Поля данных:

  • readyTileNumber - число загруженных тайлов; Тип: Number.
  • totalTileNumber - общее число тайлов, попадающих в область видимости карты. Тип: Number.

zoomrangechange

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

Методы

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

Number

Необязательный метод.

getCopyrights(coords, zoom)

vow.Promise

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

getParent()

IParentOnMap|null

Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен.

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

getZoomRange(point)

vow.Promise

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

setParent(parent)

IChildOnMap

Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта.

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

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

brightnesschange

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

copyrightschange

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

tileloadchange

Событие, которые возникает при изменении состояния загрузки тайлов. Например, событие возникает, если изменилось число загруженных тайлов, а также если изменилось общее количество тайлов, попадающих в область видимости карты. Поля данных:

  • readyTileNumber - число загруженных тайлов; Тип: Number.
  • totalTileNumber - общее число тайлов, попадающих в область видимости карты. Тип: Number.

zoomrangechange

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

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

getBrightness

{Number} getBrightness()

Необязательный метод.

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

getCopyrights

{vow.Promise} getCopyrights(coords, zoom)

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

Возвращает Promise, который будет подтверждён массивом строк или DOM-элементов с информацией об авторских правах.

Параметры:

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

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

]no-highlight]

Тип: Number[]

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

zoom *
[no-highlight[

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

]no-highlight]

Тип: Number

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

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

getZoomRange

{vow.Promise} getZoomRange(point)

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

Возвращает объект-promise.

Параметры:

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

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

]no-highlight]

Тип: Number[]

Точка

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