Interface for a handle that can be displayed in a CanvasComponent as a UI element for the user to modify the contents of the control.
Remarks
Related Programming Samples
- Reshape Handle Provider Configuration
- Shows how resizing of nodes can be customized.
- Reshape Handle Provider
- Shows how to add resize handles to ports.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.input.IHandle
See Also
Properties
Gets a view of the location of the item.
Remarks
Defined in
Gets the type of the handle that can be used by the rendering engine to render types differently.
See Also
Methods
Called by clients to indicate that the dragging has been canceled by the user.
Remarks
Parameters
A map of options to pass to the method.
- context - IInputModeContext
- The context to retrieve information about the drag from.
- originalLocation - Point
- The value of the coordinate of the location property at the time of initializeDrag.
See Also
Defined in
Called by clients to indicate that the repositioning has just been finished.
Remarks
Parameters
A map of options to pass to the method.
- context - IInputModeContext
- The context to retrieve information about the drag from.
- originalLocation - Point
- The value of the location property at the time of initializeDrag.
- newLocation - Point
- The coordinates in the world coordinate system that the client wants the handle to be at. Depending on the implementation the location may or may not be modified to reflect the new value. This is the same value as delivered in the last invocation of handleMove
See Also
Defined in
Called to indicate that the handle has been clicked by the user.
Remarks
This method is called by HandleInputMode when clickedRecognizer or clickedRecognizerTouch is triggered.
Changing the cursor or type of the clicked handle will instantly be considered by the HandleInputMode but handles won't be requeried automatically. If for example different handles should be used as a result of the click, requeryHandles has to be called.
Parameters
A map of options to pass to the method.
- evt - ClickEventArgs
- Arguments describing the click.
See Also
Called by clients to indicate that the element has been dragged and its position should be updated.
Remarks
Parameters
A map of options to pass to the method.
- context - IInputModeContext
- The context to retrieve information about the drag from.
- originalLocation - Point
- The value of the location property at the time of initializeDrag.
- newLocation - Point
- The coordinates in the world coordinate system that the client wants the handle to be at. Depending on the implementation the location may or may not be modified to reflect the new value.
See Also
Defined in
Called by clients to indicate that the element is going to be dragged.
Remarks
Parameters
A map of options to pass to the method.
- context - IInputModeContext
- The context to retrieve information about the drag from.
See Also
Defined in
Static Methods
Creates an implementation of the interface IHandle from the given definition.
Remarks
Parameters
A map of options to pass to the method.
- handleClick - function(ClickEventArgs):void
Called to indicate that the handle has been clicked by the user.
This property holds the implementation for handleClick.
- initializeDrag - function(IInputModeContext):void
Called by clients to indicate that the element is going to be dragged.
This property holds the implementation for initializeDrag.
- handleMove - function(IInputModeContext, Point, Point):void
Called by clients to indicate that the element has been dragged and its position should be updated.
This property holds the implementation for handleMove.
- cancelDrag - function(IInputModeContext, Point):void
Called by clients to indicate that the dragging has been canceled by the user.
This property holds the implementation for cancelDrag.
- dragFinished - function(IInputModeContext, Point, Point):void
Called by clients to indicate that the repositioning has just been finished.
This property holds the implementation for dragFinished.
- type - HandleTypes
Gets the type of the handle that can be used by the rendering engine to render types differently.
This property holds the implementation for type.
- cursor - Cursor
Gets the cursor to display when the mouse hovers over or drags this handle.
This property holds the implementation for cursor.
- location - IPoint
Gets a view of the location of the item.
This property holds the implementation for location.