overlay.html.Balloon

Расширяет IOverlay.

HTML-оверлей балуна.

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

Конструктор

overlay.html.Balloon(geometry[, data[, options]])

Параметры:

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

Тип: IPixelPointGeometry

Пиксельная геометрия фигуры.

data

Тип: IDataManager|Object

Данные.

options

Тип: Object

Опции.

options.cursor

Тип: String

Курсор при наведении мыши.

options.interactivityModel 'default#opaque'

Тип: String

Модель интерактивности. Доступные ключи и их значения перечислены в описании interactivityModel.storage.

options.layout

Тип: Function|String

Макет. (Тип: конструктор объекта с интерфейсом ILayout).

options.offset [0,0]

Тип: Array

Смещение в пикселях.

options.pane "overlays"

Тип: String

Контейнер, в который будет помещен макет балуна.

options.shadow true

Тип: Boolean

Флаг наличия тени.

options.shadowLayout

Тип: Function|String

Макет тени (Тип: конструктор объекта с интерфейсом ILayout).

options.shadowOffset [0,0]

Тип: Array

Смещение тени в пикселях.

options.shadowPane "shadows"

Тип: Array

Контейнер, в который будет помещен макет тени балуна.

options.zIndex

Тип: Number

z-index элемента.

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

Тип: IPixelPointGeometry

Пиксельная геометрия фигуры.

data

Тип: IDataManager|Object

Данные.

options

Тип: Object

Опции.

options.cursor

Тип: String

Курсор при наведении мыши.

options.interactivityModel 'default#opaque'

Тип: String

Модель интерактивности. Доступные ключи и их значения перечислены в описании interactivityModel.storage.

options.layout

Тип: Function|String

Макет. (Тип: конструктор объекта с интерфейсом ILayout).

options.offset [0,0]

Тип: Array

Смещение в пикселях.

options.pane "overlays"

Тип: String

Контейнер, в который будет помещен макет балуна.

options.shadow true

Тип: Boolean

Флаг наличия тени.

options.shadowLayout

Тип: Function|String

Макет тени (Тип: конструктор объекта с интерфейсом ILayout).

options.shadowOffset [0,0]

Тип: Array

Смещение тени в пикселях.

options.shadowPane "shadows"

Тип: Array

Контейнер, в который будет помещен макет тени балуна.

options.zIndex

Тип: Number

z-index элемента.

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

Поля

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

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

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

options IOptionManager

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

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

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

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

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

options IOptionManager

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

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

События

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

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

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

contextmenu

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

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

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

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

dblclick

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

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

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

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

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

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

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.

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

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

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

contextmenu

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

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

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

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

dblclick

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

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

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

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

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

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

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.

Методы

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

HTMLElement

Returns родительский элемент макета балуна.

getBalloonLayout()

ILayout

Returns макет балуна.

getData()

Object

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

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

getElement()

HTMLElement

Returns родительский элемент макета балуна.

getGeometry()

IPixelGeometry

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

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

getLayout()

ILayout

Returns макет балуна.

getMap()

Map|null

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

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

getShadowElement()

HTMLElement

Returns родительский элемент макета тени балуна.

getShadowLayout()

ILayout

Returns макет тени балуна.

setData(data)

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

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

setGeometry(geometry)

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

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

setMap(map)

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

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

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

HTMLElement

Returns родительский элемент макета балуна.

getBalloonLayout()

ILayout

Returns макет балуна.

getData()

Object

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

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

getElement()

HTMLElement

Returns родительский элемент макета балуна.

getGeometry()

IPixelGeometry

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

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

getLayout()

ILayout

Returns макет балуна.

getMap()

Map|null

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

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

getShadowElement()

HTMLElement

Returns родительский элемент макета тени балуна.

getShadowLayout()

ILayout

Returns макет тени балуна.

setData(data)

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

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

setGeometry(geometry)

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

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

setMap(map)

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

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

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

getBalloonElement

{HTMLElement} getBalloonElement()

Returns родительский элемент макета балуна.

getBalloonLayout

{ILayout} getBalloonLayout()

Returns макет балуна.

getElement

{HTMLElement} getElement()

Returns родительский элемент макета балуна.

getLayout

{ILayout} getLayout()

Returns макет балуна.

getShadowElement

{HTMLElement} getShadowElement()

Returns родительский элемент макета тени балуна.

getShadowLayout

{ILayout} getShadowLayout()

Returns макет тени балуна.