ILayout

Расширяет IDomEventEmitter.

Интерфейс макета.

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

Конструктор

ILayout(data)

Параметры:

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

Тип: Object

Данные макета.

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

Поля

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

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

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

События

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

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

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

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

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

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

dblclick

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

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

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

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

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

Методы

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

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

getClientBoundingRect()

Number[][]

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

getClientBounds()

Number[][]

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

getData()

Object

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

getParentElement()

HTMLElement

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

isEmpty()

Boolean

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

setData(data)

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

setParentElement(parent)

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

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

clientboundschange

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

emptinesschange

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

parentelementchange

Изменение родительского элемента. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • oldParentElement - старый родительский элемент;
  • newParentElement - новый родительский элемент.

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

destroy

{} destroy()

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

getClientBoundingRect

{Number[][]} getClientBoundingRect()

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

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

getClientBounds

{Number[][]} getClientBounds()

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

getData

{Object} getData()

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

getParentElement

{HTMLElement} getParentElement()

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

isEmpty

{Boolean} isEmpty()

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

setData

{} setData(data)

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

Параметры:

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

Тип: Object

Данные макета.

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

setParentElement

{} setParentElement(parent)

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

Параметры:

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

Тип: HTMLElement|null

Родительский html-элемент. Родительский элемент должен быть добавлен в DOM-дерево. Если передан null, то элемент удаляется из DOM-дерева.

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