The default implementation of the INodeReshapeSnapResultProvider interface.
Inheritance Hierarchy
NodeReshapeSnapResultProvider
Implemented Interfaces
Type Details
- yFiles module
- view
Methods
collectGridSnapResults
(context: GraphSnapContext, evt: CollectSnapResultsEventArgs, snapGrid: SnapGrid, node: INode, reshapeContext: ReshapeRectangleContext, suggestedLayout: Rect)Collects the snap results for the grid.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- context - GraphSnapContext
- The context in which the snapping is performed.
- evt - CollectSnapResultsEventArgs
- The CollectSnapResultsEventArgs instance containing the event data.
- snapGrid - SnapGrid
- The snap reference containing data about the grid.
- node - INode
- The node that is being reshaped.
- reshapeContext - ReshapeRectangleContext
- The reshape context that describes how the node's layout is reshaped.
- suggestedLayout - Rect
- The suggested layout of the node.
collectOrthogonalLineSnapResults
(context: GraphSnapContext, evt: CollectSnapResultsEventArgs, snapLine: OrthogonalSnapLine, node: INode, reshapeContext: ReshapeRectangleContext, suggestedLayout: Rect)Collects the snap results that make the node's bounds snap to the snapLine.
Remarks
This method ultimately delegates to collectReshapeSnapResult to create the results to add to the event argument.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- context - GraphSnapContext
- The context in which the snapping is performed.
- evt - CollectSnapResultsEventArgs
- The CollectSnapResultsEventArgs instance containing the event data.
- snapLine - OrthogonalSnapLine
- The snap line to snap to.
- node - INode
- The node that is being reshaped.
- reshapeContext - ReshapeRectangleContext
- The reshape context that contains information about the nature of the resize.
- suggestedLayout - Rect
- The layout of the node as it would be if the mouse location would not be snapped.
collectSameSizeSnapResults
(context: GraphSnapContext, evt: CollectSnapResultsEventArgs, snapSize: SnapSize, node: INode, reshapeContext: ReshapeRectangleContext, suggestedLayout: Rect)Collects the snap results that make the node the same size as other elements.
Remarks
This method ultimately delegates to collectReshapeSnapResult to create the results to add to the event argument.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- context - GraphSnapContext
- The context in which the snapping is performed.
- evt - CollectSnapResultsEventArgs
- The CollectSnapResultsEventArgs instance containing the event data.
- snapSize - SnapSize
- The snap reference containing data about nodes with same sizes.
- node - INode
- The node that is being reshaped.
- reshapeContext - ReshapeRectangleContext
- The reshape context that contains information about the nature of the resize.
- suggestedLayout - Rect
- The layout of the node as it would be if the mouse location would not be snapped.
collectSnapResults
(context: GraphSnapContext, evt: CollectSnapResultsEventArgs, node: INode, reshapeContext: ReshapeRectangleContext)Called when a node is dragged to add SnapResults for SnapReferences to which this node can potentially snap during resizing.
Remarks
This implementation delegates to the following methods:
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- context - GraphSnapContext
- The snap context which manages the snap references and the settings.
- evt - CollectSnapResultsEventArgs
- The event argument to obtain the context from and add the results to.
- node - INode
- The node that is being reshaped.
- reshapeContext - ReshapeRectangleContext
- Carries information about the reshape process.
Implements
Constants
A shared singleton instance of this type.