--- metadata: - name: generator content: Diplodoc Platform v5.39.1 alternate: - https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/objectManager.OverlayCollection.md - https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/llms.txt # objectManager.OverlayCollection Расширяет [ICustomizable](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md), [IEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md). Коллекция овелеев. [Конструктор](#constructor-summary) | [Поля ](#properties-summary) | [События ](#events-summary) | [Методы ](#methods-summary) ## Конструктор {#constructor-summary} ```javascript objectManager.OverlayCollection() ``` ## Поля {#properties-summary} #| || **Имя** | **Тип** | **Описание** || || [events](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md#events) | [IEventManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventManager.md) | Менеджер событий. Унаследовано от [IEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md#events). || || [options](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#options) | [IOptionManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOptionManager.md) | Менеджер опций. Унаследовано от [ICustomizable](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#options). || |# ## События {#events-summary} #| || **Имя** | **Описание** || || [add](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md#event-add) | Добавление оверлея в коллекцию. Экземпляр класса [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - добавленный оверлей. || || [click](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md#event-click) | Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - IOverlay - оверлей, на котором произошло событие; - coords - географические координаты точки, в которой произошло событие; - globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира; - pagePixels - координаты события в пикселях от левого верхнего угла страницы; - clientPixels - координаты события в пикселях от левого верхнего угла окна браузера; - domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. || || [contextmenu](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md#event-contextmenu) | Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - IOverlay - оверлей, на котором произошло событие; - coords - географические координаты точки, в которой произошло событие; - globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира; - pagePixels - координаты события в пикселях от левого верхнего угла страницы; - clientPixels - координаты события в пикселях от левого верхнего угла окна браузера; - domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. || || [dblclick](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md#event-dblclick) | Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - IOverlay - оверлей, на котором произошло событие; - coords - географические координаты точки, в которой произошло событие; - globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира; - pagePixels - координаты события в пикселях от левого верхнего угла страницы; - clientPixels - координаты события в пикселях от левого верхнего угла окна браузера; - domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. || || [mousedown](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md#event-mousedown) | Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - IOverlay - оверлей, на котором произошло событие; - coords - географические координаты точки, в которой произошло событие; - globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира; - pagePixels - координаты события в пикселях от левого верхнего угла страницы; - clientPixels - координаты события в пикселях от левого верхнего угла окна браузера; - domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. || || [mouseenter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md#event-mouseenter) | Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - IOverlay - оверлей, на котором произошло событие; - coords - географические координаты точки, в которой произошло событие; - globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира; - pagePixels - координаты события в пикселях от левого верхнего угла страницы; - clientPixels - координаты события в пикселях от левого верхнего угла окна браузера; - domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. || || [mouseleave](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md#event-mouseleave) | Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - IOverlay - оверлей, на котором произошло событие; - coords - географические координаты точки, в которой произошло событие; - globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира; - pagePixels - координаты события в пикселях от левого верхнего угла страницы; - clientPixels - координаты события в пикселях от левого верхнего угла окна браузера; - domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. || || [mousemove](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md#event-mousemove) | Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - IOverlay - оверлей, на котором произошло событие; - coords - географические координаты точки, в которой произошло событие; - globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира; - pagePixels - координаты события в пикселях от левого верхнего угла страницы; - clientPixels - координаты события в пикселях от левого верхнего угла окна браузера; - domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. || || [mouseup](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md#event-mouseup) | Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - IOverlay - оверлей, на котором произошло событие; - coords - географические координаты точки, в которой произошло событие; - globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира; - pagePixels - координаты события в пикселях от левого верхнего угла страницы; - clientPixels - координаты события в пикселях от левого верхнего угла окна браузера; - domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. || || [multitouchend](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md#event-multitouchend) | Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Имена полей, доступных через метод IMultiTouchEvent.get: - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - IOverlay - оверлей, на котором произошло событие; - coords - географические координаты точки, в которой произошло событие; - globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира; - pagePixels - координаты события в пикселях от левого верхнего угла страницы; - clientPixels - координаты события в пикселях от левого верхнего угла окна браузера; - domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. || || [multitouchmove](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md#event-multitouchmove) | Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Имена полей, доступных через метод IMultiTouchEvent.get: - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - IOverlay - оверлей, на котором произошло событие; - coords - географические координаты точки, в которой произошло событие; - globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира; - pagePixels - координаты события в пикселях от левого верхнего угла страницы; - clientPixels - координаты события в пикселях от левого верхнего угла окна браузера; - domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. || || [multitouchstart](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md#event-multitouchstart) | Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Имена полей, доступных через метод IMultiTouchEvent.get: - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - IOverlay - оверлей, на котором произошло событие; - coords - географические координаты точки, в которой произошло событие; - globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира; - pagePixels - координаты события в пикселях от левого верхнего угла страницы; - clientPixels - координаты события в пикселях от левого верхнего угла окна браузера; - domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. || || [optionschange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#event-optionschange) | Изменение в опциях объекта. Унаследовано от [ICustomizable](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#event-optionschange). || || [remove](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md#event-remove) | Удаление оверлея из коллекции. Экземпляр класса [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - удаленный оверлей. || || [wheel](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md#event-wheel) | Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - IOverlay - оверлей, на котором произошло событие; - coords - географические координаты точки, в которой произошло событие; - globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира; - pagePixels - координаты события в пикселях от левого верхнего угла страницы; - clientPixels - координаты события в пикселях от левого верхнего угла окна браузера; - domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. || |# ## Методы {#methods-summary} #| || **Имя** | **Возвращает** | **Описание** || || [each](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md#each)([callback](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md#each-param-callback), [context](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md#each-param-context)) | | || || [getAll](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md#getAll)() | Object[] | Возвращает массив объектов, содержащихся в коллекции. || || [getById](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md#getById)([id](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md#getById-param-id)) | Object\|null | Возвращает оверлей или null, если оверлея с переданным id не существует. || || [getId](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md#getId)([overlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md#getId-param-overlay)) | Number\|null | Возвращает идентификатор объекта или null, если оверлей не содержится в коллекции. || || [getIterator](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md#getIterator)() | [IIterator](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IIterator.md) | Возвращает итератор по коллекции. || || [getLength](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.OverlayCollection.md#getLength)() | Number | Возвращает количество объектов в коллекции. || |# ## Описание событий {#event_detail} ### add {#add} Добавление оверлея в коллекцию. Экземпляр класса [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - добавленный оверлей. ### click {#click} Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - IOverlay - оверлей, на котором произошло событие; - coords - географические координаты точки, в которой произошло событие; - globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира; - pagePixels - координаты события в пикселях от левого верхнего угла страницы; - clientPixels - координаты события в пикселях от левого верхнего угла окна браузера; - domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. ### contextmenu {#contextmenu} Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - IOverlay - оверлей, на котором произошло событие; - coords - географические координаты точки, в которой произошло событие; - globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира; - pagePixels - координаты события в пикселях от левого верхнего угла страницы; - clientPixels - координаты события в пикселях от левого верхнего угла окна браузера; - domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. ### dblclick {#dblclick} Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - IOverlay - оверлей, на котором произошло событие; - coords - географические координаты точки, в которой произошло событие; - globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира; - pagePixels - координаты события в пикселях от левого верхнего угла страницы; - clientPixels - координаты события в пикселях от левого верхнего угла окна браузера; - domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. ### mousedown {#mousedown} Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - IOverlay - оверлей, на котором произошло событие; - coords - географические координаты точки, в которой произошло событие; - globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира; - pagePixels - координаты события в пикселях от левого верхнего угла страницы; - clientPixels - координаты события в пикселях от левого верхнего угла окна браузера; - domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. ### mouseenter {#mouseenter} Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - IOverlay - оверлей, на котором произошло событие; - coords - географические координаты точки, в которой произошло событие; - globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира; - pagePixels - координаты события в пикселях от левого верхнего угла страницы; - clientPixels - координаты события в пикселях от левого верхнего угла окна браузера; - domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. ### mouseleave {#mouseleave} Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - IOverlay - оверлей, на котором произошло событие; - coords - географические координаты точки, в которой произошло событие; - globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира; - pagePixels - координаты события в пикселях от левого верхнего угла страницы; - clientPixels - координаты события в пикселях от левого верхнего угла окна браузера; - domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. ### mousemove {#mousemove} Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - IOverlay - оверлей, на котором произошло событие; - coords - географические координаты точки, в которой произошло событие; - globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира; - pagePixels - координаты события в пикселях от левого верхнего угла страницы; - clientPixels - координаты события в пикселях от левого верхнего угла окна браузера; - domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. ### mouseup {#mouseup} Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - IOverlay - оверлей, на котором произошло событие; - coords - географические координаты точки, в которой произошло событие; - globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира; - pagePixels - координаты события в пикселях от левого верхнего угла страницы; - clientPixels - координаты события в пикселях от левого верхнего угла окна браузера; - domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. ### multitouchend {#multitouchend} Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Имена полей, доступных через метод IMultiTouchEvent.get: - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - IOverlay - оверлей, на котором произошло событие; - coords - географические координаты точки, в которой произошло событие; - globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира; - pagePixels - координаты события в пикселях от левого верхнего угла страницы; - clientPixels - координаты события в пикселях от левого верхнего угла окна браузера; - domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. ### multitouchmove {#multitouchmove} Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Имена полей, доступных через метод IMultiTouchEvent.get: - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - IOverlay - оверлей, на котором произошло событие; - coords - географические координаты точки, в которой произошло событие; - globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира; - pagePixels - координаты события в пикселях от левого верхнего угла страницы; - clientPixels - координаты события в пикселях от левого верхнего угла окна браузера; - domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. ### multitouchstart {#multitouchstart} Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Имена полей, доступных через метод IMultiTouchEvent.get: - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - IOverlay - оверлей, на котором произошло событие; - coords - географические координаты точки, в которой произошло событие; - globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира; - pagePixels - координаты события в пикселях от левого верхнего угла страницы; - clientPixels - координаты события в пикселях от левого верхнего угла окна браузера; - domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. ### remove {#remove} Удаление оверлея из коллекции. Экземпляр класса [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - удаленный оверлей. ### wheel {#wheel} Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - objectId - идентификатор объекта, которому принадлежит оверлей; - overlay - IOverlay - оверлей, на котором произошло событие; - coords - географические координаты точки, в которой произошло событие; - globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира; - pagePixels - координаты события в пикселях от левого верхнего угла страницы; - clientPixels - координаты события в пикселях от левого верхнего угла окна браузера; - domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. ## Описание методов {#method_detail} ### each {#each} ```javascript {} each(callback, context) ``` **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || [`callback`](#each-param-callback)[*](*star) | — | Тип: Function Функция-обработчик, в которую передаются объекты коллекции. || || [`context`](#each-param-context)[*](*star) | — | Тип: Object Контекст исполнения функции-обработчика. || |# \* Обязательный параметр/опция. **Пример:** ```javascript objectManager.clusters.overlays.each(function (overlay) { overlay.options.set('cursor', 'help'); }); ``` ### getAll {#getAll} ```javascript {Object[]} getAll() ``` **Возвращает** массив объектов, содержащихся в коллекции. **Пример:** ```javascript var clusterOverlayArray = objectManager.clusters.overlays.getAll(); ``` ### getById {#getById} ```javascript {Object|null} getById(id) ``` **Возвращает** оверлей или null, если оверлея с переданным id не существует. **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || [`id`](#getById-param-id)[*](*star) | — | Тип: Number Идентификатор объекта, которому принадлежит оверлей. || |# \* Обязательный параметр/опция. **Пример:** ```javascript objectManager.objects.add('mouseenter', function (e) { var objectId = e.get('objectId'), overlay = objectManager.objects.overlays.getById(objectId); overlay.options.set('zIndex', 100); }); ``` ### getId {#getId} ```javascript {Number|null} getId(overlay) ``` **Возвращает **идентификатор объекта или null, если оверлей не содержится в коллекции. **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || [`overlay`](#getId-param-overlay)[*](*star) | — | Тип: [IOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md) Оверлей. || |# \* Обязательный параметр/опция. **Пример:** ```javascript objectManager.objects.overlays.each(function (overlay) { var objectId = objectManager.objects.overlays.getId(overlay); objectManager.objects.setObjectOptions(objectId, { preset: 'islands#redIcon' }); }); ``` ### getIterator {#getIterator} ```javascript {IIterator} getIterator() ``` **Возвращает** итератор по коллекции. **Пример:** ```javascript var it = objectManager.objects.overlays.getIterator(); var overlay; while ((overlay = it.getNext()) != it.STOP_ITERATION) { overlay.options.set('zIndex', 10); } ``` ### getLength {#getLength} ```javascript {Number} getLength() ``` **Возвращает **количество объектов в коллекции. **Пример:** ```javascript var objectsNumber = objectManager.objects.getLength(), overlaysNumber = objectManager.objects.overlays.getNumber(); alert('На данный момент на карте показано ' + overlaysNumber + ' из ' + objectsNumber.); ``` [*star]: Обязательный параметр.