Documentation
Reference
2.1.53 (current version)
collection
interactivityModel
Interfaces

GeoObject

Extends IGeoObject.

Geo object. Can be displayed as a placemark, polyline, polygon, etc., depending on the geometry type. You can also use auxiliary classes for simplified creation of geo objects with a specific geometry type.

See Placemark Polyline Polygon Circle Rectangle

Constructor | Fields | Events | Methods

Constructor

GeoObject([feature[, options]])

Parameters:

ParameterDefault valueDescription
feature

Type: Object

Geo object description.

feature.geometry

Type: IGeometry|IGeometryJson

Geo object geometry. Can be either set directly by the object, or in the form of an object of the JSON representation of the geometry. Examples of classes and objects that can represent a geometry - geometry.Point, geometry.json.Point.

feature.properties

Type: IDataManager|Object

Geo object data. Can be set as a class instance implementing the IDataManager interface, or as a hash. When options are set to default values, the following data fields are interpreted by a geo object:

  • iconContent - Content of the geo object's icon.
  • iconCaption - Caption for the geo object's icon.
  • hintContent - Content of the geo object's popup hint.
  • balloonContent - Content of the geo object's balloon.
  • balloonContentHeader - Content of the geo object balloon title.
  • balloonContentBody - Content of the main part of the geo object's balloon.
  • balloonContentFooter - Content of the lower part of the geo object's balloon.
The balloonContent field is a shortcut for the balloonContentBody field, but if they are both set simultaneously, balloonContentBody takes priority. You can also add your own custom fields to the geo object data and use them wherever possible. For example, in the placemark layout or balloon layout.

options

Type: Object

Geo object options. Using this parameter, you can set options for the geo object itself, as well as for its parts:

options.circleOverlay "default#circle"

Type: String|Function

Key identifier from overlay.storage or the overlay class. The generator function accepts three parameters:

  • geometry: IPixelCircleGeometry - The pixel geometry itself.
  • data: Object - The overlay data.
  • options: Object - The overlay options.
And returns vow.Promise.

options.cursor "pointer"

Type: String

Type of cursor over a geo object.

options.draggable false

Type: Boolean

Checks whether the geo object can be dragged.

options.fill true

Type: Boolean

Whether the shape is filled.

options.fillColor "0066ff99"

Type: String

Fill color.

options.fillImageHref

Type: String

Background image. When this option is enabled in stretch mode, the "fillColor" value is ignored.

options.fillMethod 'stretch'

Type: String

Type of background fill. Accepts one of two values:

  • stretch - The background image stretches to fit the size of the overlay.
  • tile - The background image is repeated, without changing its size. This is similar to background-repeat in CSS. It can be used for filling a shape with a template.

options.fillOpacity 1

Type: Number

Fill transparency.

options.hasBalloon true

Type: Boolean

Checks whether the geo object has the "balloon" field.

options.hasHint true

Type: Boolean

Checks whether the geo object has the "hint" field.

options.hideIconOnBalloonOpen true

Type: Boolean

Hide the icon when opening the balloon.

options.iconCaptionMaxWidth 188

Type: Number

Maximum width of the placemark caption.

options.iconColor

Type: String

Icon color. This option is used for standard icons in browsers that support SVG.

options.iconContentLayout

Type: Function|String

Layout for icon contents. (Type: constructor for an object with the ILayout interface, or its key in the storage).

options.iconContentOffset

Type: Number[]

Pixel offset for the icon contents relative to the parent element. Used in the default#imageWithContent layout.

options.iconContentPadding

Type: Number[]

Padding for the icon contents.

options.iconContentSize

Type: Number[]

Size of contents. Used in the default#imageWithContent layout.

options.iconImageClipRect [[0, 0], [{imageWidth}, {imageHeight}]]

Type: Number[][]

A rectangular area (the upper-left and lower-right corners are specified) that will be cut from the source image file and scaled to icon size (for example, for using sprites). By default, the entire source picture is used.

options.iconImageHref

Type: String

URL of the icon's graphic file. Used only in combination with layouts (iconLayout) 'default ' #image' and 'default#imageWithContent'.

options.iconImageOffset

Type: Number[]

Pixel offset for the icon image inside the parent element.

options.iconImageShape

Type: IShape|null

The hotspot shape. If not set, the rectangular shape based on the size and offset of the icon will be calculated automatically. The coordinates of the figure geometry are counted from the anchor point. Used only in combination with layouts (iconLayout) 'default ' #image' and 'default#imageWithContent'.

options.iconImageSize

