LayerCollection
Расширяет ILayer, IMapObjectCollection.
Коллекция слоев.
Конструктор | Поля | События | Методы
Конструктор
LayerCollection([options])
Коллекция слоев.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Object Опции слоя. |
Поля
Имя |
Тип |
Описание |
Менеджер событий. Унаследовано от IEventEmitter. |
||
Менеджер опций. Унаследовано от ICustomizable. |
События
Имя |
Описание |
Произошло добавление дочернего объекта. Унаследовано от ICollection. |
|
Событие изменения яркости слоя. Унаследовано от ILayer. |
|
Событие изменения доступной информации об авторских правах. Унаследовано от ILayer. |
|
Сменилась карта. Поля данных:
Унаследовано от IParentOnMap. |
|
Изменение в опциях объекта. Унаследовано от ICustomizable. |
|
Сменился родительский объект. Поля данных:
Унаследовано от IChild. |
|
Произошло удаление дочернего объекта. Унаследовано от ICollection. |
|
Событие изменения состояния загрузки тайла. Поля данных:
Унаследовано от ILayer. |
|
Событие изменения доступной информации о диапазоне уровней масштабирования. Унаследовано от ILayer. |
Методы
Имя |
Возвращает |
Описание |
Добавляет в коллекцию дочерний объект. |
||
Перебирает все элементы коллекции, вызывая для каждого функцию-обработчик. |
||
Number |
Возвращает яркость слоя в виде числа от 0 до 1. |
|
getCopyrights([coords[, zoom]]) |
Запрашивает информацию об авторских правах в указанной точке с указанным коэффициентом масштабирования. Если точка и коэффициент масштабирования не указаны, будут использованы центр и коэффициент масштабирования карты. |
|
Возвращает итератор по коллекции. Унаследован от ICollection. |
||
getMap() |
Возвращает ссылку на карту. Унаследован от IParentOnMap. |
|
IParentOnMap|null |
Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен. Унаследован от IChildOnMap. |
|
Определяет доступный в указанной точке диапазон уровней масштабирования. Если данные есть, то возвращенный объект-promise будет подтвержден и передаст в качестве результата массив из двух чисел - минимальный и максимальный доступный в точке уровень масштабирования. Если данных нет, то promise отклоняется с указанием ошибки. Если у коллекции нет ни одного потомка, предоставляющего информацию о диапазоне уровней масштабирования, то promise будет отклонён с сообщением 'noProvider'. |
||
Удаляет из коллекции дочерний объект. |
||
Удаляет все элементы коллекции. |
||
Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта. Унаследован от IChildOnMap. |
Описание методов
add
{LayerCollection} add(child)
Добавляет в коллекцию дочерний объект.
Возвращает ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: ILayer|String Слой (ключ из хранилища layer.storage или экземпляр класса ILayer), который нужно добавить. |
* Обязательный параметр/опция.
Пример:
// Допустим, мы хотим добавить в свою коллекцию несколько слоев.
var layerCollection = new ymaps.LayerCollection();
var customLayer = new ymaps.Layer('http://tile.openstreetmap.org/%z/%x/%y.png', {
projection: ymaps.projection.sphericalMercator
});
// Слой можно задать ключом из layer.storage.
var satelliteLayer = 'yandex#satellite';
// Добавим слои в нашу коллекцию.
layerCollection
.add(customLayer)
.add(satelliteLayer);
each
{} each(callback[, context])
Перебирает все элементы коллекции, вызывая для каждого функцию-обработчик.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Function Функция-обработчик. |
|
— |
Тип: Object Контекст исполнения функции. |
* Обязательный параметр/опция.
getBrightness
{Number} getBrightness()
Возвращает яркость слоя в виде числа от 0 до 1.
getCopyrights
{vow.Promise} getCopyrights([coords[, zoom]])
Запрашивает информацию об авторских правах в указанной точке с указанным коэффициентом масштабирования. Если точка и коэффициент масштабирования не указаны, будут использованы центр и коэффициент масштабирования карты.
Возвращает Promise объект, который будет подтверждён массивом строк или DOM-элементов с информацией об авторских правах.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Number[] Точка на карте, для которой запрашивается информация об авторских правах. |
|
— |
Тип: Number Уровень масштабирования, для которого запрашивается информация об авторских правах. |
Пример:
// Пусть у нас есть сервис, умеющий по координатам
// и уровню масштабирования возвращать копирайты.
myLayer.getCopyrights = function (coords, zoom) {
var deferred = ymaps.vow.defer();
$.ajax('url/to/copyrights/provider?ll=' +
(coords || map.getCenter()).join(',') + '&z=' +
(zoom || map.getZoom()),
function (res) {
deferred.resolve(res || []);
});
return deferred.promise();
};
getZoomRange
{vow.Promise} getZoomRange([coords])
Определяет доступный в указанной точке диапазон уровней масштабирования. Если данные есть, то возвращенный объект-promise будет подтвержден и передаст в качестве результата массив из двух чисел - минимальный и максимальный доступный в точке уровень масштабирования. Если данных нет, то promise отклоняется с указанием ошибки. Если у коллекции нет ни одного потомка, предоставляющего информацию о диапазоне уровней масштабирования, то promise будет отклонён с сообщением 'noProvider'.
Возвращает объект-promise.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Number[] Координаты точки. Если не указана, берётся текущий центр карты. |
Пример:
// Допустим, наш слой отрисован для масштабов 2-15 по всей земле.
myLayer.getZoomRange = function () {
return ymaps.vow.resolve([2, 15]);
}
remove
{LayerCollection} remove(child)
Удаляет из коллекции дочерний объект.
Возвращает ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: ILayer|String Слой (строка-ключ из layer.storage или экземпляр класса ILayer), который нужно удалить. |
* Обязательный параметр/опция.
removeAll
{Collection} removeAll()
Удаляет все элементы коллекции.
Возвращает ссылку на себя.
Обязательный параметр.