LassoSelectionInputMode

An IInputMode implementation that can handle lasso selections performed by the user with a mouse or via touch.

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 secondaryColor of the set theme. This can be customized by setting another stroke or fill or registering a Stroke or Fill using the LASSO_STROKE_KEY or LASSO_FILL_KEY.

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.dragFreeRecognizer = MouseEventRecognizers.DRAG
lassoSelectionInputMode.startSegmentRecognizer = EventRecognizers.ALWAYS
lassoSelectionInputMode.endSegmentRecognizer =
  EventRecognizers.createOrRecognizer(
    MouseEventRecognizers.LEFT_IS_DOWN,
    MouseEventRecognizers.LEFT_UP
  )
lassoSelectionInputMode.dragSegmentRecognizer =
  MouseEventRecognizers.MOVE_OR_DRAG
lassoSelectionInputMode.finishRecognizer =
  MouseEventRecognizers.LEFT_DOUBLE_CLICK
lassoSelectionInputMode.finishRadius = 10

Type Details

yfiles module: view-component
yfiles-umd modules: All view modules
Legacy UMD name: yfiles.input.LassoSelectionInputMode

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.

stroke - Stroke

The stroke that is used for the visualization of the lasso path. This option sets the stroke property on the created object.

fill - Fill

The fill that is used for the visualization of the lasso path. This option sets the fill property on the created object.

finishRegionTemplate - IVisualTemplate

The template that is used for the visualization of the region around the startLocation where the lasso may be finished. This option sets the finishRegionTemplate property on the created object.

finishRegionHighlightTemplate - IVisualTemplate

The template that is used for the visualization of the highlighted region around the startLocation where the lasso may be finished. This option sets the finishRegionHighlightTemplate 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.

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(Object, EventArgs):boolean

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

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

validBeginRecognizer - function(Object, EventArgs):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(eventSource: any, evt: EventArgs) : 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

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

Returns

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

prepareRecognizer - function(Object, EventArgs):boolean

The event recognizer that determines whether to start drawing the lasso. This option sets the prepareRecognizer property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

dragFreeRecognizer - function(Object, EventArgs):boolean

The event recognizer that determines whether to drag the lasso free hand. This option sets the dragFreeRecognizer property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

dragSegmentRecognizer - function(Object, EventArgs):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(eventSource: any, evt: EventArgs) : 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

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

Returns

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

startSegmentRecognizer - function(Object, EventArgs):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(eventSource: any, evt: EventArgs) : 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

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

Returns

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

endSegmentRecognizer - function(Object, EventArgs):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(eventSource: any, evt: EventArgs) : 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

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

Returns

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

finishRecognizer - function(Object, EventArgs):boolean

The event recognizer that determines whether to finish the gesture away from the startLocation. This option sets the finishRecognizer property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

finishRegionRecognizer - function(Object, EventArgs):boolean

The event recognizer that determines whether to finish the gesture when near the startLocation. This option sets the finishRegionRecognizer property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

prepareRecognizerTouch - function(Object, EventArgs):boolean

The event recognizer that determines whether to start drawing the lasso via touch. This option sets the prepareRecognizerTouch property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

dragFreeRecognizerTouch - function(Object, EventArgs):boolean

The event recognizer that determines whether to drag the lasso free hand via touch. This option sets the dragFreeRecognizerTouch property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

dragSegmentRecognizerTouch - function(Object, EventArgs):boolean

The event recognizer that determines whether to drag a straight-line segment for the lasso via touch. This option sets the dragSegmentRecognizerTouch property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

startSegmentRecognizerTouch - function(Object, EventArgs):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(eventSource: any, evt: EventArgs) : 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

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

Returns

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

endSegmentRecognizerTouch - function(Object, EventArgs):boolean

The event recognizer that determines whether to end a segment and switch from segment to freehand mode via touch. This option sets the endSegmentRecognizerTouch property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

finishRecognizerTouch - function(Object, EventArgs):boolean

The event recognizer that determines whether to finish the gesture away from the startLocation via touch. This option sets the finishRecognizerTouch property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

finishRegionRecognizerTouch - function(Object, EventArgs):boolean

The event recognizer that determines whether to finish the gesture when near the startLocation via touch. This option sets the finishRegionRecognizerTouch property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

Properties

cancelRecognizer

: function(any, EventArgs):boolean

Gets or sets the event recognizer that determines whether to cancel lasso selection.

Remarks

The default recognizer reacts on ESCAPE_DOWN or LOST_CAPTURE_DURING_DRAG, or RIGHT_UP.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

controller

: ConcurrencyController

Gets the installed controller.

dragFreeRecognizer

