LassoSelectionInputMode

An IInputMode implementation that provides support for lasso selections through mouse or touch gestures.

Inheritance Hierarchy

LassoSelectionInputMode

Implemented Interfaces

Remarks

This implementation will request the mutex as soon as it recognizes a mouse or touch drag.

By default, the lasso is a single freehand gesture. However, both a polyline path and mixed freehand/polyline paths are possible with different configuration.

Per default the visualization of the lasso selection region uses the secondary color of the set theme of CanvasComponent and uses the yfiles-lasso-template CSS class.

This mode is exclusive by default.

Examples

The LassoSelectionInputMode can easily be configured for different gestures, e.g. for a polyline path instead of the default freehand configuration:

const lassoSelectionInputMode =
  graphEditorInputMode.lassoSelectionInputMode
lassoSelectionInputMode.enabled = true
lassoSelectionInputMode.startSegmentRecognizer = EventRecognizers.ALWAYS
lassoSelectionInputMode.endSegmentRecognizer = (evt, sender) =>
  EventRecognizers.MOUSE_LEFT_DOWN(evt, sender) ||
  EventRecognizers.MOUSE_LEFT_UP(evt, sender)
lassoSelectionInputMode.dragSegmentRecognizer = (_, evt) =>
  evt instanceof PointerEventArgs &&
  (evt.pointerType == PointerType.MOUSE ||
    evt.pointerType == PointerType.PEN) &&
  (evt.eventType == PointerEventType.MOVE ||
    evt.eventType == PointerEventType.DRAG)
lassoSelectionInputMode.finishRecognizer =
  EventRecognizers.MOUSE_LEFT_DOUBLE_CLICK
lassoSelectionInputMode.finishRadius = 10

Type Details

yFiles module: view

Constructors

LassoSelectionInputMode

()

Creates a new instance of the lasso selection mode.

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.

finishRegionRenderer - IObjectRenderer<LassoPathFinishRegionRenderTag>

The IObjectRenderer<LassoPathFinishRegionRenderTag> that visualizes the region around the startLocation where the lasso may be finished. This option sets the finishRegionRenderer property on the created object.

finishRadius - number

The radius in view coordinates around the startLocation where the lasso selection can be finished. This option sets the finishRadius property on the created object.

validBeginCursor - Cursor

The cursor to use when beginning the dragging of the lasso is valid. This option sets the validBeginCursor property on the created object.

lassoCursor - Cursor

The cursor to use during the dragging of the lasso. This option sets the lassoCursor property on the created object.

extendSelectionCursor - Cursor

The cursor to use during the dragging of the lasso when extendSelectionRecognizer is active. This option sets the extendSelectionCursor property on the created object.

subtractSelectionCursor - Cursor

The cursor to use during the dragging of the lasso when subtractSelectionRecognizer is active. This option sets the subtractSelectionCursor property on the created object.

toggleSelectionCursor - Cursor

The cursor to use during the dragging of the lasso when toggleSelectionRecognizer is active. This option sets the toggleSelectionCursor property on the created object.

extendSelectionRecognizer - function(EventArgs, unknown):boolean

The event recognizer that determines if a selection is deemed an additive selection gesture, adding to the current selection. This option sets the extendSelectionRecognizer 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.

subtractSelectionRecognizer - function(EventArgs, unknown):boolean

The event recognizer that determines if a selection is deemed a subtractive selection gesture, removing the selection state from the current selection. This option sets the subtractSelectionRecognizer 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.

toggleSelectionRecognizer - function(EventArgs, unknown):boolean

The event recognizer that determines if a selection is deemed a toggle selection gesture, inverting the selection for the elements in the lasso. This option sets the toggleSelectionRecognizer 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.

validEndCursor - Cursor

The cursor to use when hovering over a valid end location. This option sets the validEndCursor property on the created object.

cancelRecognizer - function(EventArgs, unknown):boolean

The event recognizer that determines whether to cancel lasso selection. 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.

validBeginRecognizer - function(EventArgs, unknown):boolean

