overlay.Rectangle

Расширяет IOverlay.

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

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

Конструктор

overlay.Rectangle(geometry[, data[, options]])

Параметры:

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

Тип: IPixelRectangleGeometry

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

data

Тип: Object

Данные.

options

Тип: Object

Опции.

options.borderRadius

Тип: Number

Радиус скругления углов.

options.fill

Тип: String

Наличие заливки.

options.fillColor

Тип: String

Цвет заливки graphics.style.color.

options.fillImageHref

Тип: String

Фоновое изображение. При включении данной опции значение fillColor игнорируется.

options.fillMethod'stretch'

Тип: String

Тип заливки фоном. Может принимать одно из двух значений:
  • stretch - фоновое изображение растягивается по размеру оверлея.
  • tile - Фоновое изображение повторяется без изменений размера. Аналог background-repeat в css. Можно использовать для заливки фигуры неким шаблоном.
options.fillOpacity

Тип: Number

Прозрачность заливки.

options.interactivetrue

Тип: Boolean

Опция, позволяющая отключить реакцию объекта на dom-события.

options.opacity

Тип: Number

Общая прозрачность.

options.outline

Тип: String

Наличие обводки.

options.separateContainer

Тип: Boolean

Производит отрисовку в отдельном слое.

options.strokeColor

Тип: String

Цвет линии graphics.style.color.

options.strokeOpacity

Тип: Number

Прозрачность контура.

options.strokeStyle

Тип: Number[]|String

Стиль контура(не поддерживается в режиме Canvas) graphics.style.stroke.

options.strokeWidth

Тип: Number

Ширина линии.

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

Поля

ИмяТипОписание
eventsIEventManager

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

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

optionsIOptionManager

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

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

События

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

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

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

contextmenu

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

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

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

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

dblclick

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

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

emptinesschange

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

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

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.

Унаследовано от 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

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

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

Методы

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

Object

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

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

getGeometry()

IPixelGeometry

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

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

getMap()

Map|null

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

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

getShape()

IShape|null

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

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

isEmpty()

Boolean

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

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

setData(data)

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

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

setGeometry(geometry)

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

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

setMap(map)

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

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