An IInputMode implementation that can handle a collection of IHandles.
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.
const handleInputMode = mode.handleInputModeIf one needs to execute some code after some items have been moved by the HandleInputMode he can register a handler to its DragFinished event. The moved items can be retrieved from the affectedItems property:
mode.handleInputMode.addDragFinishedListener((sender, args) => {
for (const item of mode.handleInputMode.affectedItems) {
// these items have been moved
}
})mode.moveViewportInputMode.allowSinglePointerMovement = true
mode.createBendInputMode.prepareRecognizerTouch =
TouchEventRecognizers.TOUCH_DOWN_PRIMARY
mode.createEdgeInputMode.prepareRecognizerTouch =
TouchEventRecognizers.TOUCH_DOWN_PRIMARY
mode.handleInputMode.pressedRecognizerTouch =
TouchEventRecognizers.TOUCH_DOWN_PRIMARY
mode.lassoSelectionInputMode.prepareRecognizerTouch =
TouchEventRecognizers.TOUCH_DOWN_PRIMARY
mode.marqueeSelectionInputMode.pressedRecognizerTouch =
TouchEventRecognizers.TOUCH_DOWN_PRIMARY
mode.moveInputMode.pressedRecognizerTouch =
TouchEventRecognizers.TOUCH_DOWN_PRIMARYType Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.input.HandleInputMode
See Also
Constructors
Creates a new mode with no handles initially.
Parameters
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(Object, EventArgs):boolean
The event recognizer that determines whether to temporarily disable snapping. This option sets the disableSnappingRecognizer property on the created object.
Signature Details
function(eventSource: any, evt: EventArgs) : booleanA 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
trueif theevtis considered to be handled.
- enableSnappingRecognizer - function(Object, EventArgs):boolean
The event recognizer that determines whether to reenable temporarily disabled snapping. This option sets the enableSnappingRecognizer property on the created object.
Signature Details
function(eventSource: any, evt: EventArgs) : booleanA 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
trueif theevtis considered to be handled.
- pressedRecognizer - function(Object, EventArgs):boolean
The event recognizer that determines whether to start moving the handle. This option sets the pressedRecognizer property on the created object.
Signature Details
function(eventSource: any, evt: EventArgs) : booleanA 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
trueif theevtis considered to be handled.
- draggedRecognizer - function(Object, EventArgs):boolean
The event recognizer that determines whether to move the handle. This option sets the draggedRecognizer property on the created object.
Signature Details
function(eventSource: any, evt: EventArgs) : booleanA 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
trueif theevtis considered to be handled.
- cancelRecognizer - function(Object, EventArgs):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(eventSource: any, evt: EventArgs) : booleanA 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
trueif theevtis considered to be handled.
- releasedRecognizer - function(Object, EventArgs):boolean
The event recognizer that determines whether to finish moving the handle. This option sets the releasedRecognizer property on the created object.
Signature Details
function(eventSource: any, evt: EventArgs) : booleanA 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
trueif theevtis considered to be handled.
- pressedRecognizerTouch - function(Object, EventArgs):boolean
The event recognizer that determines whether to start moving the handle via touch. This option sets the pressedRecognizerTouch property on the created object.
Signature Details
function(eventSource: any, evt: EventArgs) : booleanA 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
trueif theevtis considered to be handled.
- draggedRecognizerTouch - function(Object, EventArgs):boolean
The event recognizer that determines whether to move the handle via touch. This option sets the draggedRecognizerTouch property on the created object.
Signature Details
function(eventSource: any, evt: EventArgs) : booleanA 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
trueif theevtis considered to be handled.
- releasedRecognizerTouch - function(Object, EventArgs):boolean
The event recognizer that determines whether to finish moving the handle via touch. This option sets the releasedRecognizerTouch property on the created object.
Signature Details
function(eventSource: any, evt: EventArgs) : booleanA 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
trueif theevtis considered to be handled.
- clickedRecognizer - function(Object, EventArgs):boolean
The event recognizer that determines whether a handle was clicked. This option sets the clickedRecognizer property on the created object.
Signature Details
function(eventSource: any, evt: EventArgs) : booleanA 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
trueif theevtis considered to be handled.
- clickedRecognizerTouch - function(Object, EventArgs):boolean
The event recognizer that determines whether a handle was tapped. This option sets the clickedRecognizerTouch property on the created object.
Signature Details
function(eventSource: any, evt: EventArgs) : booleanA 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
trueif theevtis considered to be handled.
- renderMode - RenderModes
The mode used to render the handles. This option sets the renderMode property on the created object.
- handles - IObservableCollection<IHandle>
- requestMutexOnPress - boolean
Whether to request the mutex when pressedRecognizer or pressedRecognizerTouch was triggered. This option sets the requestMutexOnPress property on the created object.
- snapContext - SnapContext
The snapContext which manages snapping model items to certain coordinates (for instance, other items). This option sets the snapContext property on the created object.
See Also
Properties
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 DragStarted event, as well as the DragFinished event to get notified of the elements that may be or have been affected respectively by this input mode.
Examples
mode.handleInputMode.addDragFinishedListener((sender, args) => {
for (const item of mode.handleInputMode.affectedItems) {
// these items have been moved
}
})See Also
Gets or sets the event recognizer that determines whether to cancel moving the handle.
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
Gets or sets the event recognizer that determines whether a handle was clicked.
Remarks
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
Gets or sets the event recognizer that determines whether a handle was tapped.
Remarks
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
Gets the installed controller.
Gets the handle that is currently being moved or null otherwise.
Gets or sets the event recognizer that determines whether to temporarily disable snapping.
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
See Also
Gets or sets the event recognizer that determines whether to move the handle.
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
Gets or sets the event recognizer that determines whether to move the handle via touch.
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
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
mode.handleInputMode.enabled = falseGets or sets the event recognizer that determines whether to reenable temporarily disabled snapping.
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
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.
Gets or sets the collection of IHandles this mode manages.
Gets the context instance this mode is currently installed in or null if this instance is not installed.
Remarks
Implements
Gets or sets the event recognizer that determines whether to start moving the handle.
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
Gets or sets the event recognizer that determines whether to start moving the handle via touch.
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
Gets the priority of this input mode.
Remarks
See Also
Implements
Gets or sets the event recognizer that determines whether to finish moving the handle.
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
Gets or sets the event recognizer that determines whether to finish moving the handle via touch.
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
Gets or sets the mode used to render the handles.
Remarks
Class.ensure(WebGL2GraphModelManager).Gets or sets whether to request the mutex when pressedRecognizer or pressedRecognizerTouch was triggered.
Remarks
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.See Also
Gets or sets the snapContext 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 snapContext from the IInputModeContext. To explicitly disable snapping, a snapContext implementation that does nothing has to be set to this instance.
Default is null.
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.
See Also
Methods
Factory method that creates and adds a handle to this mode by wrapping a given IMutablePoint instance.
Remarks
Parameters
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 - HandleTypes
- The type of the handle to create.
Returns
- ↪IHandle
- The handle created.
Method that can be used to initialize the dragging of a given handle by hand.
Remarks
Parameters
A map of options to pass to the method.
- handle - IHandle
- The handle to be dragged.
Returns
Called by the client to unconditionally cancel all editing.
Remarks
This will be called prior to the uninstalling of this instance.
In order to stop an active input mode manually, client code should use the following idiom:
if (!mode.tryStop()) {
mode.cancel()
}Implements
Creates an IInputModeContext for use with the IHandle interface for the upcoming drag operation.
Returns
- ↪IInputModeContext
- An instance of IInputModeContext.
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.
Creates the Visual for the given handle, if renderMode is set to SVG.
Parameters
A map of options to pass to the method.
- context - IRenderContext
- The context that describes where the visual will be used.
- handle - IHandle
- The handle to create a visual representation for.
Returns
Finds the closest hit handle for the given world coordinate pair.
Remarks
Parameters
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
See Also
Finds the closest hit handle for the given world coordinate pair.
Calls handleClick of the handle with the evt.
Remarks
Parameters
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.
Determines whether a given handle has been visually hit by the mouse at the given world coordinates.
Remarks
Parameters
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.
Returns
- ↪boolean
- Whether the handle has been hit.
Determines whether a given handle has been visually hit by the touch device at the given world coordinates.
Parameters
A map of options to pass to the method.
- handle - IHandle
- The handle to check
- location - Point
- The world coordinates to check.
- distance - Point
- The distance of the handle to the touch location. In the default implementation, this is a tuple representing the x- and y-distance of the handle to the touch location.
Returns
- ↪boolean
- Whether the handle has been hit.
Installs the visual representation of the handles into the canvas into the inputModeGroup.
Parameters
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 ConcurrencyController for this mode.
See Also
Implements
Invalidates the canvas this mode is currently installed in.
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.
Triggers the Clicked event.
Remarks
Parameters
A map of options to pass to the method.
- evt - ClickEventArgs
- The event argument that contains context information.
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.
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.
Triggers the DragCanceled event.
Parameters
A map of options to pass to the method.
- evt - InputModeEventArgs
- The event argument that contains context information.
Triggers the DragCanceling event.
Parameters
A map of options to pass to the method.
- evt - InputModeEventArgs
- The event argument that contains context information.
Triggered once the drag has been finalized.
Remarks
Parameters
A map of options to pass to the method.
- evt - InputModeEventArgs
- The event argument that contains context information.
Triggered before the drag will be finalized.
Remarks
Parameters
A map of options to pass to the method.
- evt - InputModeEventArgs
- The event argument that contains context information.
Triggered at the end of each drag.
Remarks
Parameters
A map of options to pass to the method.
- evt - InputModeEventArgs
- The event argument that contains context information.
Triggered at the start of each drag.
Remarks
Parameters
A map of options to pass to the method.
- evt - InputModeEventArgs
- The event argument that contains context information.
Triggers the DragStarted event.
Parameters
A map of options to pass to the method.
- evt - InputModeEventArgs
- The event argument that contains context information.
Triggers the DragStarting event.
Parameters
A map of options to pass to the method.
- evt - InputModeEventArgs
- The event argument that contains context information.
Raises the QueryClosestHandle event.
Parameters
A map of options to pass to the method.
- evt - QueryClosestHandleEventArgs
- The QueryClosestHandle instance containing the event data.
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.
Called by the client in order to stop a current editing progress.
Remarks
falseReturns
- ↪boolean
trueif and only if the editing has been stopped or there was no edit in progress
See Also
Implements
Removes the ICanvasObject that displays the handles from the canvas.
Parameters
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
Events
Occurs when a handle has been clicked.
Event Registration
addClickedListener(function(this, ClickEventArgs):void)Event Deregistration
removeClickedListener(function(this, ClickEventArgs):void)Signature Details
function(sender: this, evt: ClickEventArgs)
Parameters
- sender - this
- The source of the event.
- evt - ClickEventArgs
- An object that contains the event data.
Occurs when the drag has been canceled.
See Also
Event Registration
addDragCanceledListener(function(this, InputModeEventArgs):void)Event Deregistration
removeDragCanceledListener(function(this, InputModeEventArgs):void)Signature Details
function(sender: this, evt: InputModeEventArgs)
Parameters
- sender - this
- The source of the event.
- evt - InputModeEventArgs
- An object that contains the event data.
Occurs before the drag will be canceled.
See Also
Event Registration
addDragCancelingListener(function(this, InputModeEventArgs):void)Event Deregistration
removeDragCancelingListener(function(this, InputModeEventArgs):void)Signature Details
function(sender: this, evt: InputModeEventArgs)
Parameters
- sender - this
- The source of the event.
- evt - InputModeEventArgs
- An object that contains the event data.
Occurs once the drag has been finished.
Examples
mode.handleInputMode.addDragFinishedListener((sender, args) => {
for (const item of mode.handleInputMode.affectedItems) {
// these items have been moved
}
})See Also
Event Registration
addDragFinishedListener(function(this, InputModeEventArgs):void)Event Deregistration
removeDragFinishedListener(function(this, InputModeEventArgs):void)Signature Details
function(sender: this, evt: InputModeEventArgs)
Parameters
- sender - this
- The source of the event.
- evt - InputModeEventArgs
- An object that contains the event data.
Occurs before the drag will be finished.
See Also
Event Registration
addDragFinishingListener(function(this, InputModeEventArgs):void)Event Deregistration
removeDragFinishingListener(function(this, InputModeEventArgs):void)Signature Details
function(sender: this, evt: InputModeEventArgs)
Parameters
- sender - this
- The source of the event.
- evt - InputModeEventArgs
- An object that contains the event data.
Occurs at the end of every drag.
See Also
Event Registration
addDraggedListener(function(this, InputModeEventArgs):void)Event Deregistration
removeDraggedListener(function(this, InputModeEventArgs):void)Signature Details
function(sender: this, evt: InputModeEventArgs)
Parameters
- sender - this
- The source of the event.
- evt - InputModeEventArgs
- An object that contains the event data.
Occurs at the start of every drag.
See Also
Event Registration
addDraggingListener(function(this, InputModeEventArgs):void)Event Deregistration
removeDraggingListener(function(this, InputModeEventArgs):void)Signature Details
function(sender: this, evt: InputModeEventArgs)
Parameters
- sender - this
- The source of the event.
- evt - InputModeEventArgs
- An object that contains the event data.
Occurs once the drag is initialized and has started.
See Also
Event Registration
addDragStartedListener(function(this, InputModeEventArgs):void)Event Deregistration
removeDragStartedListener(function(this, InputModeEventArgs):void)Signature Details
function(sender: this, evt: InputModeEventArgs)
Parameters
- sender - this
- The source of the event.
- evt - InputModeEventArgs
- An object that contains the event data.
Occurs once the drag is starting.
See Also
Event Registration
addDragStartingListener(function(this, InputModeEventArgs):void)Event Deregistration
removeDragStartingListener(function(this, InputModeEventArgs):void)Signature Details
function(sender: this, evt: InputModeEventArgs)
Parameters
- sender - this
- The source of the event.
- evt - InputModeEventArgs
- An object that contains the event data.
Occurs when this mode queries the closest handle for a certain query location.
Remarks
Event Registration
addQueryClosestHandleListener(function(this, QueryClosestHandleEventArgs):void)Event Deregistration
removeQueryClosestHandleListener(function(this, QueryClosestHandleEventArgs):void)Signature Details
function(sender: this, evt: QueryClosestHandleEventArgs)
Parameters
- sender - this
- The source of the event.
- evt - QueryClosestHandleEventArgs
- An object that contains the event data.
Constants
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type DEFAULT.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-default-template CSS class and uses the theme's primaryColor as fill and backgroundColor as stroke.
See Also
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type DEFAULT | VARIANT2.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-default-variant2-template CSS class and uses the theme's backgroundColor as fill and primaryColor as stroke.
See Also
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type DEFAULT | VARIANT3.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-default-variant3-template CSS class and uses a light-gray stroke and a dark-gray fill.
See Also
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type DEFAULT | VARIANT4.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-default-variant4-template CSS class and uses a dark-gray stroke and a light-gray fill.
See Also
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type INVISIBLE.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-invisible-template CSS class.
See Also
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type INVISIBLE | VARIANT2.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-invisible-variant2-template CSS class.
See Also
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type INVISIBLE | VARIANT3.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-invisible-variant3-template CSS class.
See Also
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type INVISIBLE | VARIANT4.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-invisible-variant4-template CSS class.
See Also
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type MOVE.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-move-template CSS class and uses the theme's primaryColor as fill and backgroundColor as stroke.
See Also
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type MOVE | VARIANT2.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-move-variant2-template CSS class and uses the theme's backgroundColor as fill and primaryColor as stroke.
See Also
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type MOVE | VARIANT3.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-move-variant3-template CSS class and uses a light-gray stroke and a dark-gray fill.
See Also
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type MOVE | VARIANT4.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-move-variant4-template CSS class and uses a dark-gray stroke and a light-gray fill.
See Also
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type RESIZE.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-resize-template CSS class and uses visualizations based on the ThemeVariant of the current theme:
- CLASSIC – A rectangle filled with primaryColor and stroked with backgroundColor.
- SIMPLE_ROUND – A circle filled with backgroundColor and stroked with primaryColor.
- SIMPLE_SQUARE – A square filled with backgroundColor and stroked with primaryColor.
See Also
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type RESIZE | VARIANT2
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-resize-variant2-template CSS class and uses the theme's backgroundColor as fill and primaryColor as stroke.
See Also
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type RESIZE | VARIANT3.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-resize-variant3-template CSS class and uses a light-gray stroke and a dark-gray fill.
See Also
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type RESIZE | VARIANT4.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-resize-variant4-template CSS class and uses a dark-gray stroke and a light-gray fill.
See Also
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type ROTATE.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-rotate-template CSS class and uses the theme's primaryColor as fill and backgroundColor as stroke.
See Also
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type ROTATE | VARIANT2.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-rotate-variant2-template CSS class and uses the theme's backgroundColor as fill and primaryColor as stroke.
See Also
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type ROTATE | VARIANT3.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-rotate-variant3-template CSS class and uses a light-gray stroke and a dark-gray fill.
See Also
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type ROTATE | VARIANT4.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-drawing-variant4-template CSS class and uses a dark-gray stroke and a light-gray fill.
See Also
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type SHEAR.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-shear-template CSS class and uses the theme's primaryColor as fill and backgroundColor as stroke.
See Also
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type SHEAR | VARIANT2.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-shear-variant2-template CSS class and uses the theme's backgroundColor as fill and primaryColor as stroke.
See Also
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type SHEAR | VARIANT3.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-shear-variant3-template CSS class and uses a light-gray stroke and a dark-gray fill.
See Also
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type SHEAR | VARIANT4.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-shear-variant4-template CSS class and uses a dark-gray stroke and a light-gray fill.
See Also
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type WARP.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-warp-template CSS class and uses the theme's primaryColor as fill and backgroundColor as stroke.
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type WARP | VARIANT2.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-warp-variant2-template CSS class and uses the theme's backgroundColor as fill and primaryColor as stroke.
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type WARP | VARIANT3.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-warp-variant3-template CSS class and uses a light-gray stroke and a dark-gray fill.
A string that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type WARP | VARIANT4.
Remarks
The drawing returned should be centered around (0,0).
The element in the SVG defs has the yfiles-handle-warp-variant4-template CSS class and uses a dark-gray stroke and a light-gray fill.