A specialized SnapLine that is parallel to an edge segment and stores that edge.
Remarks
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.input.EdgeSegmentSnapLine
Constructors
EdgeSegmentSnapLine
(edge: IEdge, segmentSource: Point, segmentTarget: Point, distance: number, segmentIndex: number)Initializes a new instance of the PointBasedSnapLine class.
Parameters
A map of options to pass to the method.
- edge - IEdge
- The edge to assign to edge.
- segmentSource - Point
- The location that represents the source of the related segment on this line. In addition, this location is used as from location.
- segmentTarget - Point
- The location that represents the target of the related segment on this line. In addition, this location is used as to location.
- distance - number
- The distance of this snap line from its related edge segment.
- segmentIndex - number
- The segment index of the related edge segment.
EdgeSegmentSnapLine
(edge: IEdge, from: Point, to: Point, segmentSource: Point, segmentTarget: Point, distance: number, segmentIndex: number, tag: Object, weight: number)Initializes a new instance of the PointBasedSnapLine class.
Parameters
A map of options to pass to the method.
- edge - IEdge
- The edge to assign to edge.
- from - Point
- The first location that delimits this snap line.
- to - Point
- The second location that delimits this snap line.
- segmentSource - Point
- The location that represents the source of the related segment on this line.
- segmentTarget - Point
- The location that represents the target of the related segment on this line.
- distance - number
- The distance of this snap line from its related edge segment.
- segmentIndex - number
- The segment index of the related edge segment.
- tag - Object
- A tag that is associated with this snap line.
- weight - number
- The weight (importance) of this snap line.
Properties
Gets the direction vector of this snap line.
Gets the edge that is associated with this snap line.
Gets the location that represents the source of the related segment on this line.
Gets the location that represents the target of the related segment on this line.
Gets or sets the location of the source marker of this snap line.
Remarks
null, the location of the segmentSource is marked instead.Gets the tag that is associated with this snap line.
Gets or sets the location of the target marker of this snap line.
Remarks
null, the location of the segmentTarget is marked instead.Gets the visualization type which determines the visual appearance of the snap line.
Defined in
Gets the weight/importance of this snap line.