YMaps.Hotspots.Layer

Слой активных областей.

Конструктор

Имя Описание
YMaps.Hotspots.Layer(objectSource, options) Создает слой активных областей. Каждая отдельная область в составе слоя представляет собой объект YMaps.Hotspots.Object.

Поля

Имя Описание
Events

Список событий слоя активных областей.

События

Имя Описание
BalloonClose

Закрытие балуна у объекта слоя.

Обработчик события получает следующие параметры:

  • ссылку на слой;
  • ссылку на объект-активную область YMaps.Hotspots.Object, над которым произошло событие;
BalloonOpen

Открытие балуна у объекта слоя.

Обработчик события получает следующие параметры:

  • ссылку на слой;
  • ссылку на объект-активную область YMaps.Hotspots.Object, над которым произошло событие;
  • объект YMaps.MouseEvent, описывающий событие;
  • геометрическую фигуру YMaps.Hotspots.IShape в составе активной области, над которой произошло событие.
Click

Щелчок мыши по объекту слоя.

Обработчик события получает следующие параметры:

  • ссылку на слой;
  • ссылку на объект-активную область YMaps.Hotspots.Object, над которым произошло событие;
  • объект YMaps.MouseEvent, описывающий событие;
  • геометрическую фигуру YMaps.Hotspots.IShape в составе активной области, над которой произошло событие.
DblClick

Двойной щелчок мыши по объекту слоя.

Обработчик события получает следующие параметры:

  • ссылку на слой;
  • ссылку на объект-активную область YMaps.Hotspots.Object, над которым произошло событие;
  • объект YMaps.MouseEvent, описывающий событие;
  • геометрическую фигуру YMaps.Hotspots.IShape в составе активной области, над которой произошло событие.
MouseDown

Над объектом слоя нажата кнопка мыши.

Обработчик события получает следующие параметры:

  • ссылку на слой;
  • ссылку на объект-активную область YMaps.Hotspots.Object, над которым произошло событие;
  • объект YMaps.MouseEvent, описывающий событие;
  • геометрическую фигуру YMaps.Hotspots.IShape в составе активной области, над которой произошло событие.
MouseEnter

Курсор наведен на объект слоя.

Обработчик события получает следующие параметры:

  • ссылку на слой;
  • ссылку на объект-активную область YMaps.Hotspots.Object, над которым произошло событие;
  • объект YMaps.MouseEvent, описывающий событие;
  • геометрическую фигуру YMaps.Hotspots.IShape в составе активной области, над которой произошло событие.
MouseLeave

Курсор убран с объекта слоя.

Обработчик события получает следующие параметры:

  • ссылку на слой;
  • ссылку на объект-активную область YMaps.Hotspots.Object, над которым произошло событие;
  • объект YMaps.MouseEvent, описывающий событие;
  • геометрическую фигуру YMaps.Hotspots.IShape в составе активной области, над которой произошло событие.
MouseMove

Движение мышью над объектом слоя.

Обработчик события получает следующие параметры:

  • ссылку на слой;
  • ссылку на объект-активную область YMaps.Hotspots.Object, над которым произошло событие;
  • объект YMaps.MouseEvent, описывающий событие;
  • геометрическую фигуру YMaps.Hotspots.IShape в составе активной области, над которой произошло событие.
MouseUp

Нажатая кнопка мыши отпущена.

Обработчик события получает следующие параметры:

  • ссылку на слой;
  • ссылку на объект-активную область YMaps.Hotspots.Object, над которым произошло событие;
  • объект YMaps.MouseEvent, описывающий событие;
  • геометрическую фигуру YMaps.Hotspots.IShape в составе активной области, над которой произошло событие.

Методы

Имя Возвращает Описание
getMap() YMaps.Map Возвращает карту, на которую добавлен слой активных областей.
getObjectSource() YMaps.Hotspots.ObjectSource Возвращает источник объектов слоя активных областей.
getOptions() YMaps.Hotspots.LayerOptions Возвращает опции слоя.
setOptions(options, restoreDefault) Задает опции слоя.
update() Обновляет слой активных областей. После выполнения этой команды будут перезапрошены объекты в текущем тайле.

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

YMaps.Hotspots.Layer(objectSource, options)

Создает слой активных областей. Каждая отдельная область в составе слоя представляет собой объект YMaps.Hotspots.Object.

Параметры:

Имя Тип Описание
objectSource YMaps.Hotspots.IObjectSource Источник объектов слоя.
options YMaps.Hotspots.LayerOptions Опции слоя.

