geometryEditor.Circle
Extends IGeometryEditor.
The "Circle" geometry editor.
Constructor | Fields | Events | Methods
Constructor
geometryEditor.Circle(geometry[, options])
Parameters:
Parameter |
Default value |
Description |
— |
Type: ICircleGeometry The "Circle" geometry. |
|
— |
Type: Object Options for the geometry editor. |
|
"arrow" |
Type: Boolean The mouse cursor in drawing mode. |
|
true |
Type: Boolean Allows to put points on top of map objects in drawing mode. |
* Mandatory parameter/option.
Fields
Name |
Type |
Description |
Event manager. Inherited from IEventEmitter. |
||
The geometry being edited. Inherited from IGeometryEditor. |
||
Options manager. Inherited from ICustomizable. |
||
Manager for the state of the geometry editor. Data fields that are available via the "get" and "set" methods:
|
Events
Name |
Description |
Change to the object options. Inherited from ICustomizable. |
|
Change to the geometry editor state. Instance of the Event class. Inherited from IGeometryEditor. |
Methods
Name |
Returns |
Description |
Enables the mode for drawing a circle. |
||
Enables editing mode. Inherited from IGeometryEditor. |
||
Disables the mode for drawing a circle. |
||
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.
Mandatory parameter/option.