YMaps.Hotspots.Object
Класс объект-активная область в составе слоя активных областей.
Конструктор
| Имя | Описание |
|---|---|
| YMaps.Hotspots.Object(layer, shapes, data, options) | Создает экземпляр класса "объект-активная область". |
Методы
| Имя | Возвращает | Описание |
|---|---|---|
| getData() | Object | Возвращает ассоциированные с объектом данные. |
| getLayer() | YMaps.Hotspots.Layer | Возвращает слой, которому принадлежит данный объект. |
| getNumShapes() | Integer | Возвращает число геометрических фигур, принадлежащих объекту. |
| getPriority() | Number | Возвращает приоритет объекта. |
| getShape(index) | YMaps.Hotspots.IShape | Возвращает геометрическую фигуру по ее индексу. |
| requestBalloonData(callback, event, shape) | Передает callback-функции содержание балуна объекта и точку привязки. | |
| requestHintData(callback, event, shape) | Передает callback-функции содержимое всплывающей подсказки объекта. |
Подробное описание конструктора
YMaps.Hotspots.Object(layer, shapes, data, options)
Создает экземпляр класса "объект-активная область".
Параметры:
| Имя | Тип | Необязательный | По умолчанию | Описание |
|---|---|---|---|---|
layer |
YMaps.Hotspots.Layer | Слой, которому принадлежит объект. | ||
shapes |
YMaps.Hotspots.IShape[] | Массив геометрических фигур, соответствующих объекту. | ||
data |
Object |  |
Данные, соответствующие объекту. | |
options |
Object | |
Опции объекта. | |
options.priority |
Number | |
0 | Приоритет объекта. |
options.style |
YMaps.Style|String | |
Стиль объекта, заданный объектом YMaps.Style или ключом стиля. К объектам YMaps.Hotspots.Object применяются только параметры стиля содержимого балуна и стиля содержимого всплывающей подсказки, остальные поля игнорируются. |
Подробное описание методов
getData
{Object} getData()
Возвращает ассоциированные с объектом данные.
Возвращает:
| Тип | Описание |
|---|---|
| Object | Данные. |
getLayer
{YMaps.Hotspots.Layer} getLayer()
Возвращает слой, которому принадлежит данный объект.
Возвращает:
| Тип | Описание |
|---|---|
| YMaps.Hotspots.Layer | Слой. |
getNumShapes
{Integer} getNumShapes()
Возвращает число геометрических фигур, принадлежащих объекту.
Возвращает:
| Тип | Описание |
|---|---|
| Integer | Число фигур. |
getPriority
{Number} getPriority()
Возвращает приоритет объекта. Объекты с большим приоритетом считаются расположенными поверх объектов с меньшим приоритетом. При этом приоритет слоя объектов важнее приоритета самого объекта и не складывается с ним: объекты в слое с большим приоритетом всегда находятся выше объектов слоя с меньшим приоритетом.
Возвращает:
| Тип | Описание |
|---|---|
| Number | Приоритет. |
getShape
{YMaps.Hotspots.IShape} getShape(index)
Возвращает геометрическую фигуру по ее индексу.
Параметры:
| Имя | Тип | Описание |
|---|---|---|
index |
Integer | Индекс фигуры, считая с 0. |
Возвращает:
| Тип | Описание |
|---|---|
| YMaps.Hotspots.IShape | Геометрическую фигуру. |
requestBalloonData
requestBalloonData(callback, event, shape)
Передает callback-функции содержание балуна объекта и точку привязки.
По умолчанию содержимым балуна считается HTML вида:
<h3>$[name]</h3><p>$[description]</p>
Параметры:
| Имя | Тип | Описание |
|---|---|---|
callback |
Function | callback-функция. |
event |
YMaps.MouseEvent | Событие мыши. |
shape |
YMaps.Hotspots.IShape | Фигура, на которой произошло событие. |
requestHintData
requestHintData(callback, event, shape)
Передает callback-функции содержимое всплывающей подсказки объекта. По умолчанию содержимым всплывающей подсказки является поле name данных объекта.
Параметры:
| Имя | Тип | Описание |
|---|---|---|
callback |
Function | callback-функция. |
event |
YMaps.MouseEvent | Событие мыши. |
shape |
YMaps.Hotspots.IShape | Фигура, на которой произошло событие. |