PathBasedEdgeStyleRenderer<TStyleextends IEdgeStyle>

Gets or sets a value indicating whether the first and last segments of the path should always begin and end with a straight line segment, respectively.

Remarks

Given high enough values for getSmoothingLength, the first and last segments may become completely curved. This property prevents this from happening, e.g. to prevent arrowheads from colliding with the smoothed edge path.

The default value is false.

style

: TStyle

Gets or sets the currently configured style.

Methods

configure

()

Prepares this instance for subsequent calls after the style and edge have been initialized.

Remarks

Upon invocation the style and edge properties have been populated by the getVisualCreator, getBoundsProvider, getHitTestable, or getMarqueeTestable methods.

Subclasses which override this method have to call the base implementation, first.

createPath

() : GeneralPath

This method should create the basic uncropped path given the control points.

Returns

↪GeneralPath: A path that has to be cropped, yet.

createSelfLoopPath

(roundSelfLoop: boolean) : GeneralPath

Special implementation that will create a self loop path.

Remarks

Called if the edge has the same source and target port owner and less than two bends. The returned path ends at the source and target ports and will be cropped at the node bounds later.

Parameters

options - Object
A map of options to pass to the method.

roundSelfLoop - boolean: Whether to create a round self loop path. If false a rectangular path will be created.

Returns

↪GeneralPath: A path for a self loop.

createVisual

(context: IRenderContext) : Visual

This method is called by the framework to create a Visual that will be included into the IRenderContext.

Remarks

CanvasComponent uses this interface through the ICanvasObjectDescriptor to populate the visual canvas object tree.

Parameters

options - Object
A map of options to pass to the method.

context - IRenderContext: The context that describes where the visual will be used.

Returns

↪Visual: The visual to include in the canvas object visual tree. This may be null.

Implements

IVisualCreator

cropPath

(path: GeneralPath) : GeneralPath

Crops the edge's path at the nodes.

Remarks

This implementation uses the IEdgePathCropper instances found in the lookup of the source and target port of the edge to perform the actual cropping.

Parameters

options - Object
A map of options to pass to the method.

path - GeneralPath: The path that should be cropped.

Returns

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

getBounds

(context: ICanvasContext) : Rect

Returns a tight rectangular area where the whole rendering would fit into.

Remarks

If calculating the bounds is too expensive or the rendering is not bound to a certain area, this method may return INFINITE. If nothing is rendered, this method should return an empty rectangle, where either or both the width and height is non-positive or EMPTY.

Parameters

options - Object
A map of options to pass to the method.

context - ICanvasContext: the context to calculate the bounds for

Returns

↪Rect: the bounds or EMPTY to indicate an unbound area

Implements

IBoundsProvider

getBoundsProvider

(edge: IEdge, style: IEdgeStyle) : IBoundsProvider

Configures the style and edge parameters, calls configure and returns this.

Parameters

options - Object
A map of options to pass to the method.

edge - IEdge: The edge to retrieve the bounds provider for. The value will be stored in the edge property.
style - IEdgeStyle: The style to associate with the edge. The value will be stored in the style property.

Remarks

The return value of this method (which may be null) will be passed to the BridgeManager's addBridges method.

Returns

↪IBridgeCreator: This implementation returns null.

getContext

(edge: IEdge, style: IEdgeStyle) : ILookup

Configures the style and edge parameters, does not call configure and returns this.

Remarks

As this method may be called often it will not automatically call configure, instead subclasses should ensure that in the lookup method call they should call configure only if needed, i.e. if they decide to return this or an instance that depends on a correctly configured this.

Parameters

options - Object
A map of options to pass to the method.

edge - IEdge: The edge to query the context for. The value will be stored in the edge property.
style - IEdgeStyle: The style to associate with the edge. The value will be stored in the style property.

Returns

↪ILookup: this

Implements

IEdgeStyleRenderer

getCssClass

() : string

Gets the CSS class that will be applied to the edge visualization.

Remarks

This implementation retrieves the CSS class from the owning style.

Returns

↪string: The CSS class that is currently used by this renderer.

getHitTestable

(edge: IEdge, style: IEdgeStyle) : IHitTestable

Configures the style and edge parameters and returns this.

Remarks

This implementation does not call configure. If subclasses depend on a configured instance in an override of isHit, they need to override this method, too and call configure if the base call returns a non-null value.

Parameters

options - Object
A map of options to pass to the method.

edge - IEdge: The edge to provide an instance for
style - IEdgeStyle: The style to use for the querying hit tests

Returns

↪IHitTestable: An implementation that may be used to subsequently perform hit tests. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations. This method may return null to indicate that the edge cannot be hit tested.

Implements

IEdgeStyleRenderer

getMarqueeTestable

(edge: IEdge, style: IEdgeStyle) : IMarqueeTestable

Configures the style and edge parameters, calls configure and returns this.

Parameters

options - Object
A map of options to pass to the method.