Type: Number[]

Size of the icon, in pixels.

options.iconLayout

Type: Function|String

Icon layout. (Type: constructor for an object with the ILayout interface, or its key in the storage).

options.iconMaxHeight

Type: Number

Maximum height of an icon with contents.

options.iconMaxWidth

Type: Number

Maximum width of an icon with contents.

options.iconOffset [0, 0]

Type: Number[]

Pixel offset of the upper-left corner of the icon relative to the geographic anchor point of a placemark.

options.iconShadow false

Type: Boolean

Flag for whether the icon has a shadow.

options.iconShadowImageClipRect [[0, 0], [{imageWidth}, {imageHeight}]]

Type: Number[][]

A rectangular area (the upper-left and lower-right corners are specified) that will be cut from the source image file and scaled to shadow size (for example, for using sprites). By default, the entire source picture is used.

options.iconShadowImageHref

Type: String

URL of the graphic file for the icon shadow. Used only in combination with layouts (iconShadowLayout) 'default ' #image' and 'default#imageWithContent'.

options.iconShadowImageOffset

Type: Number[]

Pixel offset for the icon shadow image inside the parent element.

options.iconShadowImageSize

Type: Number[]

Size of the icon shadow.

options.iconShadowLayout

Type: Function|String

Layout for the icon shadow. (Type: constructor for an object with the ILayout interface, or its key in the storage).

options.iconShadowOffset

Type: Number[]

The pixel offset of the icon shadow relative to its set position.

options.interactiveZIndex

Type: Boolean

Enables to automatically modify z-index of the geo object depending on its state. By default, takes the true value for geometry.Point and false for other geometries.

options.interactivityModel "default#geoObject"

Type: String

Interactivity model. Available keys and their values are listed in the description of interactivityModel.storage.

options.lineStringOverlay "default#polyline"

Type: String|Function

Key identifier from overlay.storage or the overlay class. The generator function accepts three parameters:

And returns vow.Promise.

options.opacity 1

Type: Number

Transparency.

options.openBalloonOnClick true

Type: Boolean

Checks whether to show the balloon when the geo object is clicked on.

options.openEmptyBalloon false

Type: Boolean

Checks whether to show an empty balloon when the geo object is clicked on.

options.openEmptyHint false

Type: Boolean

Checks whether to show an empty hint when the mouse pointer hovers over the geo object.

options.openHintOnHover true

Type: Boolean

Checks whether to show a hint when the mouse pointer hovers over the geo object.

options.outline true

Type: Boolean

Whether the shape has an outline.

options.pane

Type: String

The key of the pane where the geo object overlay is placed. The default value is defined by the current overlay.

options.pointOverlay "default#placemark"

Type: String|Function

Key identifier from overlay.storage or the overlay class. The generator function accepts three parameters:

And returns vow.Promise.

options.polygonOverlay "default#polygon"

Type: String|Function

Key identifier from overlay.storage or the overlay class. The generator function accepts three parameters:

And returns vow.Promise.

options.preset

Type: String

Key for the geo object's preset options. The list of keys is provided in the description of option.presetStorage.

options.rectangleOverlay "default#rectangle"

Type: String|Function

Key identifier from overlay.storage or the overlay class. The generator function accepts three parameters:

And returns vow.Promise.

options.setMapCursorInDragging false

Type: Boolean

true – when dragging an object, set the cursor to "grabbing" for both the object and the map; false – only use the "grabbing" cursor on the object.

options.strokeColor "0066ffff"

Type: String[][]|String[]

Color of the line or outline. You can set multiple values for a multistroke outline.

options.strokeOpacity 1

Type: Number[][]|Number[]

Transparency of the line or outline. You can set multiple values for a multistroke outline.

options.strokeStyle

Type: String[][][]|Object[][]|String[]|Object[]

Style of the line or outline. You can set multiple values for a multistroke outline.

options.strokeWidth 1

Type: Number[][]|Number[]

Thickness of the line or outline. You can set multiple values for a multistroke outline.

options.syncOverlayInit false

Type: Boolean

Enables synchronously adding an overlay to the map. By default, overlays are added to the map asynchronously to prevent the browser from hanging when adding a large number of geo objects. However, adding asynchronously does not allow accessing the overlay immediately after adding a geo object to the map.

options.useMapMarginInDragging true

Type: Boolean

When an object is dragged to the edge of the map, the map center changes automatically. Whether to use map margins when automatically shifting the map center with map.margin.Manager.

options.visible true

Type: Boolean

Checks geo object visibility.

