Class BoundsEditor

An editor that allows editing and creation of features with a bounds shape.

Handles

The bounds editor defines the following edit handles:

BoundsEditor handles

BoundsEditor handles

Bounds resize handles (A): by dragging one of these handles, the user moves the corresponding corner of the bounds.
Shape translate handle: translates (moves) the entire Bounds shape. The light blue area in the image above indicates where the shape translate handle is active. This includes the red stroke.

Creation

The BoundsCreateHandle.

Since

2022.1

Hierarchy

Editor
- BoundsEditor

Index

Constructors

Methods

canEdit createBoundsResizeHandle createTranslateHandle flipResizeHandles getCreateHandle getEditHandles

Constructors

constructor

new BoundsEditor(): BoundsEditor
Creates a new BoundsEditor.

Returns BoundsEditor
Overrides Editor.constructor

Methods

canEdit

canEdit(context): boolean
Returns true if context.shape has a BOUNDS shape type.
Parameters
- context: EditContext
Returns boolean
Overrides Editor.canEdit

createBoundsResizeHandle

createBoundsResizeHandle(context, identifier): null | EditHandle
Creates an edit handle that allows the user to change the bounds by dragging a corner. This method is called 4 times by corner.
Parameters
- context: EditContext
  The edit context
- identifier: BoundsResizeHandleIdentifier
  The identifier for the corner
Returns null | EditHandle

createTranslateHandle

createTranslateHandle(context): null | EditHandle
Creates the shape translation handle.

This is a handle that allows translation (moving) of an entire shape / feature.
Parameters
- context: EditContext
  The context to retrieve the shape translate handle for
Returns null | EditHandle
Inherited from Editor.createTranslateHandle

flipResizeHandles

flipResizeHandles(flipHorizontal, flipVertical): void
Called whenever one of the flipped.

This notifies all handles that they should update their BoundsResizeHandleIdentifier.
Parameters
- flipHorizontal: boolean
  Indicates that a horizontal flip has occurred
- flipVertical: boolean
  Indicates that a vertical flip has occurred
Returns void
See
BoundsResizeHandle.flip

getCreateHandle

getCreateHandle(context): null | EditHandle
Creates a handle that allows the user to create a bounds shape.
Parameters
- context: EditContext
  The edit context
Returns null | EditHandle
Overrides Editor.getCreateHandle

getEditHandles

getEditHandles(context): EditHandle[]
Returns a set of handles for editing a Bounds.

By default, this delegates to the following methods:
- corner
- createTranslateHandle
Parameters
- context: EditContext
Returns EditHandle[]
Overrides Editor.getEditHandles