The event recognizer that determines whether it is valid to begin drawing the lasso. This option sets the validBeginRecognizer 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 drawing the lasso. 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.

dragFreeHandRecognizer - function(EventArgs, unknown):boolean

The event recognizer that determines whether to drag the lasso free hand. This option sets the dragFreeHandRecognizer 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.

dragSegmentRecognizer - function(EventArgs, unknown):boolean

The event recognizer that determines whether to drag a straight-line segment for the lasso. This option sets the dragSegmentRecognizer 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.

startSegmentRecognizer - function(EventArgs, unknown):boolean

The event recognizer that determines whether to switch from freehand to segment mode. This option sets the startSegmentRecognizer 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.

endSegmentRecognizer - function(EventArgs, unknown):boolean

The event recognizer that determines whether to end a segment and switch from segment to freehand mode. This option sets the endSegmentRecognizer 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 the gesture anywhere independent of the finishRadius. 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.

finishRegionRecognizer - function(EventArgs, unknown):boolean

The event recognizer that determines whether to finish the gesture when the pointer is within the finishRadius of the startLocation. This option sets the finishRegionRecognizer 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 drawing the lasso with 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.

dragFreeHandRecognizerTouch - function(EventArgs, unknown):boolean

The event recognizer that determines whether to drag the lasso free hand with TOUCH input. This option sets the dragFreeHandRecognizerTouch 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.

dragSegmentRecognizerTouch - function(EventArgs, unknown):boolean

The event recognizer that determines whether to drag a straight-line segment for the lasso with TOUCH input. This option sets the dragSegmentRecognizerTouch 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.

startSegmentRecognizerTouch - function(EventArgs, unknown):boolean

A recognizer determining when to switch from freehand to segment mode for TOUCH input. This option sets the startSegmentRecognizerTouch 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.

endSegmentRecognizerTouch - function(EventArgs, unknown):boolean

The event recognizer that determines whether to end a segment and switch from segment to freehand mode for TOUCH input. This option sets the endSegmentRecognizerTouch 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 the touch gesture anywhere independent of the finishRadius. 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.

finishRegionRecognizerTouch - function(EventArgs, unknown):boolean

The event recognizer that determines whether to finish the touch gesture when the pointer is within the finishRadius of the startLocation. This option sets the finishRegionRecognizerTouch 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.

Properties

beginRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether to start drawing the lasso.

Remarks

The default recognizer detects primary down events for MOUSE or 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.

beginRecognizerTouch

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether to start drawing the lasso with TOUCH input.

Remarks

The default recognizer is TOUCH_PRIMARY_LONG_PRESS which reacts to the user making touch contact with the main touch device. Using TOUCH_PRIMARY_DOWN 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 lasso selection.

Remarks

The default recognizer reacts to CANCEL and DRAG_CAPTURE_LOST events, or ESCAPE_DOWN, or secondary up events for MOUSE or 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.

controller

: ConcurrencyController?

Gets the installed controller.

dragFreeHandRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether to drag the lasso free hand.

Remarks

The default recognizer detects primary DRAG events for MOUSE or 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.

dragFreeHandRecognizerTouch

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether to drag the lasso free hand with 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.

dragSegmentRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether to drag a straight-line segment for the lasso.

Remarks

The default recognizer is MOUSE_MOVE.

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.

dragSegmentRecognizerTouch

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether to drag a straight-line segment for the lasso with TOUCH input.

Remarks

The default recognizer is NEVER which means that the straight-line segment will only be finished when switching back to free hand creation or when finishing the gesture.

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.

endSegmentRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether to end a segment and switch from segment to freehand mode.

Remarks

The default recognizer detects primary down events for MOUSE or PEN. However, since startSegmentRecognizer is disabled, this has no effect in the default 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.

endSegmentRecognizerTouch

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether to end a segment and switch from segment to freehand mode for TOUCH input.

Remarks

