Documentation
Reference
2.1.55 (current version)
collection
interactivityModel
Interfaces

ILayout

Extends IDomEventEmitter.

Layout interface.

Constructor | Fields | Events | Methods

Constructor

ILayout(data)

Parameters:

ParameterDefault valueDescription
data *
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Object

Layout data.

* Mandatory parameter/option.

Fields

NameTypeDescription
eventsIEventManager

Event manager.

Inherited from IDomEventEmitter.

Events

NameDescription
click

Single left-click on the object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

contextmenu

Calls the element's context menu. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

dblclick

Double left-click on the object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

emptinesschange

Change to the empty layout indicator. Instance of the Event class.

mousedown

Pressing the mouse button over the object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

mouseenter

Pointing the cursor at the object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

mouseleave

Moving the cursor off of the object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

mousemove

Moving the cursor over the object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

mouseup

Letting go of the mouse button over an object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

multitouchend

End of multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface.

Inherited from IDomEventEmitter.

multitouchmove

Repeating event during multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface with information about touches. Defines the touches property, which contains a list of touches. Every touch is described by an object that contains the following fields:

  • clientX - X coordinate of the touch relative to the viewable area of the browser.
  • clientY - Y coordinate of the touch relative to the viewable area of the browser.
  • pageX - X coordinate of the touch relative to the beginning of the document.
  • pageY - Y coordinate of the touch relative to the beginning of the document.

Inherited from IDomEventEmitter.

multitouchstart

Start of multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface with information about touches. Defines the touches property, which contains a list of touches. Every touch is described by an object that contains the following fields:

  • clientX - X coordinate of the touch relative to the viewable area of the browser.
  • clientY - Y coordinate of the touch relative to the viewable area of the browser.
  • pageX - X coordinate of the touch relative to the beginning of the document.
  • pageY - Y coordinate of the touch relative to the beginning of the document.

Inherited from IDomEventEmitter.

parentelementchange

Change to the parent element. Instance of the Event class.

shapechange

Change to the shape of the area spanning the layout. Instance of the Event class.

wheel

Mouse wheel scrolling. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

Methods

NameReturnsDescription
destroy()

Destructor. Called when activity with the layout is finished.

getData()

Object

Returns layout data object.

getParentElement()

HTMLElement

Returns parent HTML element.

getShape()

IShape|null

Returns a shape that defines the area spanning the layout, or null if it is not possible to plot this shape. Coordinates of the shape's geometry should be calculated from the anchor point of the parent layout element.

isEmpty()

Boolean

Returns true if the layout is empty, i.e. it does not have any content. This indicator is used for hiding empty objects such as hints, balloons, and others.

setData(data)

Sets layout data.

setParentElement(parent)

Adds the layout to the DOM tree.

Events details

emptinesschange

Change to the empty layout indicator. Instance of the Event class.

parentelementchange

Change to the parent element. Instance of the Event class.

shapechange

Change to the shape of the area spanning the layout. Instance of the Event class.

Methods details

destroy

{} destroy()

Destructor. Called when activity with the layout is finished.

getData

{Object} getData()

Returns layout data object.

getParentElement

{HTMLElement} getParentElement()

Returns parent HTML element.

getShape

{IShape|null} getShape()

Returns a shape that defines the area spanning the layout, or null if it is not possible to plot this shape. Coordinates of the shape's geometry should be calculated from the anchor point of the parent layout element.

isEmpty

{Boolean} isEmpty()

Returns true if the layout is empty, i.e. it does not have any content. This indicator is used for hiding empty objects such as hints, balloons, and others.

setData

{} setData(data)

Sets layout data.

Parameters:

ParameterDefault valueDescription
data*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Object

Layout data.

* Mandatory parameter/option.

setParentElement

{} setParentElement(parent)

Adds the layout to the DOM tree.

Parameters:

ParameterDefault valueDescription
parent*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: HTMLElement|null

Parent HTML element. The parent element must be added to the DOM tree. If null is passed, the element is removed from the DOM tree.

* Mandatory parameter/option.