Documentation
Reference
2.1.50 (current version)
collection
interactivityModel
Interfaces

geometryEditor.Circle

Extends IGeometryEditor.

The "Circle" geometry editor.

Constructor | Fields | Events | Methods

Constructor

geometryEditor.Circle(geometry[, options])

Parameters:

ParameterDefault valueDescription
geometry *
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: ICircleGeometry

The "Circle" geometry.

options

Type: Object

Options for the geometry editor.

options.drawingCursor "arrow"

Type: Boolean

The mouse cursor in drawing mode.

options.drawOver true

Type: Boolean

Allows to put points on top of map objects in drawing mode.

* Mandatory parameter/option.

Fields

NameTypeDescription
eventsIEventManager

Event manager.

Inherited from IEventEmitter.

geometryIGeometry

The geometry being edited.

Inherited from IGeometryEditor.

optionsIOptionManager

Options manager.

Inherited from ICustomizable.

stateIDataManager

Manager for the state of the geometry editor.

Data fields that are available via the "get" and "set" methods:

  • editing - Checks whether editing mode is enabled. Type - Boolean. Default value - false.
  • drawing - Checks whether drawing mode is enabled. Type - Boolean. Default value - false.

Events

NameDescription
optionschange

Change to the object options.

Inherited from ICustomizable.

statechange

Change to the geometry editor state. Instance of the Event class.

Inherited from IGeometryEditor.

Methods

NameReturnsDescription
startDrawing()

vow.Promise

Enables the mode for drawing a circle.

startEditing()

Enables editing mode.

Inherited from IGeometryEditor.

stopDrawing()

vow.Promise

Disables the mode for drawing a circle.

stopEditing()

Disables editing mode.

Inherited from IGeometryEditor.

Fields details

state

{IDataManager} state

Manager for the state of the geometry editor.

Data fields that are available via the "get" and "set" methods:

  • editing - Checks whether editing mode is enabled. Type - Boolean. Default value - false.
  • drawing - Checks whether drawing mode is enabled. Type - Boolean. Default value - false.

Methods details

startDrawing

{vow.Promise} startDrawing()

Enables the mode for drawing a circle.

Returns Promise object.

stopDrawing

{vow.Promise} stopDrawing()

Disables the mode for drawing a circle.

Returns Promise object.