Documentation
Reference
2.1.50 (current version)
collection
interactivityModel
Interfaces
2.1.52 (release candidate)
collection
interactivityModel
Interfaces

ISearchControlLayout

Extends IExpandableControlLayout.

Interface for the layout of the "Search on map" control.

Constructor | Fields | Events | Methods

Constructor

ISearchControlLayout()

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.

collapse

Event that initiates collapsing an object.

Inherited from IExpandableControlLayout.

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.

Inherited from ILayout.

expand

Event that initiates expanding an object.

Inherited from IExpandableControlLayout.

loadmore

The event that triggers pulling up additional search results. 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.

Inherited from ILayout.

resultselect

Event that initiates showing the search results on the map. Instance of the Event class. Names of fields that are available via the Event.get method:

  • index - Number of the object in the server response to show on the map.

search

Event that initiates searching for objects. Instance of the Event class. Names of fields that are available via the Event.get method:

  • request - String containing the request.

shapechange

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

Inherited from ILayout.

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.

Inherited from ILayout.

getData()

Object

Returns layout data object.

Inherited from ILayout.

getParentElement()

HTMLElement

Returns parent HTML element.

Inherited from ILayout.

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.

Inherited from ILayout.

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.

Inherited from ILayout.

setData(data)

Sets layout data.

Inherited from ILayout.

setParentElement(parent)

Adds the layout to the DOM tree.

Inherited from ILayout.

Events details

loadmore

The event that triggers pulling up additional search results. Instance of the Event class.

resultselect

Event that initiates showing the search results on the map. Instance of the Event class. Names of fields that are available via the Event.get method:

  • index - Number of the object in the server response to show on the map.

search

Event that initiates searching for objects. Instance of the Event class. Names of fields that are available via the Event.get method:

  • request - String containing the request.