edge - IEdge: The edge to query marquee intersection tests. The value will be stored in the edge property.
style - IEdgeStyle: The style to associate with the edge. The value will be stored in the style property.

Returns

↪IMarqueeTestable: this

Implements

IEdgeStyleRenderer

getObstacles

(context: IRenderContext) : GeneralPath

Returns createPath unless isVisible yields false for the provided context and clip.

Parameters

options - Object
A map of options to pass to the method.

context - IRenderContext: The context to yield the obstacles for.

Returns

↪GeneralPath: Either null or the result of createPath.

Implements

IObstacleProvider

getPath

() : GeneralPath

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 null if this is not applicable for the current geometry.

Implements

IPathGeometry

getPathGeometry

(edge: IEdge, style: IEdgeStyle) : IPathGeometry

Gets an implementation of the IPathGeometry interface that can handle the provided edge and its associated style.

Parameters

options - Object
A map of options to pass to the method.

edge - IEdge: The edge to provide an instance for
style - IEdgeStyle: The style to use for the painting

Returns

↪IPathGeometry: this

Implements

IEdgeStyleRenderer

getSegmentCount

() : number

Returns the number of "segments" this edge's path consists of.

Remarks

This method is part of the IPathGeometry interface, that is implemented by this class. This interface will be returned by getPathGeometry.

Returns

↪number: the number of segments or -1 if there is no such thing as a segment for this edge.

Implements

IPathGeometry

getSmoothingLength

() : number

Gets the value that determines the radius of the smoothing arcs that can be added to the path at the bends.

Remarks

This implementation returns 0.0d, which effectively turns off path smoothing.

Returns

↪number: The radius of the arcs to use at the bends of the path.

getSourceArrow

() : IArrow

Gets the source arrow from the style.

Returns

↪IArrow: The arrow to use.

getSourceArrowAnchor

(arrow: IArrow) : Tangent

Calculate and update the anchor and the source arrow's direction vector.

Parameters

options - Object
A map of options to pass to the method.

arrow - IArrow: The arrow to calculate the anchor for.

Returns

↪Tangent: The anchor and directional vector of the arrow, if any exist.

getStroke

() : Stroke

Gets the Stroke to use to render the path.

Returns

↪Stroke: The Stroke or null.

getTangent

(ratio: number) : Tangent

Calculates the tangent on the edge's path at the given ratio point.

Remarks

This method is part of the IPathGeometry interface, that is implemented by this class. This interface will be returned by getPathGeometry.

Parameters

options - Object
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.

Implements

IPathGeometry

getTangentForSegment

(segmentIndex: number, ratio: number) : Tangent

Calculates the tangent on the edge's path at the given ratio point for the given segment.

Remarks

This method is part of the IPathGeometry interface, that is implemented by this class. This interface will be returned by getPathGeometry.

Parameters

options - Object
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.

Implements

IPathGeometry

getTargetArrow

() : IArrow

Gets the target arrow from the style.

Returns

↪IArrow: The arrow to use.

getTargetArrowAnchor

(arrow: IArrow) : Tangent

Calculate and update the anchor and the target arrow's direction vector.

Parameters

options - Object
A map of options to pass to the method.

arrow - IArrow: The arrow to calculate the anchor for.

Returns

↪Tangent: The anchor and directional vector of the arrow, if any exist.

getVisibilityTestable

(edge: IEdge, style: IEdgeStyle) : IVisibilityTestable

Configures the style and edge parameters, does not call configure and returns this.

Remarks

Unlike most of the other methods this implementation does not call configure. If the subclass implementation depends on this instance to be configured, it needs to call Configure in isVisible.

Parameters

options - Object
A map of options to pass to the method.

edge - IEdge: The edge to query visibility tests. The value will be stored in the edge property.
style - IEdgeStyle: The style to associate with the edge. The value will be stored in the style property.

Returns

↪IVisibilityTestable: this

Implements

IEdgeStyleRenderer

getVisualCreator

(edge: IEdge, style: IEdgeStyle) : IVisualCreator

Configures the style and edge parameters, calls configure and returns this.

Parameters

options - Object
A map of options to pass to the method.

edge - IEdge: The edge to retrieve the IVisualCreator for. The value will be stored in the edge property.
style - IEdgeStyle: The style to associate with the edge. The value will be stored in the style property.

Returns

↪IVisualCreator: this

Implements

IEdgeStyleRenderer

isHit

(context: IInputModeContext, location: Point) : boolean

This method is overridden for performance reasons.

Remarks

This implementation uses isVisible as an early exit indicator. If isVisible returns false for a certain rectangle, the instance will not be configured but a non-hit will be assumed. Otherwise this instance will be configured and the standard path based hit test routine

Subclasses should not depend on the fact that configure has already been called. This may not be the case. If your subclass depends on Configure being called, override getHitTestable and call configure after the base class call.

Parameters

options - Object
A map of options to pass to the method.

context - IInputModeContext: the context the hit test is performed in
location - Point: the coordinates in world coordinate system