: function(any, EventArgs):boolean

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

Remarks

The default value is LEFT_DRAG.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

dragFreeRecognizerTouch

: function(any, EventArgs):boolean

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

Remarks

The default value is TOUCH_MOVE_PRIMARY.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

dragSegmentRecognizer

: function(any, EventArgs):boolean

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

Remarks

The default value is MOVE.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

dragSegmentRecognizerTouch

: function(any, EventArgs):boolean

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

Remarks

The default value 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(eventSource: any, evt: EventArgs) : 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

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

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(any, EventArgs):boolean

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

Remarks

The default value is LEFT_DOWN. However, since startSegmentRecognizer is disabled, this has no effect in the default configuration.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

endSegmentRecognizerTouch

: function(any, EventArgs):boolean

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

Remarks

The default value is TOUCH_DOWN_PRIMARY. However, since startSegmentRecognizerTouch is disabled, this has no effect in the default configuration.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

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.

fill

: Fill

Gets or sets the fill that is used for the visualization of the lasso path.

Remarks

Alternatively, the default path template can be styled with the yfiles-lasso-template or yfiles-lasso-path CSS classes.

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 disable showing the indicator.

Default is 0.

finishRecognizer

: function(any, EventArgs):boolean

Gets or sets the event recognizer that determines whether to finish the gesture away from the startLocation.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

finishRecognizerTouch

: function(any, EventArgs):boolean

Gets or sets the event recognizer that determines whether to finish the gesture away from the startLocation via touch.

Remarks

The default value is TOUCH_UP_PRIMARY.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

finishRegionHighlightTemplate

: IVisualTemplate

Gets or sets the template that is used for the visualization of the highlighted region around the startLocation where the lasso may be finished.

Remarks

Alternatively, the default template can be styled with the yfiles-lasso-template or yfiles-lasso-finish-region-highlight CSS classes.

finishRegionRecognizer

: function(any, EventArgs):boolean

Gets or sets the event recognizer that determines whether to finish the gesture when near the startLocation.

Remarks

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

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

finishRegionRecognizerTouch

: function(any, EventArgs):boolean

Gets or sets the event recognizer that determines whether to finish the gesture when near the startLocation via touch.

Remarks

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

The default value is TOUCH_UP_PRIMARY.

Due to the default value for finishRecognizerTouch and finishRadius this is not normally used, except the mentioned properties are changed.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

finishRegionTemplate

: IVisualTemplate

Gets or sets the template that is used for the visualization of the region around the startLocation where the lasso may be finished.

Remarks

Alternatively, the default template can be styled with the yfiles-lasso-template or yfiles-lasso-finish-region CSS classes.

inputModeContext

: IInputModeContext

Gets the context instance this mode is currently installed in or null if this instance is not installed.

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

prepareRecognizerTouch

: function(any, EventArgs):boolean

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

Remarks

The default value is TOUCH_LONG_PRESS_PRIMARY.

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

Returns

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

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 canvas control. The lower the priority value, the earlier it will be installed. If two modes are installed using the same priority value, the first one will be installed earlier.

Implements

IInputMode

selectionPath

: GeneralPath

Gets the current or last selection path.

startLocation

: Point

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

startSegmentRecognizer

: function(any, EventArgs):boolean

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

Remarks

The default value 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(eventSource: any, evt: EventArgs) : 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

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

Returns

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

startSegmentRecognizerTouch

: function(any, EventArgs):boolean

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

Remarks

The default value 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(eventSource: any, evt: EventArgs) : 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

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

Returns

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

Signature Details

function(eventSource: any, evt: EventArgs) : 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

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

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 InputModeEventArgs 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 then 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.

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 DragFinished 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 DragFinishing 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 DragStarted 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 DragStarting 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

Called by the client in order to stop a current editing progress.

Remarks

This should stop the current edit, if one is in progress and possibly commit all of the 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

sender - this: The source of the event.
evt - LassoSelectionEventArgs: An object that contains the event data.

LASSO_STROKE_KEY

: string

A string that can be used to store a stroke for the visualization of the lasso path.

Remarks

Alternatively, the default path template can be styled with the yfiles-lasso-template or yfiles-lasso-path CSS classes.

LassoSelectionInputMode

Remarks

Examples

Type Details

See Also

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

Properties

cancelRecognizer

Remarks

Signature Details

Parameters

Returns

controller

dragFreeRecognizer

Remarks

Signature Details

Parameters

Returns

See Also

dragFreeRecognizerTouch

Remarks

Signature Details

Parameters

Returns

dragSegmentRecognizer

Remarks

Signature Details

Parameters

Returns

See Also