HandleInputMode

An IInputMode implementation that can handle a collection of IHandles.

Inheritance Hierarchy

HandleInputMode

Implemented Interfaces

Remarks

This mode will render a visual representation of IHandles in the CanvasComponent and deal with mouse gestures that drag the visual representations accordingly.

This mode is exclusive by default.

Examples

Typically, the HandleInputMode is installed as child mode of a GraphEditorInputMode and can be retrieved from the handleInputMode property.

Getting the HandleInputMode from its parent input mode

const handleInputMode = mode.handleInputMode

If one needs to execute some code after some items have been moved by the HandleInputMode, he can register a handler to its drag-finished event. The moved items can be retrieved from the affectedItems property:

mode.handleInputMode.addEventListener('drag-finished', () => {
  for (const item of mode.handleInputMode.affectedItems) {
    // these items have been moved
  }
})

The following example shows how to configure touch gestures without long press.

Configure touch gestures without long press

mode.moveViewportInputMode.allowSinglePointerMovement = true
mode.createBendInputMode.beginRecognizerTouch =
  EventRecognizers.TOUCH_PRIMARY_DOWN
mode.createEdgeInputMode.beginRecognizerTouch =
  EventRecognizers.TOUCH_PRIMARY_DOWN
mode.handleInputMode.beginRecognizerTouch =
  EventRecognizers.TOUCH_PRIMARY_DOWN
mode.lassoSelectionInputMode.beginRecognizerTouch =
  EventRecognizers.TOUCH_PRIMARY_DOWN
mode.marqueeSelectionInputMode.beginRecognizerTouch =
  EventRecognizers.TOUCH_PRIMARY_DOWN
mode.moveSelectedItemsInputMode.beginRecognizerTouch =
  EventRecognizers.TOUCH_PRIMARY_DOWN

Type Details

yFiles module: view

Constructors

HandleInputMode

()

Creates a new mode with no handles initially.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

priority - number

exclusive - boolean

A value indicating whether this mode will be the only one running when it has the mutex. This option sets the exclusive property on the created object.

enabled - boolean

The enabled state of this input mode. This option sets the enabled property on the created object.

useViewCoordinates - boolean

A value indicating whether handles are drawn in view coordinates or intermediate coordinates. This option sets the useViewCoordinates property on the created object.

disableSnappingRecognizer - function(EventArgs, unknown):boolean

The event recognizer that determines whether to temporarily disable snapping. This option sets the disableSnappingRecognizer property on the created object.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

enableSnappingRecognizer - function(EventArgs, unknown):boolean

The event recognizer that determines whether to re-enable temporarily disabled snapping. This option sets the enableSnappingRecognizer property on the created object.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

directionalConstraintRecognizer - function(EventArgs, unknown):boolean

The event recognizer that can be used by handle implementations to constrain the handle movement. This option sets the directionalConstraintRecognizer property on the created object.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

beginRecognizer - function(EventArgs, unknown):boolean

The event recognizer that determines whether to start moving the handle. This option sets the beginRecognizer property on the created object.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

moveRecognizer - function(EventArgs, unknown):boolean

The event recognizer that determines whether to move the handle. This option sets the moveRecognizer property on the created object.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

cancelRecognizer - function(EventArgs, unknown):boolean

The event recognizer that determines whether to cancel moving the handle. This option sets the cancelRecognizer property on the created object.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

finishRecognizer - function(EventArgs, unknown):boolean

The event recognizer that determines whether to finish moving the handle. This option sets the finishRecognizer property on the created object.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

beginRecognizerTouch - function(EventArgs, unknown):boolean

The event recognizer that determines whether to start moving the handle via TOUCH input. This option sets the beginRecognizerTouch property on the created object.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

moveRecognizerTouch - function(EventArgs, unknown):boolean

The event recognizer that determines whether to move the handle via TOUCH input. This option sets the moveRecognizerTouch property on the created object.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

finishRecognizerTouch - function(EventArgs, unknown):boolean

The event recognizer that determines whether to finish moving the handle via touch. This option sets the finishRecognizerTouch property on the created object.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

clickRecognizer - function(EventArgs, unknown):boolean

The event recognizer that determines whether a handle was clicked. This option sets the clickRecognizer property on the created object.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

clickRecognizerTouch - function(EventArgs, unknown):boolean

The event recognizer that determines whether a handle was tapped via TOUCH input. This option sets the clickRecognizerTouch property on the created object.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

handles - IObservableCollection<IHandle>

The collection of IHandles this mode manages. This option sets the handles property on the created object.

