---
metadata:
- name: generator
content: Diplodoc Platform v5.39.1
alternate:
- https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ClusterPlacemark.md
- https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ClusterPlacemark.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/jsapi-v2-1/doc/ru/llms.txt
# ClusterPlacemark
Расширяет [IGeoObject](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md), [collection.Item](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/collection.Item.md).
Кластер геообъектов. Используется по умолчанию в [Clusterer](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Clusterer.md).
[Конструктор](#constructor-summary) | [Поля ](#properties-summary) | [События ](#events-summary) | [Методы ](#methods-summary)
## Конструктор {#constructor-summary}
```javascript
ClusterPlacemark(geometry, properties[, options])
```
**Параметры:**
#|
|| **Параметр** | **Значение по умолчанию** | **Описание** ||
|| [`geometry`](#param-geometry)[*](*star) | — | Тип: Number\[]\|Object\|[IPointGeometry](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPointGeometry.md)
Координаты метки или хэш с описанием геометрии, или ссылка на объект точечной геометрии. ||
|| [`properties`](#param-properties)[*](*star) | — | Тип: [IDataManager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDataManager.md)
Данные кластера. ||
|| [`properties.geoObjects`](#param-properties.geoObjects)[*](*star) | — | Тип: [IGeoObject](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md)[]
Массив геообъектов, которые находятся в данном кластере. ||
|| [`options`](#param-options)| — | Тип: Object
Опции кластера. Помимо частных опций, балун кластера поддерживает те же опции, что и [Balloon](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Balloon.md). Опции для балуна кластера указываются с префикcом 'balloon'. ||
|| [`options.balloonContentLayout`](#param-options.balloonContentLayout)| 'cluster#balloonTwoColumns' | Тип: Function\|String
Макет балуна кластера в обычном режиме. Можно передать конструктор объекта с интерфейсом [ILayout](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ILayout.md) или ключ одного из стандартных макетов. Каждый стандартный макет имеет некоторые собственные опции. В стандартных макетах по умолчанию используются поля данных геообъектов: clusterCaption, balloonContentHeader, balloonContent и balloonContentFooter (см. [Placemark](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Placemark.md)).
- 'cluster#balloonTwoColumns' - Макет с двумя колонками. В левой колонке находится список названий меток (поле данных метки clusterCaption или balloonContentHeader, если предыдущее поле не определено). В правой колонке располагается вся информация о геообъекте. Опции макета:
- balloonLeftColumnWidth — ширина поля со списком объектов в балуне кластера в пикселях. Значение по умолчанию: 125
- 'cluster#balloonCarousel' - Информация о геообъекте располагается в центре. По бокам размещаются кнопки перехода к предыдущему и следующему геообъекту. В нижней части балуна находится меню быстрой навигации. Опции макета:
- balloonCycling — цикличность списка при навигации боковыми стрелками. Значение по умолчанию: true
- balloonPagerSize — количество элементов навигации в нижней панели. Значение по умолчанию зависит от типа устройства. Для мобильных телефонов — это 4, а для планшетов и персональных компьютеров — 9.
- balloonPagerType — тип нижней панели навигации. Может принимать значения 'numeric' и 'marker'.
- numeric — отображение номера геообъекта в списке;
- marker — отображение маркеров без номеров. Рекомендуется использовать при количестве элементов в кластере меньшем или равном значению options.balloonPagerSize.
Значение по умолчанию: numeric.
- balloonPagerVisible — отображать ли панель навигации. Значение по умолчанию: true
- 'cluster#balloonAccordion' - Информация о геообъектах отображается в виде списка. Каждый элемент списка - это маленькая иконка и название метки (поле данных метки clusterCaption или balloonContentHeader, если предыдущее поле не определено). Цвет иконок соответствует цвету метки. Цвет метки определяется опцией "iconColor" [Placemark](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Placemark.md). В браузере Internet Explorer ниже 9й версии иконки не отображаются всегда. После клика по элементу списка под ним разворачивается информация о геообъекте. Опции макета:
- balloonAccordionShowIcons — опция, которая определяет, отображать ли иконку геообъекта в макете 'cluster#balloonAccordionItemTitle'. В браузере Internet Explorer ниже 9й версии опция не используется. Значение по умолчанию: true ||
|| [`options.balloonContentLayoutHeight`](#param-options.balloonContentLayoutHeight)| — | Тип: Number
Высота макета контента балуна кластера. По умолчанию опция балуна balloonMaxHeight для кластера не установлена, так как все стандартные макеты балунов кластеров имеют определенные размеры. Стандартное значение зависит от макета.
- 'cluster#balloonTwoColumns' - 210 пикселей
- 'cluster#balloonCarousel' - 177 пикселей
- 'cluster#balloonAccordion' - 283 пикселей ||
|| [`options.balloonContentLayoutWidth`](#param-options.balloonContentLayoutWidth)| — | Тип: Number
Ширина макета контента балуна кластера. По умолчанию опция балуна balloonMaxWidth для кластера не установлена, так как все стандартные макеты балунов кластеров имеют определенные размеры. Стандартное значение зависит от макета.
- 'cluster#balloonTwoColumns' - 475 пикселей
- 'cluster#balloonCarousel' - 308 пикселей
- 'cluster#balloonAccordion' - 305 пикселей
Опция не используется в режиме панели. ||
|| [`options.balloonItemContentLayout`](#param-options.balloonItemContentLayout)| — | Тип: [ILayout](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ILayout.md)\|String
Макет с информацией о геообъекте. Стандартное значение зависит от макета.
- В макете 'cluster#balloonTwoColumns' отображается справа от списка. Стандартноe значение 'cluster#balloonTwoColumnsItemContent'.
- В макете 'cluster#balloonCarousel' отображается в центре. Стандартно значение 'cluster#balloonCarouselItemContent'.
- В макете 'cluster#balloonAccordion' отображает после клика по элементу списка. Стандартно значение 'cluster#balloonAccordionItemContent'.
** Набор полей, которые поступают в данный макет, отличаются от родительского и соответствует полям, которые поступают в обычный макет балуна геообъекта. Еще были добавлены поля ownerProperties, ownerOptions и ownerState для доступа к данным кластера. ** ||
|| [`options.balloonPanelContentLayout`](#param-options.balloonPanelContentLayout)| null | Тип: Function\|String
Макет балуна кластера в режиме "панель". Можно передать конструктор объекта с интерфейсом [ILayout](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ILayout.md). Доступные значения такие же, как и у опции 'balloonContentLayout'. Если значение равно null, то применяется значение опции 'balloonContentLayout'. ||
|| [`options.cursor`](#param-options.cursor)| 'pointer' | Тип: String
Курсор над меткой кластера. ||
|| [`options.disableClickZoom`](#param-options.disableClickZoom)| false | Тип: Boolean
Флаг, запрещающий увеличение коэффициента масштабирования карты при клике на кластер. ||
|| [`options.hideIconOnBalloonOpen`](#param-options.hideIconOnBalloonOpen)| true | Тип: Boolean
Скрывать иконку при открытии балуна. ||
|| [`options.iconColor`](#param-options.iconColor)| — | Тип: String
Цвет иконки кластера. Эта опция применяется для стандартных иконок в браузерах, поддерживающих SVG. ||
|| [`options.iconContentLayout`](#param-options.iconContentLayout)| 'cluster#iconContent' | Тип: Function\|String
Макет содержимого метки кластера. (Тип: конструктор объекта с интерфейсом [ILayout](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ILayout.md) или ключ макета). Если у метки не нужно отображать содержимое, значение опции нужно выставить в null. ||
|| [`options.iconLayout`](#param-options.iconLayout)| 'cluster#icon' | Тип: Function\|String
Макет метки кластера (Тип: конструктор объекта с интерфейсом [ILayout](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ILayout.md) или ключ макета). ||
|| [`options.icons`](#param-options.icons)| — | Тип: Object[]
Массив, описывающий иконки для стандартной реализации кластера. Описание иконки представляет из себя объект с полями
- href - ссылка на картинку;
- size - массив из двух чисел - размер иконки в пикселях;
- offset - смещение иконки относительно точки привязки объекта;
- shape - необязательное поле. Объект, реализующий интерфейс [IShape](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IShape.md) или JSON-описание геометрии. Позволяет задавать описание геометрии иконки. Если параметр отсутствует, то активной для событий (наведение мыши, клик) будет считаться прямоугольная область вокруг иконки. ||
|| [`options.iconShape`](#param-options.iconShape)| — | Тип: [IGeometryJson](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeometryJson.md)\|null
Фигура активной области метки кластера. Задается в виде JSON-описания пиксельной геометрии иконки. Эту опцию нужно использовать при создании своих HTML макетов. Координаты геометрии фигуры отсчитываются от точки привязки. ||
|| [`options.interactivityModel`](#param-options.interactivityModel)| 'default#geoObject' | Тип: String
Модель интерактивности кластера. Доступные ключи и их значения перечислены в описании [interactivityModel.storage](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/interactivityModel.storage.md). ||
|| [`options.numbers`](#param-options.numbers)| [10, 100] | Тип: Number[]
Массив, описывающий граничные значения для размеров кластеров. Количество иконок, описанных в опции "icons", должно быть на 1 больше, чем чисел в данном массиве. ||
|| [`options.openBalloonOnClick`](#param-options.openBalloonOnClick)| true | Тип: Boolean
Опция, позволяющая запретить открытие балуна при клике на кластере. По умолчанию открытие балуна разрешено; ||
|| [`options.openEmptyHint`](#param-options.openEmptyHint)| false | Тип: Boolean
Опция, включающая показ пустых всплывающих подсказок. По умолчанию пустые хинты кластера не показываются. ||
|| [`options.openHintOnHover`](#param-options.openHintOnHover)| true | Тип: Boolean
Опция, позволяющая запретить показ всплывающей подсказки при наведении на кластер. По умолчанию показ хинтов разрешен. ||
|| [`options.zIndexHover`](#param-options.zIndexHover)| — | Тип: Number
Значение zIndex, которое выставляется метке кластера при наведении. ||
|#
\* Обязательный параметр/опция.
**Примеры:**
**1.**
```javascript
// Переменная с описанием двух видов иконок кластеров.
var clusterIcons = [
{
href: 'small.png',
size: [40, 40],
// Отступ, чтобы центр картинки совпадал с центром кластера.
offset: [-20, -20]
},
{
href: 'big.png',
size: [60, 60],
offset: [-30, -30],
// Можно задать геометрию активной области метки.
// Если геометрия не задана, активной областью будет
// прямоугольник.
shape: {
type: 'Circle',
coordinates: [0, 0],
radius: 30
}
}],
// При размере кластера до 100 будет использована 'small.png'.
// При размере кластера больше 100 будет использована 'big.png'.
clusterNumbers = [100],
// Сделаем макет содержимого иконки кластера,
// в котором цифры будут раскрашены в белый цвет.
MyIconContentLayout = ymaps.templateLayoutFactory.createClass(
'{{ properties.geoObjects.length }}
'
),
var clusterer = new ymaps.Clusterer({
// Если опции для кластеров задаются через кластеризатор,
// необходимо указывать их с префиксами "cluster".
clusterIcons: clusterIcons,
clusterNumbers: clusterNumbers,
clusterIconContentLayout: MyIconContentLayout
});
```
**2.**
```javascript
// Создание кластеризатора с макетом-каруселью.
var clusterer = new ymaps.Clusterer({
clusterDisableClickZoom: true,
// Используем макет "карусель"
clusterBalloonContentLayout: "cluster#balloonCarousel",
// Запрещаем зацикливание списка при постраничной навигации.
clusterBalloonCycling: false,
// Настройка внешнего вида панели навигации.
// Элементами панели навигации будут маркеры.
clusterBalloonPagerType: "marker",
// Количество элементов в панели.
clusterBalloonPagerSize: 6
});
```
**3.**
```javascript
// Создание кластеризатора с макетом-аккордеоном
var clusterer = new ymaps.Clusterer({
clusterDisableClickZoom: true,
// Используем макет "аккордеон"
clusterBalloonContentLayout: "cluster#balloonAccordion"
});
```
**4.**
```javascript
// Создание кластеризатора с произвольным HTML-макетом иконки кластера.
var clusterer = new ymaps.Clusterer({
// Зададим макет метки кластера.
clusterIconLayout: ymaps.templateLayoutFactory.createClass('{{ properties.geoObjects.length }}
'),
// Чтобы метка была кликабельной, переопределим ее активную область.
clusterIconShape: {
type: 'Rectangle',
coordinates: [[0, 0], [20, 20]]
}
});
```
## Поля {#properties-summary}
#|
|| **Имя** | **Тип** | **Описание** ||
|| [events](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#events) | [IEventManager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventManager.md) | Менеджер событий.
Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#events).||
|| [geometry](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#geometry) | [IGeometry](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeometry.md)\|null | Геометрия геообъекта.
Унаследовано от [IGeoObject](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#geometry).||
|| [options](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#options) | [IOptionManager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOptionManager.md) | Менеджер опций.
Унаследовано от [ICustomizable](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#options).||
|| [properties](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#properties) | [IDataManager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDataManager.md) | Данные геообъекта.
Унаследовано от [IGeoObject](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#properties).||
|| [state](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ClusterPlacemark.md#state) | [data.Manager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/data.Manager.md) | Состояние кластера. Определяется следующими полями:
- activeObject - Cсылка на активный объект кластера. Активным объектом является тот, который в данный момент выбран в балуне кластера. ||
- |#
## События {#events-summary}
#|
|| **Имя** | **Описание** ||
|| [click](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-click) | Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).
Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-click).||
|| [contextmenu](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-contextmenu) | Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).
Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-contextmenu).||
|| [dblclick](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-dblclick) | Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).
Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-dblclick).||
|| [geometrychange](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#event-geometrychange) | Изменение геометрии геообъекта. Экземпляр класса [Event](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). Имена полей, доступных через метод [Event.get](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- originalEvent: [IEvent](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md) - оригинальное событие геометрии.
Унаследовано от [IGeoObject](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#event-geometrychange).||
|| [mapchange](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md#event-mapchange) | Сменилась карта. Поля данных:
- oldMap - старая карта;
- newMap - новая карта.
Унаследовано от [IParentOnMap](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md#event-mapchange).||
|| [mousedown](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousedown) | Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).
Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousedown).||
|| [mouseenter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseenter) | Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).
Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseenter).||
|| [mouseleave](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseleave) | Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).
Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseleave).||
|| [mousemove](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousemove) | Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).
Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousemove).||
|| [mouseup](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseup) | Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).
Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseup).||
|| [multitouchend](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchend) | Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent.
Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchend).||
|| [multitouchmove](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchmove) | Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля:
- clientX - координата касания X относительно видимой области браузера;
- clientY - координата касания Y относительно видимой области браузера;
- pageX - координата касания X касания относительно начала документа;
- pageY - координата касания Y касания относительно начала документа.
Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchmove).||
|| [multitouchstart](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchstart) | Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля:
- clientX - координата касания X относительно видимой области браузера;
- clientY - координата касания Y относительно видимой области браузера;
- pageX - координата касания X касания относительно начала документа;
- pageY - координата касания Y касания относительно начала документа.
Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchstart).||
|| [optionschange](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#event-optionschange) | Изменение в опциях объекта.
Унаследовано от [ICustomizable](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#event-optionschange).||
|| [overlaychange](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#event-overlaychange) | Изменение оверлея геообъекта. Экземпляр класса [Event](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). Имена полей, доступных через метод [Event.get](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- overlay: [IOverlay](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md)\|null - ссылка на оверлей;
- oldOverlay: [IOverlay](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md)\|null - предыдущий оверлей геообъекта.
Унаследовано от [IGeoObject](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#event-overlaychange).||
|| [parentchange](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChild.md#event-parentchange) | Сменился родительский объект.
Поля данных:
- oldParent - старый родитель;
- newParent - новый родитель.
Унаследовано от [IChild](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChild.md#event-parentchange).||
|| [propertieschange](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#event-propertieschange) | Изменение данных геообъекта. Экземпляр класса [Event](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). Имена полей, доступных через метод [Event.get](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- originalEvent: [IEvent](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md) - оригинальное событие менеджера данных.
Унаследовано от [IGeoObject](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#event-propertieschange).||
|| [wheel](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-wheel) | Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).
Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-wheel). ||
|#
## Методы {#methods-summary}
#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [getBounds](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ClusterPlacemark.md#getBounds)() | Number[][]\|null | Возвращает географические координаты прямоугольной области, охватывающей все элементы кластера.||
|| [getGeoObjects](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ClusterPlacemark.md#getGeoObjects)() | [IGeoObject](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md)[] | Метод является упрощенным вызовом cluster.properties.get('geoObjects');||
|| [getMap](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md#getMap)() | [Map](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Map.md) | Возвращает ссылку на карту.
Унаследован от [IParentOnMap](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md#getMap).||
|| [getOverlay](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#getOverlay)() | [vow.Promise](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Возвращает объект-обещание, который подтверждается объектом оверлея в момент его фактического создания, либо отклоняется с передачей соответствующей ошибки.
Унаследован от [IGeoObject](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#getOverlay).||
|| [getOverlaySync](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#getOverlaySync)() | [IOverlay](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md)\|null | Метод предоставляет синхронный доступ к оверлею.
Унаследован от [IGeoObject](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#getOverlaySync).||
|| [getParent](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#getParent)() | [IParentOnMap](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md)\|null | Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен.
Унаследован от [IChildOnMap](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#getParent).||
|| [onAddToMap](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/collection.Item.md#onAddToMap)([map](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/collection.Item.md#onAddToMap-param-map)) | | Функция, которая вызывается при добавлении элемента на карту. Для выполнения дополнительных действий при добавлении объекта на карту переопределите эту функцию.
Унаследован от [collection.Item](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/collection.Item.md#onAddToMap).||
|| [onRemoveFromMap](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/collection.Item.md#onRemoveFromMap)([oldMap](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/collection.Item.md#onRemoveFromMap-param-oldMap)) | | Функция, которая вызывается при удалении элемента с карты. Для выполнения дополнительных действий при удалении объекта с карты переопределите эту функцию.
Унаследован от [collection.Item](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/collection.Item.md#onRemoveFromMap).||
|| [setParent](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#setParent)([parent](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#setParent-param-parent)) | [IChildOnMap](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md) | Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта.
Унаследован от [IChildOnMap](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#setParent). ||
|#
# Описание полей {#field_detail}
### state {#state}
```javascript
{data.Manager} state
```
Состояние кластера. Определяется следующими полями:
- activeObject - Cсылка на активный объект кластера. Активным объектом является тот, который в данный момент выбран в балуне кластера.
**Пример:**
```javascript
var geoObjects = cluster.properties.get('geoObjects');
// При открытии балуна кластера будет выбран третий объект в списке.
cluster.state.set('activeObject', geoObjects[2]);
```
## Описание методов {#method_detail}
### getBounds {#getBounds}
```javascript
{Number[][]|null} getBounds()
```
**Возвращает **географические координаты прямоугольной области, охватывающей все элементы кластера.
### getGeoObjects {#getGeoObjects}
```javascript
{IGeoObject[]} getGeoObjects()
```
Метод является упрощенным вызовом cluster.properties.get('geoObjects');
**Возвращает **массив геообъектов, образующих кластер.
[*star]: Обязательный параметр.