Документация
Справочник JavaScript API
2.1.65 (текущая версия)
collection
interactivityModel
Интерфейсы

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.

emptinesschange

Изменение признака пустоты оверлея. Экземпляр класса Event.

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.

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

multitouchmove

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

  • clientX - координата касания X относительно видимой области браузера;
  • clientY - координата касания Y относительно видимой области браузера;
  • pageX - координата касания X касания относительно начала документа;
  • pageY - координата касания Y касания относительно начала документа.

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

multitouchstart

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

  • clientX - координата касания X относительно видимой области браузера;
  • clientY - координата касания Y относительно видимой области браузера;
  • pageX - координата касания X касания относительно начала документа;
  • pageY - координата касания Y касания относительно начала документа.

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

optionschange

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

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

shapechange

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

wheel

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

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

Методы

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

Object

Возвращает объект данных оверлея.

getGeometry()

IPixelGeometry

Возвращает текущую пиксельную геометрию.

getMap()

Map|null

Возвращает ссылку на текущую карту.

getShape()

IShape|null

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

isEmpty()

Boolean

Возвращает true, если макет пуст, т.е. не имеет содержимого. Данный признак используется для сокрытия пустых объектов, таких как хинт, балун и другие.

setData(data)

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

setGeometry(geometry)

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

setMap(map)

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

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

datachange

Изменение данных. Поля данных:

  • oldData - старые данные;
  • newData - новые данные.

emptinesschange

Изменение признака пустоты оверлея. Экземпляр класса Event.

geometrychange

Изменение геометрии. Поля данных:

  • oldGeometry - старая пиксельная геометрия;
  • newGeometry - новая пиксельная геометрия.

mapchange

Сменилась карта. Поля данных:

  • oldMap - старая карта;
  • newMap - новая карта.

shapechange

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

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

getData

{Object} getData()

Возвращает объект данных оверлея.

getGeometry

{IPixelGeometry} getGeometry()

Возвращает текущую пиксельную геометрию.

getMap

{Map|null} getMap()

Возвращает ссылку на текущую карту.

getShape

{IShape|null} getShape()

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

isEmpty

{Boolean} isEmpty()

Возвращает true, если макет пуст, т.е. не имеет содержимого. Данный признак используется для сокрытия пустых объектов, таких как хинт, балун и другие.

setData

{} setData(data)

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

Параметры:

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

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

]no-highlight]

Тип: Object

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

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

setGeometry

{} setGeometry(geometry)

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

Параметры:

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

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

]no-highlight]

Тип: IPixelGeometry

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

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

setMap

{} setMap(map)

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

Параметры:

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

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

]no-highlight]

Тип: Map|null

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

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