A specialized OrthogonalSnapLine that stores two nodes as additional information that can be used for the visualization.
Inheritance Hierarchy
SnapLine
OrthogonalSnapLine
NodePairBasedSnapLine
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.input.NodePairBasedSnapLine
See Also
Constructors
NodePairBasedSnapLine
(firstNode: INode, secondNode: INode, orientation: SnapLineOrientation, snapType: SnapLineSnapTypes, visualizationType: SnapLineVisualizationType, coordinates: Point, tag: Object, weight: number)Initializes a new instance of the NodePairBasedSnapLine class.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- firstNode - INode
- The first node to assign to firstNode.
- secondNode - INode
- The second node to assign to secondNode.
- orientation - SnapLineOrientation
- The orientation of the snap line. This is one of HORIZONTAL or VERTICAL.
- snapType - SnapLineSnapTypes
- visualizationType - SnapLineVisualizationType
- The type of the visual representation of this snap line.
- coordinates - Point
- The coordinates of the center point of the snap line.
- tag - Object
- A tag that is associated with this snap line - see tag for a typical use of this value.
- weight - number
- The weight (importance) of this snap line. If more than one snap line is snapped to, the one with the greater weight will be used.
NodePairBasedSnapLine
(firstNode: INode, secondNode: INode, orientation: SnapLineOrientation, snapType: SnapLineSnapTypes, visualizationType: SnapLineVisualizationType, coordinates: Point, from: number, to: number, tag: Object, weight: number)Initializes a new instance of the NodePairBasedSnapLine class.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- firstNode - INode
- The first node to assign to firstNode.
- secondNode - INode
- The second node to assign to secondNode.
- orientation - SnapLineOrientation
- The orientation of the snap line. This is one of HORIZONTAL or VERTICAL.
- snapType - SnapLineSnapTypes
- visualizationType - SnapLineVisualizationType
- The type of the visual representation of this snap line.
- coordinates - Point
- The coordinates of the center point of the snap line.
- from - number
- The smaller value of the coordinate that delimits this snap line.
- to - number
- The greater value of the coordinate that delimits this snap line.
- tag - Object
- A tag that is associated with this snap line - see tag for a typical use of this value.
- weight - number
- The weight (importance) of this snap line. If more than one snap line is snapped to, the one with the greater weight will be used.
Properties
Gets the first node that is associated with this snap line.
Remarks
Usually this is one of the instances that induced this snap line.
Gets the orientation of the snap line.
Gets the second node that is associated with this snap line.
Remarks
Usually this is one of the instances that induced this snap line.
Gets the tag that is associated with this snap line.
Gets the visualization type which determines the visual appearance of the snap line.
Defined in
Gets the weight/importance of this snap line.