requestMutexOnPress - boolean

Whether to request the mutex when beginRecognizer or beginRecognizerTouch was triggered. This option sets the requestMutexOnPress property on the created object.

handlesRenderer - IObjectRenderer<HandlesRenderTag>

The IObjectRenderer<HandlesRenderTag> that visualizes this input mode's handles. This option sets the handlesRenderer property on the created object.

snapContext - GraphSnapContext

The GraphSnapContext which manages snapping model items to certain coordinates (for instance, other items). This option either sets the value directly or recursively sets properties to the instance of the snapContext property on the created object.

Properties

affectedItems

: IEnumerable<IModelItem>

Gets an immutable snapshot of the IModelItems affected by the currently modified handle gesture.

Remarks

When the gesture is starting and the currentHandle is initialized, the implementation can register the affected item(s) through the IModelItemCollector instance that is bound to the context available via its lookup.

Client code can register with the drag-started event, as well as the drag-finished event to get notified of the elements that may be or have been affected respectively by this input mode.

Property Value

A snapshot of the current collection of the items that are affected by the handle drag operation.

Examples

If one needs to execute some code after some items have been moved by the HandleInputMode he can register a handler to its drag-finished event. The moved items can be retrieved from the affectedItems property:

mode.handleInputMode.addEventListener('drag-finished', () => {
  for (const item of mode.handleInputMode.affectedItems) {
    // these items have been moved
  }
})

beginRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether to start moving the handle.

Remarks

The default instance value detects MOUSE or PEN DOWN events.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

beginRecognizerTouch

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether to start moving the handle via TOUCH input.

Remarks

The default recognizer is TOUCH_PRIMARY_DOWN which reacts to the user making touch contact with the main touch device. Using TOUCH_PRIMARY_LONG_PRESS allows for an intuitive alternative configuration.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

cancelRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether to cancel moving the handle.

Remarks

The default recognizer detects ESCAPE_DOWN, CANCEL or DRAG_CAPTURE_LOST events.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

clickRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether a handle was clicked.

Remarks

The default recognizer detects CLICK events for MOUSE and PEN.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

clickRecognizerTouch

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether a handle was tapped via TOUCH input.

Remarks

The default recognizer is TOUCH_PRIMARY_TAP.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

controller

: ConcurrencyController?

Gets the installed controller.

currentHandle

: IHandle?

Gets the handle that is currently being moved or null otherwise.

Property Value

The current handle or null.

directionalConstraintRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that can be used by handle implementations to constrain the handle movement.

Remarks

The default recognizer is SHIFT_IS_DOWN

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

disableSnappingRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether to temporarily disable snapping.

Remarks

The default is ALT_DOWN

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

enabled

: boolean

Gets or sets the enabled state of this input mode.

Remarks

Clients can use this property to disable or reenable this instance. This will set the enabled property of the installed controller so a disabled instance should never try to acquire the input mutex.

Disabling this mode will hide the handles and prevent the user from interacting with them.

Examples

Disabling the HandleInputMode on its parent input mode

mode.handleInputMode.enabled = false

enableSnappingRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether to re-enable temporarily disabled snapping.

Remarks

The default is ALT_UP

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

exclusive

: boolean

Gets or sets a value indicating whether this mode will be the only one running when it has the mutex.

Remarks

The value of this property will be delegated to the exclusive property of the controller.

If this mode is marked as exclusive and has the mutex, all other modes added to the same MultiplexingInputMode will be deactivated. Otherwise, it will always run concurrently with all other modes.

finishRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether to finish moving the handle.

Remarks

The default recognizer detects MOUSE or PEN UP events.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

finishRecognizerTouch

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether to finish moving the handle via touch.

Remarks

The default recognizer is TOUCH_PRIMARY_UP.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

handles

: IObservableCollection<IHandle>

Gets or sets the collection of IHandles this mode manages.

handlesRenderer

: IObjectRenderer<HandlesRenderTag>

Gets or sets the IObjectRenderer<HandlesRenderTag> that visualizes this input mode's handles.

Remarks

When queried for an IVisualCreator to obtain the visualizations for the handles, this renderer is passed instances of HandlesRenderTag as render tag.

The default handlesRenderer is HandlesRenderer which automatically uses WebGL when WebGLGraphModelManager is set as graphModelManager, otherwise the SVG is used.

Property Value

The renderer for the handles.

isDragging

: boolean

Gets a value indicating whether a drag operation is currently in progress.

moveRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether to move the handle.

Remarks

