overlay.html.Placemark

Расширяет IOverlay.

HTML-оверлей метки. По умолчанию оверлеи не добавлены в package.full (стандартного набора модулей). Для создания собственного экземпляра оверлея необходимо использовать overlay.storage.

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

Конструктор

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

Параметры:

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

Тип: IPixelPointGeometry

Пикcельная геометрия.
data —

Тип: Object

Данные.
options —

Тип: Object

Опции.
options.cursor —

Тип: String

Курсор при наведении мыши.
options.interactivityModel 'default#geoObject'

Тип: String

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

Тип: Function|String

Макет. (Тип: конструктор объекта с интерфейсом ILayout).
options.offset [0,0]

Тип: Array

Смещение в пикселях.
options.pane 'places'

Тип: String

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

Тип: Boolean

Флаг наличия тени.
options.shadowLayout —

Тип: Function|String

Макет тени. (Тип: конструктор объекта с интерфейсом ILayout).
options.shadowOffset [0,0]

Тип: Array

Смещение тени в пикселях.
options.shadowsPane 'shadows'

Тип: Array

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

Тип: Number

z-index элемента.
Параметр Значение по умолчанию Описание
geometry * —

Тип: IPixelPointGeometry

Пикcельная геометрия.
data —

Тип: Object

Данные.
options —

Тип: Object

Опции.
options.cursor —

Тип: String

Курсор при наведении мыши.
options.interactivityModel 'default#geoObject'

Тип: String

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

Тип: Function|String

Макет. (Тип: конструктор объекта с интерфейсом ILayout).
options.offset [0,0]

Тип: Array

Смещение в пикселях.
options.pane 'places'

Тип: String

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

Тип: Boolean

Флаг наличия тени.
options.shadowLayout —

Тип: Function|String

Макет тени. (Тип: конструктор объекта с интерфейсом ILayout).
options.shadowOffset [0,0]

Тип: Array

Смещение тени в пикселях.
options.shadowsPane 'shadows'

Тип: Array

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

Тип: Number

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

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

Поля

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

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

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

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

Унаследовано от ICustomizable.
Имя Тип Описание
events IEventManager

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

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

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

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

События

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в 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.

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

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

Унаследовано от IDomEventEmitter.
Имя Описание
click

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в 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.

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

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

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

Методы

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

Object

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

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

HTMLElement

Возвращает родительский элемент макета иконки.
getGeometry()

IPixelGeometry

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

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

HTMLElement

Возвращает родительский элемент макета иконки.
getIconLayout()

vow.Promise

Возвращает Promise объект, который будет разрешен макетом иконки.
getIconLayoutSync()

ILayout|null

Возвращает макет иконки.
getLayout()

vow.Promise

Возвращает Promise объект, который будет разрешен макетом иконки.
getLayoutSync()

ILayout|null

Возвращает макет иконки.
getMap()

Map|null

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

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

HTMLElement

Возвращает родительский элемент макета тени иконки.
getShadowLayout()

vow.Promise

Возвращает Promise объект, который будет разрешен макетом тени иконки.
getShadowLayoutSync()

ILayout|null

Возвращает макет тени иконки.
getShape()

IShape|null

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

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

Boolean

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

Унаследован от IOverlay.
setData(data)

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

Унаследован от IOverlay.
setGeometry(geometry)

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

Унаследован от IOverlay.
setMap(map)

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

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

Object

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

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

HTMLElement

Возвращает родительский элемент макета иконки.
getGeometry()

IPixelGeometry

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

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

HTMLElement

Возвращает родительский элемент макета иконки.
getIconLayout()

vow.Promise

Возвращает Promise объект, который будет разрешен макетом иконки.
getIconLayoutSync()

ILayout|null

Возвращает макет иконки.
getLayout()

vow.Promise

Возвращает Promise объект, который будет разрешен макетом иконки.
getLayoutSync()

ILayout|null

Возвращает макет иконки.
getMap()

Map|null

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

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

HTMLElement

Возвращает родительский элемент макета тени иконки.
getShadowLayout()

vow.Promise

Возвращает Promise объект, который будет разрешен макетом тени иконки.
getShadowLayoutSync()

ILayout|null

Возвращает макет тени иконки.
getShape()

IShape|null

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

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

Boolean

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

Унаследован от IOverlay.
setData(data)

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

Унаследован от IOverlay.
setGeometry(geometry)

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

Унаследован от IOverlay.
setMap(map)

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

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

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

getElement

{HTMLElement} getElement()

Возвращает родительский элемент макета иконки.

getIconElement

{HTMLElement} getIconElement()

Возвращает родительский элемент макета иконки.

getIconLayout

{vow.Promise} getIconLayout()

Возвращает Promise объект, который будет разрешен макетом иконки.

getIconLayoutSync

{ILayout|null} getIconLayoutSync()

Возвращает макет иконки.

getLayout

{vow.Promise} getLayout()

Возвращает Promise объект, который будет разрешен макетом иконки.

getLayoutSync

{ILayout|null} getLayoutSync()

Возвращает макет иконки.

getShadowElement

{HTMLElement} getShadowElement()

Возвращает родительский элемент макета тени иконки.

getShadowLayout

{vow.Promise} getShadowLayout()

Возвращает Promise объект, который будет разрешен макетом тени иконки.

getShadowLayoutSync

{ILayout|null} getShadowLayoutSync()

Возвращает макет тени иконки.