--- metadata: - name: generator content: Diplodoc Platform v5.64.2 alternate: - https://yandex.ru/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/collection.Item.md - https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/collection.Item.md - href: https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/collection.Item.md type: text/markdown title: Markdown version - href: https://yandex.ru/dev/jsapi-v2-1/doc/ru/llms.txt?revision=r21950234 rel: describedby --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/jsapi-v2-1/doc/ru/llms.txt?revision=r21950234 # collection.Item Расширяет [IChildOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md), [ICustomizable](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md), [IEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md), [IParentOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md). Базовый класс элемента коллекции объектов карты. [Конструктор](#constructor-summary) | [Поля ](#properties-summary) | [События ](#events-summary) | [Методы ](#methods-summary) ## Конструктор {#constructor-summary} ```javascript collection.Item([options]) ``` **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || [`options`](#param-options)| — | Тип: Object Опции объекта. || |# **Пример:** ```javascript // Пример реализации собственного элемента управления на основе наследования от 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}); ``` ## Поля {#properties-summary} #| || **Имя** | **Тип** | **Описание** || || [events](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md#events) | [IEventManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventManager.md) | Менеджер событий. Унаследовано от [IEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md#events).|| || [options](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#options) | [IOptionManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOptionManager.md) | Менеджер опций. Унаследовано от [ICustomizable](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#options). || |# ## События {#events-summary} #| || **Имя** | **Описание** || || [mapchange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md#event-mapchange) | Сменилась карта. Поля данных: - oldMap - старая карта; - newMap - новая карта. Унаследовано от [IParentOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md#event-mapchange).|| || [optionschange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#event-optionschange) | Изменение в опциях объекта. Унаследовано от [ICustomizable](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#event-optionschange).|| || [parentchange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChild.md#event-parentchange) | Сменился родительский объект. Поля данных: - oldParent - старый родитель; - newParent - новый родитель. Унаследовано от [IChild](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChild.md#event-parentchange). || |# ## Методы {#methods-summary} #| || **Имя** | **Возвращает** | **Описание** || || [getMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/collection.Item.md#getMap)() | [Map](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Map.md) | Возвращает карту, которой принадлежит элемент коллекции.|| || [getParent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/collection.Item.md#getParent)() | [IParentOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md) | Возвращает родительский объект.|| || [onAddToMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/collection.Item.md#onAddToMap)([map](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/collection.Item.md#onAddToMap-param-map)) | | Функция, которая вызывается при добавлении элемента на карту. Для выполнения дополнительных действий при добавлении объекта на карту переопределите эту функцию.|| || [onRemoveFromMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/collection.Item.md#onRemoveFromMap)([oldMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/collection.Item.md#onRemoveFromMap-param-oldMap)) | | Функция, которая вызывается при удалении элемента с карты. Для выполнения дополнительных действий при удалении объекта с карты переопределите эту функцию.|| || [setParent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/collection.Item.md#setParent)([parent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/collection.Item.md#setParent-param-parent)) | [collection.Item](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/collection.Item.md) | Устанавливает родителя для заданного элемента коллекции. || |# ## Описание методов {#method_detail} ### getMap {#getMap} ```javascript {Map} getMap() ``` **Возвращает** карту, которой принадлежит элемент коллекции. ### getParent {#getParent} ```javascript {IParentOnMap} getParent() ``` **Возвращает** родительский объект. ### onAddToMap {#onAddToMap} ```javascript {} onAddToMap(map) ``` Функция, которая вызывается при добавлении элемента на карту. Для выполнения дополнительных действий при добавлении объекта на карту переопределите эту функцию. **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || [`map`](#onAddToMap-param-map)[*](*star) | — | Тип: [Map](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Map.md) Карта, на которую добавлен объект. || |# \* Обязательный параметр/опция. ### onRemoveFromMap {#onRemoveFromMap} ```javascript {} onRemoveFromMap(oldMap) ``` Функция, которая вызывается при удалении элемента с карты. Для выполнения дополнительных действий при удалении объекта с карты переопределите эту функцию. **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || [`oldMap`](#onRemoveFromMap-param-oldMap)[*](*star) | — | Тип: [Map](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Map.md) Карта, с которой удален объект. || |# \* Обязательный параметр/опция. ### setParent {#setParent} ```javascript {collection.Item} setParent(parent) ``` Устанавливает родителя для заданного элемента коллекции. **Возвращает** ссылку на себя. **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || [`parent`](#setParent-param-parent)[*](*star) | — | Тип: [IParentOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md) Родительский объект. || |# \* Обязательный параметр/опция. [*star]: Обязательный параметр.