The default recognizer detects MOUSE or PEN DRAG events with the MOUSE_LEFT button.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

moveRecognizerTouch

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether to move the handle via TOUCH input.

Remarks

The default recognizer is TOUCH_PRIMARY_DRAG.

Signature Details

function(evt: EventArgs, eventSource: unknown) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

evt - EventArgs: The arguments of the event to be decided to handle.
eventSource - unknown: The source of the event.

Returns

boolean: true if the evt is considered to be handled.

parentInputModeContext

: IInputModeContext?

Retrieves the IInputModeContext this mode has been installed in.

Remarks

The value will be null if this mode is currently not installed. Use createInputModeContext to obtain a context that has this IInputMode as the inputMode.

priority

: number

Gets the priority of this input mode.

Remarks

The priority will influence the order in which the modes will be installed into the CanvasComponent. The lower the priority value, the earlier it will be installed. If two modes are using the same priority value, the first one to be registered will be installed earlier.

Implements

IInputMode

requestMutexOnPress

: boolean

Gets or sets whether to request the mutex when beginRecognizer or beginRecognizerTouch was triggered.

Remarks

If set to true this will discard other concurrent input modes when a handle was pressed. Otherwise, the mutex is only requested as soon as the drag gesture starts. The default is true.

snapContext

: GraphSnapContext?

Gets or sets the GraphSnapContext which manages snapping model items to certain coordinates (for instance, other items).

Remarks

If set to null (the default) this input mode tries to obtain the GraphSnapContext from the IInputModeContext. To explicitly disable snapping, a GraphSnapContext implementation that is disabled needs to be set.

Default is null.

useViewCoordinates

: boolean

Gets or sets a value indicating whether handles are drawn in view coordinates or intermediate coordinates.

Remarks

This only makes a difference if the projection is different from the IDENTITY transform.

The default value is to draw handles in the intermediate coordinate system.

Methods

addHandle

(location: IMutablePoint, cursor?: Cursor, type?: HandleType) : IHandle

Factory method that creates and adds a handle to this mode by wrapping a given IMutablePoint instance.

Remarks

The cursor and type are used to initialize the IHandle instance.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

location - IMutablePoint: The point to use as a handle.
cursor - Cursor: The cursor to use.
type - HandleType: The type of the handle to create.

Returns

↪IHandle: The handle created.

addHandle

(handle: IHandle)

Adds a handle to the collection of handles managed by this instance.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

handle - IHandle: The handle to add.

arm

(handle: IHandle)

Invoked when this mode gets "armed".

Remarks

This happens when the mouse pointer hovers over a handle. This changes the mouse cursor to the handle's cursor.

Parameters

options - Object
A map of options to pass to the method.

handle - IHandle: The handle from which the cursor is queried.

cancel

()

Will be called to unconditionally cancel all ongoing edits.

Remarks

This will be called prior to the uninstalling of this instance and when other input modes temporarily acquire the mutex.

In order to stop an active input mode manually, client code should use the following idiom:

if (!mode.tryStop()) {
  mode.cancel()
}

Implements

IInputMode

createInputModeContext

() : IInputModeContext

Creates an IInputModeContext for use with the IHandle interface for the upcoming drag operation.

Returns

↪IInputModeContext: An instance of IInputModeContext.

createInputModeEventArgs

() : InputModeEventArgs

Helper method that yields a suitably configured InputModeEventArgs for this input mode.

Returns

↪InputModeEventArgs: An input mode event argument that is configured for this instance.

disarm

()

Invoked when this mode gets "disarmed".

Remarks

This happens when the mouse stops hovering over a handle. This resets the mouse cursor.

getClosestHandleAt

(location: Point) : IHandle

Finds the closest hit handle for the given world coordinate pair.

Remarks

The default implementation first dispatches the query-closest-handle event and evaluates whether it was handled. If the event was not handled, it delegates to getClosestHitHandle.

Parameters

options - Object
A map of options to pass to the method.

location - Point: The coordinates in the world coordinate system.

Returns

↪IHandle?: The closest handle that has been hit or null

getClosestHitHandle

(location: Point, pointerType: PointerType) : IHandle

Finds the closest hit handle for the given world coordinate pair.

Remarks

The default implementation compares the Manhattan distance of the handles to find the closest handle.

Parameters

options - Object
A map of options to pass to the method.

location - Point: The coordinates in the world coordinate system.
pointerType - PointerType: The pointer-type of the last input event.

Returns

↪IHandle?: The closest handle that has been hit or null

getHandleOffset

(handle: IHandle) : Point

Calculates the offset between the given handle's visual location and its logical location.

