IOverlay

Расширяет ICustomizable, IDomEventEmitter.

Интерфейс оверлея.

Конструктор | Поля | События | Методы

Конструктор

IOverlay()

Поля

Имя Тип Описание
events IEventManager

Менеджер событий.

Унаследовано от IDomEventEmitter.

options IOptionManager

Менеджер опций.

Унаследовано от ICustomizable.

События

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

Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.

contextmenu

Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.

datachange
Изменение данных. Поля данных:
  • oldData - старые данные;
  • newData - новые данные.
dblclick

Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.

geometrychange
Изменение геометрии. Поля данных:
  • oldGeometry - старая пиксельная геометрия;
  • newGeometry - новая пиксельная геометрия.
mapchange
Сменилась карта. Поля данных:
  • oldMap - старая карта;
  • newMap - новая карта.
mousedown

Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.

mouseenter

Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.

mouseleave

Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.

mousemove

Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.

mouseup

Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.

multitouchend

Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях.

Унаследовано от IDomEventEmitter.

multitouchmove

Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях.

Унаследовано от IDomEventEmitter.

multitouchstart

Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях.

Унаследовано от IDomEventEmitter.

optionschange

Изменение в опциях объекта.

Унаследовано от ICustomizable.

wheel

Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.

Методы

Имя Возвращает Описание
getData()

Object

Returns объект данных макета.

getGeometry()

IPixelGeometry

Returns текущую пиксельную геометрию.

getMap()

Map|null

Returns ссылку на текущую карту.

setData(data)

Задает данные оверлея.

setGeometry(geometry)

Задает пиксельную геометрию оверлея.

setMap(map)

Задает карту, на которой должен отобразиться оверлей.

Описание событий

datachange

Изменение данных. Поля данных:
  • oldData - старые данные;
  • newData - новые данные.

geometrychange

Изменение геометрии. Поля данных:
  • oldGeometry - старая пиксельная геометрия;
  • newGeometry - новая пиксельная геометрия.

mapchange

Сменилась карта. Поля данных:
  • oldMap - старая карта;
  • newMap - новая карта.

Описание методов

getData

{Object} getData()

Returns объект данных макета.

getGeometry

{IPixelGeometry} getGeometry()

Returns текущую пиксельную геометрию.

getMap

{Map|null} getMap()

Returns ссылку на текущую карту.

setData

{} setData(data)

Задает данные оверлея.

Параметры:

Параметр Значение по умолчанию Описание
data *

Тип: Object

Данные оверлея.

* Обязательный параметр/опция.

setGeometry

{} setGeometry(geometry)

Задает пиксельную геометрию оверлея.

Параметры:

Параметр Значение по умолчанию Описание
geometry *

Тип: IPixelGeometry

Геометрия в глобальных пиксельных координатах.

* Обязательный параметр/опция.

setMap

{} setMap(map)

Задает карту, на которой должен отобразиться оверлей.

Параметры:

Параметр Значение по умолчанию Описание
map *

Тип: Map|null

Ссылка на карту.

* Обязательный параметр/опция.