ILayout
Extends IDomEventEmitter.
Layout interface.
Constructor | Fields | Events | Methods
Constructor
ILayout(data)
Parameters:
Parameter |
Default value |
Description |
|
— |
Type: Object Layout data. |
* Mandatory parameter/option.
Fields
Name |
Type |
Description |
Event manager. Inherited from IDomEventEmitter. |
Events
Name |
Description |
Single left-click on the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
Calls the element's context menu. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
Double left-click on the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
Change to the empty layout indicator. Instance of the Event class. |
|
Pressing the mouse button over the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
Pointing the cursor at the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
Moving the cursor off of the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
Moving the cursor over the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
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. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
End of multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface. Inherited from IDomEventEmitter. |
|
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:
Inherited from IDomEventEmitter. |
|
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:
Inherited from IDomEventEmitter. |
|
Change to the parent element. Instance of the Event class. |
|
Change to the shape of the area spanning the layout. Instance of the Event class. |
|
Mouse wheel scrolling. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
Methods
Name |
Returns |
Description |
destroy() |
Destructor. Called when activity with the layout is finished. |
|
getData() |
Object |
Returns layout data object. |
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. |
Sets layout data. |
||
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:
Parameter |
Default value |
Description |
|
— |
Type: Object Layout data. |
* Mandatory parameter/option.
setParentElement
{} setParentElement(parent)
Adds the layout to the DOM tree.
Parameters:
Parameter |
Default value |
Description |
— |
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.
Mandatory parameter/option.