I

IEdgePathCropper

Show Usages
Interface used by the framework mainly for calculating the visible path of an edge.
Inheritance Hierarchy

Remarks

This interface is queried through the lookup of IPort instances to calculate the visible portion of an edge path.

It is rarely needed to implement this interface. Custom styles based on EdgeStyleBase<TVisual> should call cropPath to crop the edge path. For custom cropping it is sufficient in most cases to use a configured EdgePathCropper instance.

See Also

API

EdgePathCropper, cropPath

Demos

Customize where edges at the node are cropped
Crop the edge at the port outline

Members

No filters for this type

Methods

cropEdgePath

(
edge: IEdge
atSource: boolean
arrow: IArrow
path: GeneralPath
): GeneralPath
abstract
Crops the provided path at one end of an edge.
abstract

Parameters

edge: IEdge
The edge whose path is to be cropped.
atSource: boolean
Whether to crop the source or target side of the path.
arrow: IArrow
The arrow that is used at the end of the edge.
path: GeneralPath
The path to crop.

Return Value

GeneralPath
The cropped path. This can be either the same instance of the given path or a newly created instance.

Constants

INSTANCE

: IEdgePathCropper
static
A singleton that implements the same cropping behavior as EdgePathCropper and is immutable.

It crops an edge's path at the node bounds of the source or target side with respect to the given arrow.

Note that this instance cannot be cast to the EdgePathCropper type.

static

Static Methods

create

(cropEdgePath: function(IEdge, boolean, IArrow, GeneralPath): GeneralPath): IEdgePathCropper
static
static

Parameters

cropEdgePath: function(IEdge, boolean, IArrow, GeneralPath): GeneralPath

Return Value

IEdgePathCropper