C

EdgeSnapReferenceProvider

Show Usages
An ISnapReferenceProvider implementation that can be used to add snap lines for orthogonally routed IEdges.
ImplementsInheritance Hierarchy

Remarks

This implementation can be put into the lookup of an IEdge.

See Also

API

snapReferenceProvider

Members

Show:

Constructors

EdgeSnapReferenceProvider

(edge: IEdge)
Creates a new provider for the given edge.

Parameters

edge: IEdge
The edge to provide snap references for.

Methods

addHorizontalSegmentSnapLines

(
context: GraphSnapContext
evt: CollectSnapReferencesEventArgs
segmentStart: Point
segmentEnd: Point
)
protected
Adds horizontal snap lines for a horizontally oriented fixed segment snap lines.
protected

Parameters

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

API
addVerticalSegmentSnapLines

addSnapReferences

(context: GraphSnapContext, evt: CollectSnapReferencesEventArgs)
Adds the snap lines for the edge to the evt.
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

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.

addVerticalSegmentSnapLines

(
context: GraphSnapContext
evt: CollectSnapReferencesEventArgs
segmentStart: Point
segmentEnd: Point
)
protected
Adds vertical snap lines for a vertically oriented fixed segment snap lines.
protected

Parameters

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

API
addHorizontalSegmentSnapLines

Fields

edge

: IEdge
protected
The edge this provider was created for.
protectedfinal