options.zIndex

Type: Number

The z-index of a geo object in its normal state. Lowest priority.

options.zIndexActive

Type: Number

The z-index of a geo object with an open balloon. Highest priority.

options.zIndexDrag

Type: Number

The z-index of a geo object that is being dragged.

options.zIndexHover

Type: Number

The z-index of a geo object when the mouse pointer is hovering over it.

Examples:

1.

   var myGeoObject = new ymaps.GeoObject({
        // Defining a "Polyline" type of geometry.
        geometry: {
            type: "LineString",
            coordinates: [
                [55.75, 37.61], [52.51, 13.38]
            ]
        },
        // Defining the geo object data.
        properties: {
            hintContent: "Moscow-Berlin"
        }
    }, {
        // Enabling the display mode as geodesic curves.
        geodesic: true,
        // Setting the width to 5 pixels.
        strokeWidth: 5,
        // Setting the line color.
        strokeColor: "#F008"
  *     });
// Adding the geo object to the map.
geoMap.geoObjects.add(myGeoObject);

2.

   var myGeoObject = new ymaps.GeoObject({
        // Defining a "Point" geometry.
        geometry: {
            type: "Point",
            coordinates: [55.75, 37.61]
        },
        // Defining the geo object data.
        properties: {
            hintContent: "Moscow",
            balloonContentHeader: "Moscow",
            balloonContentBody: "Capital of Russia",
            population: 11848762
        }
    }, {
        // Setting the preset for a placemark with a dot and no content.
        preset: "islands#redDotIcon",
        // Enabling dragging.
        draggable: true,
        // Overriding the layout for the content in the lower part of the balloon.
        balloonContentFooterLayout: ymaps.templateLayoutFactory.createClass(
            'population: {{ properties.population }}, coordinates: {{ geometry.coordinates }}'
        ),
        // Disabling the delay for closing the popup hint.
        hintCloseTimeout: null
  *     });
// Adding the geo object to the map.

geoMap.geoObjects.add(myGeoObject);

Fields

NameTypeDescription
balloongeoObject.Balloon

Balloon for a geo object.

editorIGeometryEditor

Editor for the geo object geometry.

eventsevent.Manager

Event manager.

geometryIGeometry|null

Geo object geometry.

hintgeoObject.Hint

Geo object hint.

optionsoption.Manager

Geo object options manager.

propertiesdata.Manager

Geo object data manager.

statedata.Manager

State of the geo object. Defined by the following fields:

  • active: Boolean - Indicates that a balloon is open on the geo object.
  • hover: Boolean - Indicates that the mouse is currently pointed at the geo object.
  • drag: Boolean - Indicates that the geo object is being dragged

Events

NameDescription
balloonclose

Closing the balloon. Instance of the Event class.

balloonopen

Opening a balloon on a geo object. Instance of the Event class.

beforedrag

Event preceding the "drag" event. Instance of the Event class. Names of fields that are available via the Event#get method:

  • position - Coordinates relative to the document. Array in the format [pageX, pageY].
  • pixelOffset - Array of two numbers that describe the pixel offset at this step.
  • domEvent - Source DOM event (as a DomEvent object), if there is one.
Names of methods that are accessible via Event#callMethod:
  • setPixelOffset - This method is for correcting the value of the pixel offset that will actually be applied. It takes an argument with the new pixel offset in the form of an array of two numbers.
If the Event#preventDefault method is called for this event, a subsequent drag event will be canceled.

beforedragstart

Event preceding the "dragstart" event. Instance of the Event class. Names of fields that are available via the Event#get method:

  • position - Coordinates relative to the document. Array in the format [pageX, pageY].
  • domEvent - Source DOM event (as a DomEvent object), if there is one.
If the Event#preventDefault method is called for this event, any subsequent dragging, as well as the "dragstart" event, will be canceled.

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.

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.

drag

Dragging a geo object. Instance of the Event class. Names of fields that are available via the Event#get method:

  • position - Coordinates relative to the document. Array in the format [pageX, pageY].
  • pixelOffset - Array of two numbers that describe the pixel offset at this step.
  • domEvent - Source DOM event (as a DomEvent object), if there is one.

dragend

End of geo object dragging. Instance of the Event class. Names of fields that are available via the Event#get method:

  • position - Coordinates relative to the document. Array in the format [pageX, pageY].
  • domEvent - Source DOM event (as a DomEvent object), if there is one.

dragstart