Returns

↪boolean: whether something has been hit

Implements

IHitTestable

isInBox

(context: IInputModeContext, rectangle: Rect) : boolean

Returns true if the corresponding item is considered to intersect the given rectangular box.

Remarks

This method may return false if the item cannot be selected using a selection marquee or optionally if the item is only partially contained within the box.

Implementations should respect the hitTestRadius if marquee selections should behave differently on different zoom levels.

Parameters

options - Object
A map of options to pass to the method.

context - IInputModeContext: the current input mode context
rectangle - Rect: the box describing the marquee's bounds

Returns

↪boolean: true if the item is considered to be captured by the marquee

Implements

IMarqueeTestable

isInPath

(context: IInputModeContext, path: GeneralPath) : boolean

Returns true if the corresponding item is considered to intersect the given path.

Remarks

This method may return false if the item cannot be selected using a lasso selection or optionally if the item is only partially contained within the path.

Implementations should respect the hitTestRadius if lasso selections should behave differently on different zoom levels.

Parameters

options - Object
A map of options to pass to the method.

context - IInputModeContext: the current input mode context
path - GeneralPath: the path describing the lasso selection bounds

Returns

↪boolean: true if the item is considered to be captured by the lasso

Implements

ILassoTestable

isVisible

(context: ICanvasContext, rectangle: Rect) : boolean

Calls configure and test the edge using the style for a visible intersection with the clip bounds.

Remarks

This implementation uses getBounds to determine the visibility. Subclasses may choose to override this behavior for improved performance but need to make sure to call configure if they depend on a configured instance.

Parameters

options - Object
A map of options to pass to the method.

context - ICanvasContext: the current canvas context
rectangle - Rect: the clip bounds

Returns

↪boolean: true if the edge may be painted within the clip bounds.

Implements

IVisibilityTestable

lookup

<Textends any>(type: Class<T>) : T

Returns an instance that implements the given type or null.

Remarks

Typically, this method will be called in order to obtain a different view or aspect of the current instance. This is quite similar to casting or using a super type or interface of this instance, but is not limited to inheritance or compile time constraints. An instance implementing this method is not required to return non-null implementations for the types, nor does it have to return the same instance any time. Also it depends on the type and context whether the instance returned stays up to date or needs to be reobtained for subsequent use.

Type Parameters

T: any

Parameters

options - Object
A map of options to pass to the method.

type - Class<T>: The type for which an instance shall be returned.

Returns

↪T: an instance that is assignable to type or null

Implements

ILookup

updateVisual

(context: IRenderContext, oldVisual: Visual) : Visual

This method updates or replaces a previously created Visual for inclusion in the IRenderContext.

Remarks

The CanvasComponent uses this method to give implementations a chance to update an existing Visual that has previously been created by the same instance during a call to createVisual. Implementation may update the oldVisual and return that same reference, or create a new visual and return the new instance or null.

I most cases oldVisual is a visual instance that has been returned by the createVisual method of this instance. This is, however, not guaranteed. Implementations have to be aware of this.

Parameters

options - Object
A map of options to pass to the method.

context - IRenderContext: The context that describes where the visual will be used in.
oldVisual - Visual: The visual instance to be updated.

Returns

↪Visual: oldVisual, if this instance modified the visual, or a new visual that should replace the existing one in the canvas object visual tree.

Implements

IVisualCreator

Fields

path

: GeneralPath

The path instance that this instance is working with.

Static Methods

createRectangleSelfLoop

(sx: number, sy: number, oppositeX: number, oppositeY: number, tx: number, ty: number) : GeneralPath

Creates a rectangular self loop path.

Parameters

options - Object
A map of options to pass to the method.

sx - number: The x coordinate of the source port.
sy - number: The y coordinate of the source port.
oppositeX - number: The x coordinate of the single control point.
oppositeY - number: The y coordinate of the single control point.
tx - number: The x coordinate of the target port.
ty - number: The y coordinate of the target port.

Returns

↪GeneralPath: A path that describes a rectangular self loop.

createRectangleSelfLoop

(coordinates: number[]) : GeneralPath

Creates a rectangular self loop path.

Parameters

options - Object
A map of options to pass to the method.

coordinates - number[]: The coordinates of the path points, alternating x and y values.

createRoundSelfLoop

(sx: number, sy: number, oppositeX: number, oppositeY: number, tx: number, ty: number) : GeneralPath

Creates a round self loop path.

Parameters

options - Object
A map of options to pass to the method.

sx - number: The x coordinate of the source port.
sy - number: The y coordinate of the source port.
oppositeX - number: The x coordinate of the single control point.
oppositeY - number: The y coordinate of the single control point.
tx - number: The x coordinate of the target port.
ty - number: The y coordinate of the target port.

Returns

↪GeneralPath: A path that describes a round self loop.

PathBasedEdgeStyleRenderer<TStyleextends IEdgeStyle>

Type Parameters

Type Details

See Also

Constructors