geoObject.addon.editor

Note

The constructor of the geoObject.addon.editor class is hidden, as this class is not intended for autonomous initialization.

Static object.

The module that makes it possible to use the editor for a geo object. Adds the GeoObject#editor field to GeoObject. When enabling package.full (the standard set of modules), it is available by default. If GeoObject is enabled separately, this module must be explicitly specified in the loader. If geoObject.addon.editor is enabled separately after creating GeoObject, the GeoObject#editor field won't be added. Then you will need to use the geoObject.addon.editor#get method for the editor.

Methods

Methods

Name

Returns

Description

create(geoObject)

A function that creates the "editor" field for the passed geo object.

get(geoObject)

IGeometryEditor

Returns geo object editor.

Methods details

create

{} create(geoObject)

A function that creates the "editor" field for the passed geo object.

Parameters:

Parameter

Default value

Description

geoObject*

Type: IGeoObject

Geo object.

* Mandatory parameter/option.

get

{IGeometryEditor} get(geoObject)

Returns geo object editor.

Parameters:

Parameter

Default value

Description

geoObject*

Type: IGeoObject

Geo object

* Mandatory parameter/option.

Example:

ymaps.geoObject.addon.editor.get(geoObject)