Options
All
  • Public
  • Public/Protected
  • All
Menu

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

see

EditController.getSettings

see

CreateController.getSettings

since

2022.1

Hierarchy

  • EditSettings

Overview

Properties

finishOnSingleClick

finishOnSingleClick: boolean

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

see

EditControllerConstructorOptions.finishOnSingleClick

see

CreateControllerConstructorOptions.finishOnSingleClick

freehand

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.

see

CreateControllerConstructorOptions.freehand

see

PointListCreateHandleConstructorOptions.freehand

maximumPointCount

maximumPointCount: number

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

see

EditController.getMaximumPointCount

see

EditController.setPointCount

see

CreateController.getMaximumPointCount

see

CreateController.setPointCount

see

PointListCreateHandleConstructorOptions.maximumPointCount

minimumPointCount

minimumPointCount: number

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

see

EditController.getMinimumPointCount

see

EditController.setPointCount

see

CreateController.getMinimumPointCount

see

CreateController.setPointCount

see

PointListCreateHandleConstructorOptions.minimumPointCount

mouseInteractionRadius

mouseInteractionRadius: number

The mouse interaction radius to use, in pixels.

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

see

EditControllerConstructorOptions.mouseInteractionRadius

see

CreateControllerConstructorOptions.mouseInteractionRadius

see

interactsWithControllerShape

styles

Styles used to draw editing handles and helper shapes.

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

touchInteractionRadius

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.

see

EditControllerConstructorOptions.touchInteractionRadius

see

CreateControllerConstructorOptions.touchInteractionRadius

see

interactsWithControllerShape

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method