Settings configured on a CreateController. These settings are passed from the controller, to the handles, through EditContext.settings

Hierarchy

  • EditSettings

Properties

finishOnSingleClick: boolean

Indicates whether to finish editing on a single-click event, or a double click event (the default).

freehand: boolean

Indicates whether to allow drawing shapes in "freehand" mode. When this is enabled, the user can click / tap near the last created point and drag to draw a shape. Multiple points will be inserted while the mouse is being dragged.

When this is disabled, the user can only create (single) points by clicking / tapping the map.

maximumPointCount: number

The maximum number of points that should be allowed during editing. If no maximum is defined, this is -1.

minimumPointCount: number

The minimum number of points that should be allowed during editing. If no minimum is defined, this is 0.

mouseInteractionRadius: number

The mouse interaction radius to use, in pixels.

This is the radius used for mouse events, to determine interaction with handles.

Styles used to draw editing handles and helper shapes.

You can override CreateController.getSettings to add more styles, which can be used in custom EditHandle implementations.

touchInteractionRadius: number

The touch interaction radius to use, in pixels.

This is the radius used for touch events, to determine interaction with handles. Typically, this is larger than the mouseInteractionRadius.