YMaps.Hotspots.IShape

Интерфейс фигуры, определяющей геометрию активной области.

Конструктор

Имя Описание
YMaps.Hotspots.IShape(coords)

Создает фигуру, определяющую геометрию активной области.

Примечание.

Все координаты задаются в пикселах на текущем масштабе, отсчитываемых от левого верхнего угла мира.

Чтобы преобразовать геокоординаты в пиксельные, необходимо воспользоваться методами YMaps.ICoordSystem.fromCoordPoint и YMaps.TileCoordinates.scale следующим образом:

map.tileCoordinates.scale(map.coordSystem.fromCoordPoint(geoPoint), map.coordSystem.getMaxZoom(), map.getZoom()).

Обратное преобразование выполняется следующим образом:

map.coordSystem.toCoordPoint(map.tileCoordinates.scale(pixelPoint))

Методы

Имя Возвращает Описание
contains(point) Boolean Проверяет принадлежность точки фигуре.
getMaxX() Number Возвращает максимальное значение первой координаты для точек фигуры.
getMaxY() Number Возвращает максимальное значение второй координаты для точек фигуры.
getMinX() Number Возвращает минимальное значение первой координаты для точек фигуры.
getMinY() Number Возвращает минимальное значение второй координаты для точек фигуры.
getOwner() YMaps.Hotspots.Object|YMaps.Hotspots.Overlay Возвращает активную область, которой принадлежит данная фигура.
setOwner(hotspot)

Задает активную область (YMaps.Hotspots.Object или YMaps.Hotspots.Overlay), которой принадлежит данная фигура.

Этот метод вызывается автоматически в конструкторе YMaps.Hotspots.Object для принадлежащих объекту-активной области фигур.

Подробное описание конструктора

YMaps.Hotspots.IShape(coords)

Создает фигуру, определяющую геометрию активной области.

Примечание.

Все координаты задаются в пикселах на текущем масштабе, отсчитываемых от левого верхнего угла мира.

Чтобы преобразовать геокоординаты в пиксельные, необходимо воспользоваться методами YMaps.ICoordSystem.fromCoordPoint и YMaps.TileCoordinates.scale следующим образом:

map.tileCoordinates.scale(map.coordSystem.fromCoordPoint(geoPoint), map.coordSystem.getMaxZoom(), map.getZoom()).

Обратное преобразование выполняется следующим образом:

map.coordSystem.toCoordPoint(map.tileCoordinates.scale(pixelPoint))

Параметры:

Имя Тип Описание
coords Integer[] Массив координат фигуры.

Подробное описание методов

contains

{Boolean} contains(point)

Проверяет принадлежность точки фигуре.

Параметры:

Имя Тип Описание
point YMaps.Point Точка.

Возвращает:

Тип Описание
Boolean true - точка лежит внутри фигуры, false - снаружи.

getMaxX

{Number} getMaxX()

Возвращает максимальное значение первой координаты для точек фигуры.

Возвращает:

Тип Описание
Number Максимальное значение.

getMaxY

{Number} getMaxY()

Возвращает максимальное значение второй координаты для точек фигуры.

Возвращает:

Тип Описание
Number Максимальное значение.

getMinX

{Number} getMinX()

Возвращает минимальное значение первой координаты для точек фигуры.

Возвращает:

Тип Описание
Number Минимальное значение.

getMinY

{Number} getMinY()

Возвращает минимальное значение второй координаты для точек фигуры.

Возвращает:

Тип Описание
Number Минимальное значение.

getOwner

Возвращает активную область, которой принадлежит данная фигура.

Возвращает:

Тип Описание
YMaps.Hotspots.Object|YMaps.Hotspots.Overlay Активную область.

setOwner

setOwner(hotspot)

Задает активную область (YMaps.Hotspots.Object или YMaps.Hotspots.Overlay), которой принадлежит данная фигура.

Этот метод вызывается автоматически в конструкторе YMaps.Hotspots.Object для принадлежащих объекту-активной области фигур.

Параметры:

Имя Тип Описание
hotspot YMaps.Hotspots.Object|YMaps.Hotspots.Overlay Активная область, которой принадлежит фигура.