Documentation
Reference
2.1.53 (current version)
collection
interactivityModel
Interfaces

Polygon

Extends GeoObject.

Polygon. A geo object with the geometry geometry.Polygon.

See GeoObject geometry.Polygon

Constructor | Fields | Events | Methods

Constructor

Polygon(geometry[, properties[, options]])

Creates a polygon instance.

Parameters:

ParameterDefault valueDescription
geometry *
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Number[][][]|Object|IPolygonGeometry

Coordinates of polyline vertexes that define the outer and inner boundaries of the polygon, a hash object with geometry parameters, or a reference to the geometry object. The inner boundary can be omitted.

properties

Type: Object|IDataManager

Polygon 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:

  • hintContent - Content of the polygon's popup hint.
  • balloonContent - Content of the polygon's balloon.
  • balloonContentHeader - Content of the polygon balloon title.
  • balloonContentBody - Content of the main part of the polygon's balloon.
  • balloonContentFooter - Content of the lower part of the polygon'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 polygon data and use them wherever possible. For example, in the polygon balloon layout.

options

Type: Object

Polygon options. Using this parameter, you can set options for the polygon itself, as well as for its parts:

options.cursor "pointer"

Type: String

Type of cursor over a polygon.

options.draggable false

Type: Boolean

Checks whether the polygon 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 if the polygon has the "balloon" field.

options.hasHint true

Type: Boolean

Checks if the polygon has the "hint" field.

options.interactiveZIndex false

Type: Boolean

Enables to automatically modify z-index of the polygon depending on its state.

options.interactivityModel "default#geoObject"

Type: String

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

options.opacity 1

Type: Number

Transparency.

options.openBalloonOnClick true

Type: Boolean

Checks whether to show the balloon when the polygon is clicked on.

options.openEmptyBalloon false

Type: Boolean

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

options.openEmptyHint false

Type: Boolean

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

options.openHintOnHover true

Type: Boolean

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

options.outline true

Type: Boolean

Whether the shape has an outline.

options.pane "areas"

Type: String

The key of the pane where the polygon overlay is placed.

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.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 polygon 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 the visibility of the polygon.

options.zIndex

Type: Number

The z-index of the polygon in the normal state. Lowest priority.

options.zIndexActive

Type: Number

The z-index of the polygon with an opened balloon. Highest priority.

options.zIndexDrag

Type: Number

The z-index of the polygon while dragging.

options.zIndexHover

Type: Number

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

* Mandatory parameter/option.

Example:

var polygon = new ymaps.Polygon([
    // Coordinates of the outer contour.
    [[-80, 60], [-90, 50], [-60, 40], [-80, 60]],
    // Coordinates of the inner contour.
    [[-90, 80], [-90, 30], [-20, 40], [-90, 80]]
], {
    hintContent: "Polygon"
}, {
    fillColor: '#6699ff',
    // Making the polygon transparent for map events.
    interactivityModel: 'default#transparent',
    strokeWidth: 8,
    opacity: 0.5
});
myMap.geoObjects.add(polygon);
myMap.setBounds(polygon.geometry.getBounds());

Fields

NameTypeDescription
balloongeoObject.Balloon

Balloon for a geo object.

Inherited from GeoObject.

editorgeometryEditor.Polygon

The "Polygon" geometry editor.

eventsevent.Manager

Event manager.

Inherited from GeoObject.

geometrygeometry.Polygon

The "Polygon" type of geometry.

hintgeoObject.Hint

Geo object hint.

Inherited from GeoObject.

optionsoption.Manager

Geo object options manager.

Inherited from GeoObject.

propertiesdata.Manager

Geo object data manager.

Inherited from GeoObject.

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

Inherited from GeoObject.

Events

NameDescription
balloonclose

Closing the balloon. Instance of the Event class.

Inherited from GeoObject.

balloonopen

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

Inherited from GeoObject.

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.

Inherited from GeoObject.

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.

Inherited from GeoObject.

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.

Inherited from GeoObject.

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.

Inherited from GeoObject.

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.

Inherited from GeoObject.

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.

Inherited from GeoObject.

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.

Inherited from GeoObject.

hintopen

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

Inherited from GeoObject.

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

editor

The "Polygon" geometry editor.

geometry

{geometry.Polygon} geometry

The "Polygon" type of geometry.