collection.Item

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

Базовый класс элемента коллекции объектов карты.

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

Конструктор

collection.Item([options])

Параметры:

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

Тип: Object

Опции объекта.

Пример:

// Пример реализации собственного элемента управления на основе наследования от collection.Item.
// Элемент управления отображает название объекта, который находится в центре карты.
var map = new ymaps.Map('map', {
        center: [55.819543, 37.611619],
        zoom: 6
    }),
// Создадим пользовательский класс.
    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});

Поля

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

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

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

options IOptionManager

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

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

События

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

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

optionschange

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

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

parentchange

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

Поля данных:

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

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

Методы

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

Map

Возвращает карту, которой принадлежит элемент коллекции.

getParent()

IParentOnMap

Возвращает родительский объект.

onAddToMap(map)

Функция, которая вызывается при добавлении элемента на карту. Для выполнения дополнительных действий при добавлении объекта на карту переопределите эту функцию.

onRemoveFromMap(oldMap)

Функция, которая вызывается при удалении элемента с карты. Для выполнения дополнительных действий при удалении объекта с карты переопределите эту функцию.

setParent(parent)

collection.Item

Устанавливает родителя для заданного элемента коллекции.

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

getMap

{Map} getMap()

Возвращает карту, которой принадлежит элемент коллекции.

getParent

{IParentOnMap} getParent()

Возвращает родительский объект.

onAddToMap

{} onAddToMap(map)

Функция, которая вызывается при добавлении элемента на карту. Для выполнения дополнительных действий при добавлении объекта на карту переопределите эту функцию.

Параметры:

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

Тип: Map

Карта, на которую добавлен объект.

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

onRemoveFromMap

{} onRemoveFromMap(oldMap)

Функция, которая вызывается при удалении элемента с карты. Для выполнения дополнительных действий при удалении объекта с карты переопределите эту функцию.

Параметры:

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

Тип: Map

Карта, с которой удален объект.

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

setParent

{collection.Item} setParent(parent)

Устанавливает родителя для заданного элемента коллекции.

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

Параметры:

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

Тип: IParentOnMap

Родительский объект.

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