Remarks

Uses handle offset of the theme and the handle's type to position the handle.

Parameters

options - Object
A map of options to pass to the method.

handle - IHandle: The handle to hit test or render.

Returns

↪Point: A coordinate pair representing the offsets in x- and y-direction.

handleClick

(context: IInputModeContext, evt: ClickEventArgs, handle: IHandle)

Calls handleClick of the handle with the evt.

Remarks

This method is called when clickRecognizer or clickRecognizerTouch were triggered.

Parameters

options - Object
A map of options to pass to the method.

context - IInputModeContext: The current input mode context.
evt - ClickEventArgs: Arguments describing the click.
handle - IHandle: The handle that was clicked.

handleIsHit

(handle: IHandle, location: Point, distance: Point, pointerType: PointerType) : boolean

Determines whether a given handle has been visually hit by the mouse at the given world coordinates.

Remarks

This implementation uses the Manhattan distance as a metric to determine if the handle was hit.

Parameters

options - Object
A map of options to pass to the method.

handle - IHandle: The handle to check
location - Point: The view coordinates to check.
distance - Point: The distance of the handle to the location. In the default implementation, this is a tuple representing the x- and y-distance of the handle to the location.
pointerType - PointerType: The last event's pointer type to consider.

Returns

↪boolean: Whether the handle has been hit.

install

(context: IInputModeContext, controller: ConcurrencyController)

Installs the visual representation of the handles into the canvas into the inputModeGroup.

Parameters

options - Object
A map of options to pass to the method.

context - IInputModeContext: The context that this instance shall be installed into. The same instance will be passed to this instance during uninstall. A reference to the context may be kept and queried during the time the mode is installed.
controller - ConcurrencyController: The controller for this mode.

Implements

IInputMode

invalidate

()

Invalidates the canvas this mode is currently installed in.

isDirectionalConstrained

() : boolean

Returns whether this input mode has the mutex and the directionalConstraintRecognizer recognized a directional constrained move for the lastInputEvent.

Returns

↪boolean: true, if this input mode has the mutex and the last input event was recognized by the directionalConstraintRecognizer, false otherwise.

isSnappingDisabled

() : boolean

Returns whether this input mode has the mutex and the disableSnappingRecognizer recognized that snapping shall be temporarily disabled.

Returns

↪boolean: true, if this input mode has the mutex and snapping is temporarily disabled, false otherwise.

onCanceled

()

Called after cancel has been called.

Remarks

Can be overridden in subclasses to perform additional actions after the mode has been canceled.

This implementation does nothing.

onClicked

(evt: ClickEventArgs)

Triggers the clicked event.

Remarks

This method triggers the clicked event.

Parameters

options - Object
A map of options to pass to the method.

evt - ClickEventArgs: The event argument that contains context information.

onConcurrencyControllerActivated

()

Called after the active property of the installed ConcurrencyController has been set to true.

Remarks

Can be overridden in subclasses to perform additional actions after the mode has been activated.

Overriding implementations should call the base implementation.

onConcurrencyControllerDeactivated

()

Called after the active property of the installed ConcurrencyController has been set to false.

Remarks

Can be overridden in subclasses to perform additional actions after the mode has been deactivated.

Overriding implementations should call the base implementation.

onDragCanceled

(evt: InputModeEventArgs)

Triggers the drag-canceled event.

Parameters

options - Object
A map of options to pass to the method.

evt - InputModeEventArgs: The event argument that contains context information.

onDragCanceling

(evt: InputModeEventArgs)

Triggers the drag-canceling event.

Parameters

options - Object
A map of options to pass to the method.

evt - InputModeEventArgs: The event argument that contains context information.

onDragFinished

(evt: InputModeEventArgs)

Triggered once the drag has been finalized.

Remarks

This method triggers the drag-finished event.

Parameters

options - Object
A map of options to pass to the method.

evt - InputModeEventArgs: The event argument that contains context information.

onDragFinishing

(evt: InputModeEventArgs)

Triggered before the drag will be finalized.

Remarks

This method triggers the drag-finishing event.

Parameters

options - Object
A map of options to pass to the method.

evt - InputModeEventArgs: The event argument that contains context information.

onDragged

(evt: InputModeEventArgs)

Triggered at the end of each drag.

Remarks

This method triggers the dragged event.

Parameters

options - Object
A map of options to pass to the method.

evt - InputModeEventArgs: The event argument that contains context information.

onDragging

(evt: InputModeEventArgs)

Triggered at the start of each drag.

Remarks

