overlay.html.rectangle.Layout

Расширяет ILayout.

Собственный макет для HTML оверлея прямоугольника.

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

Конструктор

overlay.html.rectangle.Layout(dataSet)

Параметры:

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

Тип: Object
dataSet.options.borderRadius —

Тип: Number

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

Тип: String

Цвет заливки graphics.style.color.
dataSet.options.fillImageHref —

Тип: String

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

Тип: String

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

Тип: Number

Прозрачность заливки.
dataSet.options.opacity —

Тип: Number

Общая прозрачность.
dataSet.options.strokeColor —

Тип: String

Цвет линии graphics.style.color.
dataSet.options.strokeStyle —

Тип: Number[]|String

Стиль обводки, поддерживаемый стандартным CSS-свойством border-style.
dataSet.options.strokeWidth —

Тип: Number

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

Тип: Object
dataSet.options.borderRadius —

Тип: Number

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

Тип: String

Цвет заливки graphics.style.color.
dataSet.options.fillImageHref —

Тип: String

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

Тип: String

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

Тип: Number

Прозрачность заливки.
dataSet.options.opacity —

Тип: Number

Общая прозрачность.
dataSet.options.strokeColor —

Тип: String

Цвет линии graphics.style.color.
dataSet.options.strokeStyle —

Тип: Number[]|String

Стиль обводки, поддерживаемый стандартным CSS-свойством border-style.
dataSet.options.strokeWidth —

Тип: Number

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

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

Поля

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

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

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

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

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

События

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

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

Унаследовано от IDomEventEmitter.
clientboundschange
Изменение координат верхней левой и нижней правой точек внешнего прямоугольника элемента по отношению к родительскому элементу. Это событие не является обязательным; если оно отсутствует, то метод getClientBounds тоже не должен присутствовать. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • oldClientBounds - старые значения верхней левой и нижней правой точек прямоугольника элемента;
  • newClientBounds - новые значения верхней левой и нижней правой точек прямоугольника элемента.

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

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

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

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

Унаследовано от IDomEventEmitter.
emptinesschange
Изменение признака пустоты макета. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • oldEmptiness - старое значение признака;
  • newEmptiness - новое значение признака.

Унаследовано от ILayout.
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.
parentelementchange
Изменение родительского элемента. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • oldParentElement - старый родительский элемент;
  • newParentElement - новый родительский элемент.

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

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

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

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

Унаследовано от IDomEventEmitter.
clientboundschange
Изменение координат верхней левой и нижней правой точек внешнего прямоугольника элемента по отношению к родительскому элементу. Это событие не является обязательным; если оно отсутствует, то метод getClientBounds тоже не должен присутствовать. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • oldClientBounds - старые значения верхней левой и нижней правой точек прямоугольника элемента;
  • newClientBounds - новые значения верхней левой и нижней правой точек прямоугольника элемента.

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

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

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

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

Унаследовано от IDomEventEmitter.
emptinesschange
Изменение признака пустоты макета. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • oldEmptiness - старое значение признака;
  • newEmptiness - новое значение признака.

Унаследовано от ILayout.
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.
parentelementchange
Изменение родительского элемента. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • oldParentElement - старый родительский элемент;
  • newParentElement - новый родительский элемент.

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

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

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

Методы

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

Деструктор. Вызывается при завершении работы с макетом.

Унаследован от ILayout.
getClientBoundingRect()

Number[][]

Старое название метода getClientBounds. Оставлено для обратной совместимости. Крайне не рекомендуется одновременно реализовывать оба метода.

Унаследован от ILayout.
getClientBounds()

Number[][]

Returns координаты верхней левой и нижней правой точек внешнего прямоугольника элемента по отношению к родительскому элементу. Этот метод не является обязательным; если он отсутствует, то событие clientboundschange тоже не должно присутствовать.

Унаследован от ILayout.
getData()

Object

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

Унаследован от ILayout.
getParentElement()

HTMLElement

Returns родительский html-элемент.

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

Boolean

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

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

Задает данные макета.

Унаследован от ILayout.
setParentElement(parent)

Добавляет макет в DOM-дерево.

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

Деструктор. Вызывается при завершении работы с макетом.

Унаследован от ILayout.
getClientBoundingRect()

Number[][]

Старое название метода getClientBounds. Оставлено для обратной совместимости. Крайне не рекомендуется одновременно реализовывать оба метода.

Унаследован от ILayout.
getClientBounds()

Number[][]

Returns координаты верхней левой и нижней правой точек внешнего прямоугольника элемента по отношению к родительскому элементу. Этот метод не является обязательным; если он отсутствует, то событие clientboundschange тоже не должно присутствовать.

Унаследован от ILayout.
getData()

Object

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

Унаследован от ILayout.
getParentElement()

HTMLElement

Returns родительский html-элемент.

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

Boolean

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

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

Задает данные макета.

Унаследован от ILayout.
setParentElement(parent)

Добавляет макет в DOM-дерево.

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