Подробное описание полей

Events

Object Events

Список событий слоя активных областей.

Подробное описание событий

BalloonClose

BalloonClose

Закрытие балуна у объекта слоя.

Обработчик события получает следующие параметры:

  • ссылку на слой;
  • ссылку на объект-активную область YMaps.Hotspots.Object, над которым произошло событие;

BalloonOpen

BalloonOpen

Открытие балуна у объекта слоя.

Обработчик события получает следующие параметры:

  • ссылку на слой;
  • ссылку на объект-активную область YMaps.Hotspots.Object, над которым произошло событие;
  • объект YMaps.MouseEvent, описывающий событие;
  • геометрическую фигуру YMaps.Hotspots.IShape в составе активной области, над которой произошло событие.

Click

Click

Щелчок мыши по объекту слоя.

Обработчик события получает следующие параметры:

  • ссылку на слой;
  • ссылку на объект-активную область YMaps.Hotspots.Object, над которым произошло событие;
  • объект YMaps.MouseEvent, описывающий событие;
  • геометрическую фигуру YMaps.Hotspots.IShape в составе активной области, над которой произошло событие.

DblClick

DblClick

Двойной щелчок мыши по объекту слоя.

Обработчик события получает следующие параметры:

  • ссылку на слой;
  • ссылку на объект-активную область YMaps.Hotspots.Object, над которым произошло событие;
  • объект YMaps.MouseEvent, описывающий событие;
  • геометрическую фигуру YMaps.Hotspots.IShape в составе активной области, над которой произошло событие.

MouseDown

MouseDown

Над объектом слоя нажата кнопка мыши.

Обработчик события получает следующие параметры:

  • ссылку на слой;
  • ссылку на объект-активную область YMaps.Hotspots.Object, над которым произошло событие;
  • объект YMaps.MouseEvent, описывающий событие;
  • геометрическую фигуру YMaps.Hotspots.IShape в составе активной области, над которой произошло событие.

MouseEnter

MouseEnter

Курсор наведен на объект слоя.

Обработчик события получает следующие параметры:

  • ссылку на слой;
  • ссылку на объект-активную область YMaps.Hotspots.Object, над которым произошло событие;
  • объект YMaps.MouseEvent, описывающий событие;
  • геометрическую фигуру YMaps.Hotspots.IShape в составе активной области, над которой произошло событие.

MouseLeave

MouseLeave

Курсор убран с объекта слоя.

Обработчик события получает следующие параметры:

  • ссылку на слой;
  • ссылку на объект-активную область YMaps.Hotspots.Object, над которым произошло событие;
  • объект YMaps.MouseEvent, описывающий событие;
  • геометрическую фигуру YMaps.Hotspots.IShape в составе активной области, над которой произошло событие.

MouseMove

MouseMove

Движение мышью над объектом слоя.

Обработчик события получает следующие параметры:

  • ссылку на слой;
  • ссылку на объект-активную область YMaps.Hotspots.Object, над которым произошло событие;
  • объект YMaps.MouseEvent, описывающий событие;
  • геометрическую фигуру YMaps.Hotspots.IShape в составе активной области, над которой произошло событие.

MouseUp

MouseUp

Нажатая кнопка мыши отпущена.

Обработчик события получает следующие параметры:

  • ссылку на слой;
  • ссылку на объект-активную область YMaps.Hotspots.Object, над которым произошло событие;
  • объект YMaps.MouseEvent, описывающий событие;
  • геометрическую фигуру YMaps.Hotspots.IShape в составе активной области, над которой произошло событие.

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

getMap

{YMaps.Map} getMap()

Возвращает карту, на которую добавлен слой активных областей.

Возвращает:

Тип Описание
YMaps.Map Карту.

getObjectSource

{YMaps.Hotspots.ObjectSource} getObjectSource()

Возвращает источник объектов слоя активных областей.

Возвращает:

Тип Описание
YMaps.Hotspots.ObjectSource Источник объектов.

getOptions

Возвращает опции слоя.

Возвращает:

Тип Описание
YMaps.Hotspots.LayerOptions Опции слоя.

setOptions

setOptions(options, restoreDefault)

Задает опции слоя.

Параметры:

Имя Тип Необязательный По умолчанию Описание
options YMaps.Hotspots.LayerOptions Опции слоя.
restoreDefault Boolean false true - восстановить значения по умолчанию для незаданных опций, false - не восстанавливать.

update

update()

Обновляет слой активных областей. После выполнения этой команды будут перезапрошены объекты в текущем тайле.