The default recognizer is TOUCH_PRIMARY_DOWN. However, since startSegmentRecognizerTouch is disabled, this has no effect in the default 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.

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.

extendSelectionCursor

: Cursor?

Gets or sets the cursor to use during the dragging of the lasso when extendSelectionRecognizer is active.

Remarks

The default is null meaning that lassoCursor will be used instead.

extendSelectionRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines if a selection is deemed an additive selection gesture, adding to the current selection.

Remarks

If the event recognizer returns true for the current gesture, the elements which will be selected with that gesture will be added to the current selection. Otherwise, the selection will be cleared before adding the newly selected element.

Note that this will only have an influence on the currently shown lassoCursor and the value of the selectionPolicy property. It is up to the handler of the drag-finished event to implement the selection behavior based on the policy value.

The default detects the current platform and delegates either to META_IS_DOWN (macOS) or CTRL_IS_DOWN (other platforms).

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.

finishRadius

: number

Gets or sets the radius in view coordinates around the startLocation where the lasso selection can be finished.

Remarks

A value of 0 (the default) disables ending the gesture near the startLocation and also disables showing the indicator.

Default is 0.

finishRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether to finish the gesture anywhere independent of the finishRadius.

Remarks

The default recognizer is MOUSE_LEFT_DOUBLE_CLICK.

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 the touch gesture anywhere independent of the finishRadius.

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.

finishRegionRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether to finish the gesture when the pointer is within the finishRadius of the startLocation.

Remarks

This recognizer is always combined with a check whether the input coordinates are within finishRadius around startLocation.

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.

finishRegionRecognizerTouch

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether to finish the touch gesture when the pointer is within the finishRadius of the startLocation.

Remarks

This recognizer is always combined with a check whether the input coordinates are within finishRadius around startLocation.

The default recognizer is TOUCH_PRIMARY_UP.

Due to the default recognizer for finishRecognizerTouch and the default value for finishRadius this is not used unless the mentioned properties are changed.

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.

finishRegionRenderer

: IObjectRenderer<LassoPathFinishRegionRenderTag>

Gets or sets the IObjectRenderer<LassoPathFinishRegionRenderTag> that visualizes the region around the startLocation where the lasso may be finished.

Remarks

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

Property Value

The finish region renderer.

lassoCursor

: Cursor?

Gets or sets the cursor to use during the dragging of the lasso.

Remarks

The default is CROSSHAIR

parentInputModeContext

: IInputModeContext?

Retrieves the IInputModeContext this mode has been installed in.

Remarks

The value will be null if this mode is currently not installed.

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

selectionPath

: GeneralPath

Gets the current or last selection path.

selectionPolicy

: SelectionPolicy

Gets the current or last SelectionPolicy as determined by the EventRecognizers.

startLocation

: Point

Gets the location where the beginRecognizer was triggered and the lasso selection started.

startSegmentRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether to switch from freehand to segment mode.

Remarks

The default recognizer is NEVER, which locks this mode in freehand-only mode. However, this can be set differently to allow for a mixed freehand/segment mode.

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.

startSegmentRecognizerTouch

: function(EventArgs, unknown):boolean

Gets or sets a recognizer determining when to switch from freehand to segment mode for TOUCH input.

Remarks

The default recognizer is NEVER, which locks this mode in freehand-only mode. However, this can be set differently to allow for a mixed freehand/segment mode.

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.

subtractSelectionCursor

: Cursor?

Gets or sets the cursor to use during the dragging of the lasso when subtractSelectionRecognizer is active.

Remarks

The default is null meaning that lassoCursor will be used instead.

subtractSelectionRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines if a selection is deemed a subtractive selection gesture, removing the selection state from the current selection.

Remarks

If the event recognizer returns true for the current gesture, the elements which will be selected with that gesture will be removed from the current selection.

The default 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.

toggleSelectionCursor

: Cursor?

Gets or sets the cursor to use during the dragging of the lasso when toggleSelectionRecognizer is active.

Remarks

The default is null meaning that lassoCursor will be used instead.

toggleSelectionRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines if a selection is deemed a toggle selection gesture, inverting the selection for the elements in the lasso.

Remarks

If the event recognizer returns true for the current gesture, the elements in the lasso will get their selection state toggled.

The default is ALT_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.

validBeginCursor

: Cursor?

Gets or sets the cursor to use when beginning the dragging of the lasso is valid.

Remarks

The default is null

validBeginRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether it is valid to begin drawing the lasso.

Remarks

The default recognizer is ALWAYS.

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.

validEndCursor

: Cursor?

Gets or sets the cursor to use when hovering over a valid end location.

Remarks

The default is Cursors.Pen

Methods

cancel

()

Cancels any pending lasso selection.

Implements

IInputMode

createInputModeEventArgs

() : LassoSelectionEventArgs

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

Returns

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

install

(context: IInputModeContext, controller: ConcurrencyController)

Installs this mode into the given context that is provided by the canvas.

Remarks

In general a mode can only be installed into a single canvas at all times.

This method is called to initialize this instance. Subclasses should override this method to register the corresponding event handler delegates for the various input events they need to register with.

Overriding implementations should call the base implementation, first.

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

isValidEndLocation

(location: Point) : boolean

Used by the finishRecognizer and finishRecognizerTouch to check the current cursor position.

Remarks

This method checks if the distance from location to the startLocation is less than finishRadius in view coordinates.

Parameters

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

location - Point: The location in world coordinates that should be checked.

Returns

↪boolean: true if the location is a valid end location; otherwise, false.

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.

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: LassoSelectionEventArgs)

Triggers the drag-canceled event.

Parameters

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

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

onDragCanceling

(evt: LassoSelectionEventArgs)

Triggers the drag-canceling event.

Parameters

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

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

onDragFinished

(evt: LassoSelectionEventArgs)

Called 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 - LassoSelectionEventArgs: The event argument that contains context information.

onDragFinishing

(evt: LassoSelectionEventArgs)

Called 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 - LassoSelectionEventArgs: The event argument that contains context information.

onDragged

(evt: LassoSelectionEventArgs)

Called 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 - LassoSelectionEventArgs: The event argument that contains context information.

onDragging

(evt: LassoSelectionEventArgs)

Called 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 - LassoSelectionEventArgs: The event argument that contains context information.

onDragStarted

(evt: LassoSelectionEventArgs)

Triggers the drag-started event.

Parameters

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

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

onDragStarting

(evt: LassoSelectionEventArgs)

Triggers the drag-starting event.

Parameters

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

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

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.

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)

Uninstalls this mode from the given context.

Remarks

This code should clean up all changes made to the canvas in the install method. After a mode has been uninstalled it can be installed again into the same or another canvas.

Overriding implementations should call the base implementation after their own code.

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

'drag-canceled'

: function(LassoSelectionEventArgs, this):void

Occurs when the drag has been canceled.

'drag-canceling'

: function(LassoSelectionEventArgs, this):void

Occurs before the drag will be canceled.

'drag-finished'

: function(LassoSelectionEventArgs, this):void

Occurs when the drag has been finished.

'drag-finishing'

: function(LassoSelectionEventArgs, this):void

Occurs before the drag will be finished.

'drag-started'

: function(LassoSelectionEventArgs, this):void

Occurs once the drag is initialized and has started.

'drag-starting'

: function(LassoSelectionEventArgs, this):void

Occurs once the drag is starting.

'dragged'

: function(LassoSelectionEventArgs, this):void

Occurs at the end of every drag.

'dragging'

: function(LassoSelectionEventArgs, this):void

Occurs at the start of every drag.

LassoSelectionInputMode

Remarks

Examples

Related Reading in the Developer's Guide

Type Details

Constructors

LassoSelectionInputMode

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

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

Properties

beginRecognizer

Remarks

Signature Details

Parameters

Returns

See Also

beginRecognizerTouch

Remarks

Signature Details

Parameters

Returns

See Also

cancelRecognizer

Remarks