Interface EditControllerConstructorOptions

Constructor options for EditController.

interface EditControllerConstructorOptions {
    editor?: Editor;
    finishOnSingleClick?: boolean;
    handleIconStyle?: IconStyle;
    helperStyle?: ShapeStyle;
    mouseInteractionRadius?: number;
    touchInteractionRadius?: number;
}

Properties

editor? finishOnSingleClick? handleIconStyle? helperStyle? mouseInteractionRadius? touchInteractionRadius?

Properties

Optional editor

editor?: Editor

The Editor determines how editing behaves.

The Editor.getEditHandles to create handles for editing.

Since

2022.1

Optional finishOnSingleClick

finishOnSingleClick?: boolean

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

Default

false

Optional handleIconStyle

handleIconStyle?: IconStyle

The style used to draw point handles.

See

EditHandleStyles.handleIconStyle

Optional helperStyle

helperStyle?: ShapeStyle

The style used for drawing helper shapes.

See

EditHandleStyles.helperStyle

Optional 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

Since

2022.1

Optional 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

Since

2022.1

Settings

Member Visibility

Theme

On This Page

editorfinishOnSingleClickhandleIconStylehelperStylemouseInteractionRadiustouchInteractionRadius