geometryEditor.Point
Extends IGeometryEditor.
The "Point" geometry editor.
Constructor | Fields | Events | Methods
Constructor
Parameters:
| Parameter | Default value | Description |
|---|---|---|
| geometry * | — | Type: IPointGeometry The "Point" geometry. |
| options | — | Type: Object Options for the geometry editor. |
| options.dblClickHandler | — | Type: Function Handler for double-clicking a vertex. Accepts a reference to a model of the vertex being edited. By default, the handler is defined by the function that removes the corresponding vertex. |
| 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. |
| Parameter | Default value | Description |
|---|---|---|
| geometry * | — | Type: IPointGeometry The "Point" geometry. |
| options | — | Type: Object Options for the geometry editor. |
| options.dblClickHandler | — | Type: Function Handler for double-clicking a vertex. Accepts a reference to a model of the vertex being edited. By default, the handler is defined by the function that removes the corresponding vertex. |
| 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
| Name | Type | Description |
|---|---|---|
| events | IEventManager | Event manager. Inherited from IEventEmitter. |
| geometry | IGeometry | The geometry being edited. Inherited from IGeometryEditor. |
| options | IOptionManager | Options manager. Inherited from ICustomizable. |
| state | IDataManager | Manager for the state of the geometry editor. Data fields that are available via the "get" and "set" methods:
|
| Name | Type | Description |
|---|---|---|
| events | IEventManager | Event manager. Inherited from IEventEmitter. |
| geometry | IGeometry | The geometry being edited. Inherited from IGeometryEditor. |
| options | IOptionManager | Options manager. Inherited from ICustomizable. |
| state | IDataManager | Manager for the state of the geometry editor. Data fields that are available via the "get" and "set" methods:
|
Events
| Name | Description |
|---|---|
| optionschange | Change to the object options. Inherited from ICustomizable. |
| statechange | Change to the geometry editor state. Instance of the Event class. Inherited from IGeometryEditor. |
| Name | Description |
|---|---|
| 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
| Name | Returns | Description |
|---|---|---|
| startDrawing() | Enables the mode for drawing points. | |
| startEditing() | Enables editing mode. Inherited from IGeometryEditor. | |
| stopDrawing() | Disables the mode for drawing points. | |
| stopEditing() | Disables editing mode. Inherited from IGeometryEditor. |
| Name | Returns | Description |
|---|---|---|
| startDrawing() | Enables the mode for drawing points. | |
| startEditing() | Enables editing mode. Inherited from IGeometryEditor. | |
| stopDrawing() | Disables the mode for drawing points. | |
| stopEditing() | Disables editing mode. Inherited from IGeometryEditor. |
Fields details
state
{IDataManager} stateManager 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 points.
Returns Promise object.
stopDrawing
{vow.Promise} stopDrawing()Disables the mode for drawing points.
Returns Promise object.