ISearchControlLayout
Extends IExpandableControlLayout.
Interface for the layout of the "Search on map" control.
Constructor | Fields | Events | Methods
Constructor
ISearchControlLayout()
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. |
|
Event that initiates collapsing an object. Inherited from IExpandableControlLayout. |
|
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. Inherited from ILayout. |
|
Event that initiates expanding an object. Inherited from IExpandableControlLayout. |
|
The event that triggers pulling up additional search results. 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. Inherited from ILayout. |
|
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:
|
|
Event that initiates searching for objects. Instance of the Event class. Names of fields that are available via the Event.get method:
|
|
Change to the shape of the area spanning the layout. Instance of the Event class. Inherited from ILayout. |
|
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. Inherited from ILayout. |
|
getData() |
Object |
Returns layout data object. Inherited from ILayout. |
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. |
Sets layout data. Inherited from ILayout. |
||
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.