This method triggers the dragging event.

Parameters

options - Object
A map of options to pass to the method.

evt - InputModeEventArgs: The event argument that contains context information.

onDragStarted

(evt: InputModeEventArgs)

Triggers the drag-started event.

Parameters

options - Object
A map of options to pass to the method.

evt - InputModeEventArgs: The event argument that contains context information.

onDragStarting

(evt: InputModeEventArgs)

Triggers the drag-starting event.

Parameters

options - Object
A map of options to pass to the method.

evt - InputModeEventArgs: The event argument that contains context information.

onQueryClosestHandle

(evt: QueryClosestHandleEventArgs)

Raises the query-closest-handle event.

Parameters

options - Object
A map of options to pass to the method.

evt - QueryClosestHandleEventArgs: The query-closest-handle instance containing the event data.

onStopped

()

Called after tryStop has been called.

Remarks

Can be overridden in subclasses to perform additional actions after the mode has been stopped.

This implementation does nothing.

removeHandle

(handle: IHandle)

Removes a handle from the collection of handles managed by this instance.

Parameters

options - Object
A map of options to pass to the method.

handle - IHandle: The handle to remove.

startDrag

(handle: IHandle) : Promise<boolean>

Method that can be used to initialize the dragging of a given handle manually.

Remarks

This will simulate the user having initialized a drag of the given handle.

Parameters

options - Object
A map of options to pass to the method.

handle - IHandle: The handle to be dragged.

Returns

↪Promise<boolean>: A Promise<T> that resolves when the drag operation is done. It resolves to true if the operation is finished successfully and to false if the operation is canceled.

tryStop

() : boolean

Will be called to request a stop of the current editing progress.

Remarks

This should stop the current edit, if one is in progress, and possibly commit all pending changes. If stopping is not possible, this method can return false

Returns

↪boolean: true if and only if the editing has been stopped or there was no edit in progress

Implements

IInputMode

uninstall

(context: IInputModeContext)

Removes the IRenderTreeElement that displays the handles from the canvas.

Parameters

options - Object
A map of options to pass to the method.

context - IInputModeContext: The context to deregister from. This is the same instance that had been passed to install during installation.

Implements

IInputMode

Events

'clicked'

: function(ClickEventArgs, this):void

Occurs when a handle has been clicked or tapped.

'drag-canceled'

: function(InputModeEventArgs, this):void

Occurs when the drag has been canceled.

'drag-canceling'

: function(InputModeEventArgs, this):void

Occurs before the drag will be canceled.

'drag-finished'

: function(InputModeEventArgs, this):void

Occurs once the drag has been finished.

Examples

mode.handleInputMode.addEventListener('drag-finished', () => {
  for (const item of mode.handleInputMode.affectedItems) {
    // these items have been moved
  }
})

'drag-finishing'

: function(InputModeEventArgs, this):void

Occurs before the drag will be finished.

'drag-started'

: function(InputModeEventArgs, this):void

Occurs once the drag is initialized and has started.

'drag-starting'

: function(InputModeEventArgs, this):void

Occurs once the drag is starting.

'dragged'

: function(InputModeEventArgs, this):void

Occurs at the end of every drag.

'dragging'

: function(InputModeEventArgs, this):void

Occurs at the start of every drag.

'query-closest-handle'

: function(QueryClosestHandleEventArgs, this):void

Occurs when this mode queries the closest handle for a certain query location.

Remarks

Handlers should set the handle property or set/respect the handled property accordingly.

HandleInputMode

Remarks

Examples

Type Details

See Also

Constructors

HandleInputMode

ParametersOptions Overload

Signature Details

Parameters

Returns

Signature Details

Parameters

Returns

Signature Details

Parameters

Returns

Signature Details

Parameters

Returns

Signature Details

Parameters

Returns

Signature Details

Parameters

Returns

Signature Details

Parameters

Returns

Signature Details

Parameters

Returns

Signature Details

Parameters

Returns

Signature Details

Parameters

Returns

Signature Details

Parameters

Returns

Signature Details

Parameters

Returns

See Also

Properties

affectedItems

Remarks

Property Value

Examples

See Also

beginRecognizer

Remarks

Signature Details

Parameters

Returns

beginRecognizerTouch

Remarks

Signature Details

Parameters

Returns

cancelRecognizer

Remarks

Signature Details

Parameters

Returns

clickRecognizer

Remarks

Signature Details

Parameters

Returns

clickRecognizerTouch

Remarks

Signature Details

Parameters

Returns

controller

currentHandle

Property Value

directionalConstraintRecognizer