---
metadata:
  - name: generator
    content: Diplodoc Platform v5.37.1
alternate:
  - https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.object.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/jsapi-v1-1/doc/ru/llms.txt

# YMaps.Hotspots.Object

Класс объект-активная область в составе слоя активных областей.

## Конструктор

Имя | Описание
----- | -----
[YMaps.Hotspots.Object](hotspots.object.md#constructor)(layer, shapes, data, options) | Создает экземпляр класса "объект-активная область".

## Методы

Имя | Возвращает | Описание
----- | ----- | -----
[getData](hotspots.object.md#getData)() | Object | Возвращает ассоциированные с объектом данные.
[getLayer](hotspots.object.md#getLayer)() | [YMaps.Hotspots.Layer](hotspots.layer.md) | Возвращает слой, которому принадлежит данный объект.
[getNumShapes](hotspots.object.md#getNumShapes)() | Integer | Возвращает число геометрических фигур, принадлежащих объекту.
[getPriority](hotspots.object.md#getPriority)() | Number | Возвращает приоритет объекта.
[getShape](hotspots.object.md#getShape)(index) | [YMaps.Hotspots.IShape](hotspots.ishape.md) | Возвращает геометрическую фигуру по ее индексу.
[requestBalloonData](hotspots.object.md#requestBalloonData)(callback, event, shape) |  | Передает callback-функции содержание балуна объекта и точку привязки.
[requestHintData](hotspots.object.md#requestHintData)(callback, event, shape) |  | Передает callback-функции содержимое всплывающей подсказки объекта.


## Подробное описание конструктора {#constructor}

```javascript
YMaps.Hotspots.Object(layer, shapes, data, options)
```

Создает экземпляр класса "объект-активная область".

**Параметры:**

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`layer` | [YMaps.Hotspots.Layer](hotspots.layer.md) |  |  | Слой, которому принадлежит объект.
`shapes` | [YMaps.Hotspots.IShape](hotspots.ishape.md)[] |  |  | Массив геометрических фигур, соответствующих объекту.
`data` | Object | ![](../_images/check.png) |  | Данные, соответствующие объекту.
`options` | Object | ![](../_images/check.png) |  | Опции объекта.
`options.priority` | Number | ![](../_images/check.png) | 0 | Приоритет объекта.
`options.style` | [YMaps.Style](style.md)\|String | ![](../_images/check.png) |  | Стиль объекта, заданный объектом YMaps.Style или ключом стиля. К объектам YMaps.Hotspots.Object применяются только параметры стиля содержимого балуна и стиля содержимого всплывающей подсказки, остальные поля игнорируются.

## Подробное описание методов {#method_detail}

### getData {#getData}

```javascript
{Object} getData()
```

Возвращает ассоциированные с объектом данные.

**Возвращает:**

Тип | Описание
----- | -----
Object | Данные.

### getLayer {#getLayer}

```javascript
{YMaps.Hotspots.Layer} getLayer()
```

Возвращает слой, которому принадлежит данный объект.

**Возвращает:**

Тип | Описание
----- | -----
[YMaps.Hotspots.Layer](hotspots.layer.md) | Слой.

### getNumShapes {#getNumShapes}

```javascript
{Integer} getNumShapes()
```

Возвращает число геометрических фигур, принадлежащих объекту.

**Возвращает:**

Тип | Описание
----- | -----
Integer | Число фигур.

### getPriority {#getPriority}

```javascript
{Number} getPriority()
```

Возвращает приоритет объекта. Объекты с большим приоритетом считаются расположенными поверх объектов с меньшим приоритетом. При этом приоритет слоя объектов важнее приоритета самого объекта и не складывается с ним: объекты в слое с большим приоритетом всегда находятся выше объектов слоя с меньшим приоритетом.

**Возвращает:**

Тип | Описание
----- | -----
Number | Приоритет.

### getShape {#getShape}

```javascript
{YMaps.Hotspots.IShape} getShape(index)
```

Возвращает геометрическую фигуру по ее индексу.

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`index` | Integer | Индекс фигуры, считая с 0.


**Возвращает:**

Тип | Описание
----- | -----
[YMaps.Hotspots.IShape](hotspots.ishape.md) | Геометрическую фигуру.

### requestBalloonData {#requestBalloonData}

```javascript
requestBalloonData(callback, event, shape)
```

Передает callback-функции содержание балуна объекта и точку привязки.

По умолчанию содержимым балуна считается HTML вида:

`<h3>$[name]</h3><p>$[description]</p>`

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`callback` | Function | callback-функция.
`event` | [YMaps.MouseEvent](mouseevent.md) | Событие мыши.
`shape` | [YMaps.Hotspots.IShape](hotspots.ishape.md) | Фигура, на которой произошло событие.

### requestHintData {#requestHintData}

```javascript
requestHintData(callback, event, shape)
```

Передает callback-функции содержимое всплывающей подсказки объекта. По умолчанию содержимым всплывающей подсказки является поле name данных объекта.

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`callback` | Function | callback-функция.
`event` | [YMaps.MouseEvent](mouseevent.md) | Событие мыши.
`shape` | [YMaps.Hotspots.IShape](hotspots.ishape.md) | Фигура, на которой произошло событие.