Interface that is used mainly by IEdgeStyleRenderer implementations to reveal geometric details about the visualization of an edge's path.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.styles.IPathGeometry
See Also
Methods
Returns a representation of the visible path of the edge in form of a GeneralPath
Returns
- ↪GeneralPath
- An instance that describes the visible path or
nullif this is not applicable for the current geometry.
Calculates the tangent on the edge's path at the given ratio point.
Remarks
Parameters
A map of options to pass to the method.
- ratio - number
- a value in [0,1] where 0 is the source's end and 1 is at the target's end of the visible edge path
Returns
- ↪Tangent
- The tangential line, if any exists.
Calculates the tangent on the edge's path at the given ratio point for the given segment.
Remarks
Parameters
A map of options to pass to the method.
- segmentIndex - number
- the segment to use for the calculation
- ratio - number
- a value in [0,1] where 0 is the source's end and 1 is at the target's end of the segment
Returns
- ↪Tangent
- The tangential line, if any exists.
See Also
Static Methods
Creates an implementation of the interface IPathGeometry from the given definition.
Remarks
Parameters
A map of options to pass to the method.
- getTangent - function(number):Tangent
Calculates the tangent on the edge's path at the given ratio point.
This property holds the implementation for getTangent.
- getTangentForSegment - function(number, number):Tangent
Calculates the tangent on the edge's path at the given ratio point for the given segment.
This property holds the implementation for getTangentForSegment.
- getSegmentCount - function():number
Returns the number of "segments" this edge's path consists of.
This property holds the implementation for getSegmentCount.
- getPath - function():GeneralPath
Returns a representation of the visible path of the edge in form of a GeneralPath
This property holds the implementation for getPath.
Returns
- ↪IPathGeometry
- An instance of the IPathGeometry interface based on the given definition.