YMaps.Regions.RegionHotspot
Расширяет YMaps.Hotspots.Overlay.
Активная область региона на карте.
Конструктор
Имя | Описание |
---|---|
YMaps.Regions.RegionHotspot(geometry, options) | Создает объект активной области региона на карте. |
Поля
Имя | Описание |
---|---|
metaDataProperty | Объект-контейнер для указания дополнительных свойств объекта. |
Наследуемые поля
Наследуемые события
- Из YMaps.Hotspots.Overlay:
- BalloonClose, BalloonOpen, Click, DblClick, MouseDown, MouseEnter, MouseLeave, MouseMove, MouseUp
Методы
Имя | Возвращает | Описание |
---|---|---|
getOptions() | YMaps.Regions.RegionHotspotOptions | Возвращает опции активной области региона на карте. |
setOptions(options) | Устанавливает опции активной области региона на карте. |
Наследуемые методы
Из YMaps.Hotspots.Overlay:
:getGeometry, getMap, getNumShapes, getShape, openBalloon, setGeometry
- Из YMaps.IOverlay:
- onAddToMap, onMapUpdate, onRemoveFromMap
- Из YMaps.IInteractiveGeoObject:
- closeBalloon, getBalloon, getBalloonContent, getBalloonOptions, getHintContent, getHintOptions, setBalloonContent, setBalloonOptions, setHintContent, setHintOptions, update
- Из YMaps.IGeoObject:
- getBounds, getComputedStyle, getParentGroup, getStyle, onAddToGroup, onRemoveFromGroup, setBounds, setStyle
Подробное описание конструктора
YMaps.Regions.RegionHotspot(geometry, options)
Создает объект активной области региона на карте.
Параметры:
Имя | Тип | Необязательный | По умолчанию | Описание |
---|---|---|---|---|
geometry |
Object[] | Описание геометрии области. Область состоит из множества геометрических фигур. Каждая фигура описывается объектом с двумя полями: shape - форма фигуры, coords - массив точек YMaps.ICoordPoint. Допустимые значения поля shape: 'rect' - прямоугольник (задается двумя точками: левой нижней и правой верхней), 'cpoly' - выпуклый многоугольник, 'npoly' - невыпуклый многоугольник. | ||
options |
YMaps.Regions.RegionHotspotOptions | ![]() |
Опции. |
Подробное описание полей
metaDataProperty
Object metaDataProperty
Объект-контейнер для указания дополнительных свойств объекта.
Содержит данные о фигурах активной области регионов.
Данные представлены в виде массива YMaps.Regions.RegionHotspot.metaDataProperty.encodedShapes, каждый элемент которого является объектом с двумя полями:
- coords: координаты вершин фигуры, закодированные в Base64;
- levels: строка кодов, определяющая для каждой вершины фигуры масштаб, начиная с которого вершина становится не видна.
Эти данные могут использоваться для создания графических объектов с помощью методов YMaps.Polygon.fromEncodedPoints и YMaps.Polyline.fromEncodedPoints.
Подробное описание методов
getOptions
{YMaps.Regions.RegionHotspotOptions} getOptions()
Возвращает опции активной области региона на карте.
Возвращает:
Тип | Описание |
---|---|
YMaps.Regions.RegionHotspotOptions | Объект опций. |
setOptions
setOptions(options)
Устанавливает опции активной области региона на карте.
Параметры:
Имя | Тип | Описание |
---|---|---|
options |
YMaps.Regions.RegionHotspotOptions | Объект опций. |