Documentation
Reference
2.1.38 (current version)
collection
interactivityModel
Interfaces

GeocodeResult

Extends IGeoObject.

Geocoding result.

See Placemark geocode geolocation control.SearchControl

Constructor | Fields | Events | Methods

Constructor

GeocodeResult()

Fields

NameTypeDescription
eventsIEventManager

Event manager.

Inherited from IDomEventEmitter.

geometryIGeometry | null

Geo object geometry.

Inherited from IGeoObject.

optionsIOptionManager

Options manager.

Inherited from ICustomizable.

propertiesIDataManager

Geo object data.

Inherited from IGeoObject.

stateIDataManager

State of the geo object.

Inherited from IGeoObject.

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. This is described in detail 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. This is described in detail 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. This is described in detail in domEvent.manager.

Inherited from IDomEventEmitter.

geometrychange

Change to the geo object geometry. Instance of the Event class. Names of fields that are available via the "Event.get" method:

  • originalEvent: IEvent - Source event of the geometry.

Inherited from IGeoObject.

mapchange

Map reference changed. Data fields:

  • oldMap - Old map.
  • newMap - New map.

Inherited from IParentOnMap.

mousedown

Pressing the mouse button over the object. When using, keep in mind that mouse events are emulated when a touch screen is used. This is described in detail 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. This is described in detail 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. This is described in detail 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. This is described in detail 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. This is described in detail 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.

optionschange

Change to the object options.

Inherited from ICustomizable.

overlaychange

Change to the geo object overlay. Instance of the Event class. Names of fields that are available via the "Event.get" method:

  • overlay: IOverlay|null - Reference to the overlay.
  • oldOverlay: IOverlay|null - Previous overlay of the geo object.

Inherited from IGeoObject.

parentchange

The parent object reference changed.

Data fields:

  • oldParent - Old parent.
  • newParent - New parent.

Inherited from IChild.

propertieschange

Change to the geo object data. Instance of the Event class. Names of fields that are available via the "Event.get" method:

  • originalEvent: IEvent - original event of the data manager.

Inherited from IGeoObject.

wheel

Mouse wheel scrolling. When using, keep in mind that mouse events are emulated when a touch screen is used. This is described in detail in domEvent.manager.

Inherited from IDomEventEmitter.

Methods

NameReturnsDescription
getAddressLine()String

Returns a string with the object's address.

getAdministrativeAreas()String[]

Returns regional areas the object belongs to (federal district, region, or other district), no more than two.

getCountry()String | null

Returns the country the toponym belongs to (if applicable).

getCountryCode()String | null

Returns the code of the country the toponym belongs to (if applicable), as a two-letter ISO 3166 code.

getLocalities()String[]

Returns the populated locality and, optionally, an area within the locality that the toponym belongs to.

getMap()Map

Returns a reference to the map.

Inherited from IParentOnMap.

getOverlay()vow.Promise

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.

getOverlaySync()IOverlay | null

The method provides synchronous access to the overlay.

Inherited from IGeoObject.

getParent()IControlParent | null

Returns a link to the parent object, or null if the parent element was not set.

Inherited from IChildOnMap.

getPremise()String | null

Returns the name of the building, if it has one (for example, the name of an airport terminal).

getPremiseNumber()String | null

Returns the building number (including the unit, complex, or other additional characteristics).

getThoroughfare()String | null

Returns the roadway (street, highway, road, and so on) that the toponym belongs to (if applicable).

setParent(parent)IChildOnMap

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 a string with the object's address.

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).