An ISnapReferenceProvider implementation that can be used to add snap lines for orthogonally routed IEdges.
Remarks
Type Details
- yFiles module
- view
See Also
Constructors
Methods
addHorizontalSegmentSnapLines
(context: GraphSnapContext, evt: CollectSnapReferencesEventArgs, segmentStart: Point, segmentEnd: Point)Adds horizontal snap lines for a horizontally oriented fixed segment snap lines.
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 which holds the settings for the snap lines. Note that implementations should not change the state of the context explicitly.
- evt - CollectSnapReferencesEventArgs
- The argument to use for adding snap lines.
- segmentStart - Point
- The start of the segment.
- segmentEnd - Point
- The end of the segment.
See Also
Adds the snap lines for the edge to the evt.
Remarks
This implementation queries the movement information for the edge to determine which edge segments stay fixed. For each fixed segment, it will call addVerticalSegmentSnapLines or addHorizontalSegmentSnapLines respectively.
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 which holds the settings for the snap lines. Note that implementations should not change the state of the context explicitly.
- evt - CollectSnapReferencesEventArgs
- The argument to use for adding snap lines.
Implements
addVerticalSegmentSnapLines
(context: GraphSnapContext, evt: CollectSnapReferencesEventArgs, segmentStart: Point, segmentEnd: Point)Adds vertical snap lines for a vertically oriented fixed segment snap lines.
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 which holds the settings for the snap lines. Note that implementations should not change the state of the context explicitly.
- evt - CollectSnapReferencesEventArgs
- The argument to use for adding snap lines.
- segmentStart - Point
- The start of the segment.
- segmentEnd - Point
- The end of the segment.
See Also
Fields
The edge this provider was created for.