collection.Item
Расширяет IChildOnMap, ICustomizable, IEventEmitter, IParentOnMap.
Базовый класс элемента коллекции объектов карты.
Конструктор | Поля | События | Методы
Конструктор
collection.Item([options])
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Object Опции объекта. |
Пример:
// Пример реализации собственного элемента управления на основе наследования от collection.Item.
// Элемент управления отображает имя объекта, расположенного в центре карты.
var map = new ymaps.Map('map', {
center: [55.819543, 37.611619],
zoom: 6
});
// Создание пользовательского класса.
var CustomControl = function (options) {
CustomControl.superclass.constructor.call(this, options);
};
// И наследование от collection.Item.
ymaps.util.defineClass(CustomControl, ymaps.collection.Item, {
onAddToMap: function (map) {
CustomControl.superclass.onAddToMap.call(this, map);
// Создание HTML-элемента с текстом.
this.getParent().getChildElement(this).then(this._onChildElementGet, this);
},
onRemoveFromMap: function (oldMap) {
CustomControl.superclass.onRemoveFromMap.call(this, oldMap);
},
_onChildElementGet: function(parentElementContainer) {
// Вы можете создать представление DOM для элемента управления здесь
// и добавьте его в качестве дочернего элемента в parentElementContaner.
// ...
}
});
var customControl = new CustomControl();
map.controls.add(customControl, {top: 10, left: 10});
Поля
Имя |
Тип |
Описание |
Менеджер событий. Унаследовано от IEventEmitter. |
||
Менеджер опций. Унаследовано от ICustomizable. |
События
Имя |
Описание |
Сменилась карта. Поля данных:
Унаследовано от IParentOnMap. |
|
Изменение в опциях объекта. Унаследовано от ICustomizable. |
|
Сменился родительский объект. Поля данных:
Унаследовано от IChild. |
Методы
Имя |
Возвращает |
Описание |
getMap() |
Возвращает карту, которой принадлежит элемент коллекции. |
|
Возвращает родительский объект. |
||
Функция, которая вызывается при добавлении элемента на карту. Для выполнения дополнительных действий при добавлении объекта на карту переопределите эту функцию. |
||
Функция, которая вызывается при удалении элемента с карты. Для выполнения дополнительных действий при удалении объекта с карты переопределите эту функцию. |
||
Устанавливает родителя для заданного элемента коллекции. |
Описание методов
getMap
{Map} getMap()
Возвращает карту, которой принадлежит элемент коллекции.
getParent
{IParentOnMap} getParent()
Возвращает родительский объект.
onAddToMap
{} onAddToMap(map)
Функция, которая вызывается при добавлении элемента на карту. Для выполнения дополнительных действий при добавлении объекта на карту переопределите эту функцию.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: Map Карта, на которую добавлен объект. |
* Обязательный параметр/опция.
onRemoveFromMap
{} onRemoveFromMap(oldMap)
Функция, которая вызывается при удалении элемента с карты. Для выполнения дополнительных действий при удалении объекта с карты переопределите эту функцию.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Map Карта, с которой удален объект. |
* Обязательный параметр/опция.
setParent
{collection.Item} setParent(parent)
Устанавливает родителя для заданного элемента коллекции.
Возвращает ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: IParentOnMap Родительский объект. |
* Обязательный параметр/опция.
Обязательный параметр.