GeocodeResult
Extends IGeoObject.
Geocoding result.
See Placemarkgeocodegeolocationcontrol.SearchControl
Constructor | Fields | Events | Methods
Constructor
GeocodeResult()
Fields
Name |
Type |
Description |
Event manager. Inherited from IDomEventEmitter. |
||
IGeometry|null |
Geo object geometry. Inherited from IGeoObject. |
|
Options manager. Inherited from ICustomizable. |
||
Geo object data. Inherited from IGeoObject. |
||
State of the geo object. Inherited from IGeoObject. |
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 geo object geometry. Instance of the Event class. Names of fields that are available via the Event.get method:
Inherited from IGeoObject. |
|
Map reference changed. Data fields:
Inherited from IParentOnMap. |
|
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 object options. Inherited from ICustomizable. |
|
Change to the geo object overlay. Instance of the Event class. Names of fields that are available via the Event.get method:
Inherited from IGeoObject. |
|
The parent object reference changed. Data fields:
Inherited from IChild. |
|
Change to the geo object data. Instance of the Event class. Names of fields that are available via the Event.get method:
Inherited from IGeoObject. |
|
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 |
String |
Returns string with the address of the object. |
|
String[] |
Returns regional areas the object belongs to (federal district, region, or other district); no more than two. |
|
String|null |
Returns the country the toponym belongs to (if applicable). |
|
String|null |
Returns the code of the country the toponym belongs to (if applicable), as a two-letter ISO 3166 code. |
|
String[] |
Returns the populated locality and, optionally, an area within the locality that the toponym belongs to. |
|
getMap() |
Returns reference to the map. Inherited from IParentOnMap. |
|
Returns the promise object, which is confirmed by the overlay object at the time it is actually created, or is rejected with an appropriate error message. Inherited from IGeoObject. |
||
IOverlay|null |
The method provides synchronous access to the overlay. Inherited from IGeoObject. |
|
IParentOnMap|null |
Returns link to the parent object, or null if the parent element was not set. Inherited from IChildOnMap. |
|
String|null |
Returns the name of the building, if it has one (for example, the name of an airport terminal). |
|
String|null |
Returns the building number (including the unit, complex, or other additional characteristics). |
|
String|null |
Returns the roadway (street, highway, road, and so on) that the toponym belongs to (if applicable). |
|
Sets the parent object. If the null value is passed, the manager element will only be deleted from the current parent object. Inherited from IChildOnMap. |
Methods details
getAddressLine
{String} getAddressLine()
Returns string with the address of the object.
getAdministrativeAreas
{String[]} getAdministrativeAreas()
Returns regional areas the object belongs to (federal district, region, or other district); no more than two.
getCountry
{String|null} getCountry()
Returns the country the toponym belongs to (if applicable).
getCountryCode
{String|null} getCountryCode()
Returns the code of the country the toponym belongs to (if applicable), as a two-letter ISO 3166 code.
getLocalities
{String[]} getLocalities()
Returns the populated locality and, optionally, an area within the locality that the toponym belongs to.
getPremise
{String|null} getPremise()
Returns the name of the building, if it has one (for example, the name of an airport terminal).
getPremiseNumber
{String|null} getPremiseNumber()
Returns the building number (including the unit, complex, or other additional characteristics).
getThoroughfare
{String|null} getThoroughfare()
Returns the roadway (street, highway, road, and so on) that the toponym belongs to (if applicable).