Start of geo object dragging. Instance of the Event class. Names of fields that are available via the Event#get method:

  • position - Coordinates relative to the document. Array in the format [pageX, pageY].
  • domEvent - Source DOM event (as a DomEvent object), if there is one.

editorstatechange

Change in the state of the editor for the geo object's geometry. Instance of the Event class. Names of fields that are available via the Event#get method:

  • originalEvent - Original event of the geometry editor.

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 - Original event of the geometry.

Inherited from IGeoObject.

hintclose

Closing the hint. Instance of the Event class.

hintopen

Opening a hint on a geo object. Instance of the Event class.

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

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. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

Methods

NameReturnsDescription
getMap()

Map

Returns 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 link to the parent object, or null if the parent element was not set.

Inherited from IChildOnMap.

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.

Fields details

balloon

Balloon for a geo object.

editor

Editor for the geo object geometry.

Example:

// Start editing the geo object geometry.
geoObject.editor.startEditing();
// ...
// Finish editing.
geoObject.editor.stopEditing();

events

{event.Manager} events

Event manager.

geometry

{IGeometry|null} geometry

Geo object geometry.

Example:

// When changing the coordinates of a geo object's geometry, we set the map borders
// so that the geo object is covered entirely.
myMap.geoObjects.add(myGeoObject);
myGeoObject.geometry.events.add("change", function () {
    myMap.setBounds(myGeoObject.geometry.getBounds());
});

hint

Geo object hint.

options

{option.Manager} options

Geo object options manager.

properties

{data.Manager} properties

Geo object data manager.

Example:

// When changing data, output a custom ID
// if the object's "synchronized" field is set to false.
myGeoObject.properties.events.add("change", function () {
    if (!myGeoObject.properties.get("synchronized")) {
        console.log(myGeoObject.properties.get("myID"));
    }
});

state

{data.Manager} state

State of the geo object. Defined by the following fields:

  • active: Boolean - Indicates that a balloon is open on the geo object.
  • hover: Boolean - Indicates that the mouse is currently pointed at the geo object.
  • drag: Boolean - Indicates that the geo object is being dragged

Events details

balloonclose

Closing the balloon. Instance of the Event class.

balloonopen

Opening a balloon on a geo object. Instance of the Event class.

beforedrag

Event preceding the "drag" event. Instance of the Event class. Names of fields that are available via the Event#get method:

  • position - Coordinates relative to the document. Array in the format [pageX, pageY].
  • pixelOffset - Array of two numbers that describe the pixel offset at this step.
  • domEvent - Source DOM event (as a DomEvent object), if there is one.
Names of methods that are accessible via Event#callMethod:
  • setPixelOffset - This method is for correcting the value of the pixel offset that will actually be applied. It takes an argument with the new pixel offset in the form of an array of two numbers.
If the Event#preventDefault method is called for this event, a subsequent drag event will be canceled.

Example:

// Allowing dragging the geo object only along the horizontal axis.
geoObject.events.add("beforedrag", function (event) {
    var originalOffset = event.get("pixelOffset");
    event.callMethod("setPixelOffset", [originalOffset[0], 0]);
});

beforedragstart

Event preceding the "dragstart" event. Instance of the Event class. Names of fields that are available via the Event#get method:

  • position - Coordinates relative to the document. Array in the format [pageX, pageY].
  • domEvent - Source DOM event (as a DomEvent object), if there is one.
If the Event#preventDefault method is called for this event, any subsequent dragging, as well as the "dragstart" event, will be canceled.

drag

Dragging a geo object. Instance of the Event class. Names of fields that are available via the Event#get method:

  • position - Coordinates relative to the document. Array in the format [pageX, pageY].
  • pixelOffset - Array of two numbers that describe the pixel offset at this step.
  • domEvent - Source DOM event (as a DomEvent object), if there is one.

dragend

End of geo object dragging. Instance of the Event class. Names of fields that are available via the Event#get method:

  • position - Coordinates relative to the document. Array in the format [pageX, pageY].
  • domEvent - Source DOM event (as a DomEvent object), if there is one.

dragstart

Start of geo object dragging. Instance of the Event class. Names of fields that are available via the Event#get method:

  • position - Coordinates relative to the document. Array in the format [pageX, pageY].
  • domEvent - Source DOM event (as a DomEvent object), if there is one.

editorstatechange

Change in the state of the editor for the geo object's geometry. Instance of the Event class. Names of fields that are available via the Event#get method:

  • originalEvent - Original event of the geometry editor.

hintclose

Closing the hint. Instance of the Event class.

hintopen

Opening a hint on a geo object. Instance of the Event class.