C

CompositeEdgeStyle

Show Usages
A foundational implementation of IEdgeStyle that delegates its behavior to several style instances.

Remarks

This class can be used to combine multiple SVG-based style instances into one.

The following aspects will be delegated to all instances:

The following aspects will be delegated to the first/main style, only:

This class can be subclassed like EdgeStyleBase<TVisual> to allow for custom implementations of the various aspects of the delegation.

See Also

Developer's Guide

Members

Show:

Constructors

CompositeEdgeStyle

(mainStyle: IEdgeStyle, additionalStyles: IEdgeStyle)
Creates a new instance of this style.

Parameters

mainStyle: IEdgeStyle
The main style which will be rendered first and to which all requests will delegate to.
additionalStyles: IEdgeStyle
Additional styles which will be rendered on top and which will also be included in the hit-, visibility-, and bounds tests.

Properties

renderer

: IEdgeStyleRenderer
readonly
Gets the renderer implementation for this instance.
The private implementation will delegate all API calls back to this instance.
readonlyfinal

styles

: IList<IEdgeStyle>
readonly
Gets a readonly list of the styles used by this instance.
The first item is the main instance, and the others are the additional instances rendered on top in order. The list always has at least one member.
readonlyfinal

Methods

addArrows

(
context: IRenderContext
group: SVGGElement
edge: IEdge
edgePath: GeneralPath
sourceArrow: IArrow
targetArrow: IArrow
)
protected
Adds the arrows to a given container.
protected

Parameters

context: IRenderContext
The context for the rendering.
group: SVGGElement
The container to which the arrows should be added.
edge: IEdge
The edge that is being rendered.
edgePath: GeneralPath
The edge path.
sourceArrow: IArrow
The source arrow.
targetArrow: IArrow
The target arrow.

clone

(): Object
Returns a memberwise clone.
This will also clone the style instances.

Return Value

Object
A clone of this instance.

createVisual

(context: IRenderContext, edge: IEdge): Visual
protected
Creates the visual by delegating to all styles.
This implementation puts all Visuals of the styles into a single compound SvgVisualGroup.
protected

Parameters

context: IRenderContext
The render context.
edge: IEdge
The edge to which this style instance is assigned.

Return Value

Visual
The visual as required by the createVisual interface.

See Also

API
updateVisual

cropPath

(
edge: IEdge
sourceArrow: IArrow
targetArrow: IArrow
path: GeneralPath
): GeneralPath
protected
Crops the edge's path at the nodes.
This implementation uses the IEdgePathCropper instances found in the lookup of the source and target port of the edge to perform the actual cropping.
protected

Parameters

edge: IEdge
The edge that is being rendered.
sourceArrow: IArrow
The source arrow instance.
targetArrow: IArrow
The target arrow instance.
path: GeneralPath
The path that should be cropped.

Return Value

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

getBounds

(context: ICanvasContext, edge: IEdge): Rect
protected
Calculates the bounds as the union of bounds from all styles.
protected

Parameters

context: ICanvasContext
The canvas context.
edge: IEdge
The edge to which this style instance is assigned.

Return Value

Rect
The visual bounds of the visual representation.

getPath

(edge: IEdge): GeneralPath
protected
Gets the path from the first style as the reference.
protected

Parameters

edge: IEdge
The edge.

Return Value

GeneralPath
The path of the supplied edge.

getSegmentCount

(edge: IEdge): number
protected
Gets the segment count from the first style as the reference.
protected

Parameters

edge: IEdge
The edge.

Return Value

number
The segment count for the supplied edge.

getSourceArrowAnchor

(path: GeneralPath, arrow: IArrow): Tangent
protected
Calculates the source arrow anchor and direction for a given arrow and path.
protected

Parameters

path: GeneralPath
The path of the edge.
arrow: IArrow
The arrow.

Return Value

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

getTangent

(edge: IEdge, ratio: number): Tangent
protected
Determines the tangent for the first style as the reference.
protected

Parameters

edge: IEdge
The edge.
ratio: number
A value between 0 and 1 inclusively that indicates a ratio from the beginning to the end of the edge path.

Return Value

Tangent
The tangent, if it exists.

getTangentForSegment

(
edge: IEdge
segmentIndex: number
ratio: number
): Tangent
protected
Determines the tangent for the first style as the reference.
protected

Parameters

edge: IEdge
The edge.
segmentIndex: number
Index of the edge segment.
ratio: number
A value between 0 and 1 inclusively that indicates a ratio from the beginning to the end of the edge segment.

Return Value

Tangent
The tangent, if it exists.

getTargetArrowAnchor

(path: GeneralPath, arrow: IArrow): Tangent
protected
Calculates the target arrow anchor and direction for a given arrow and path.
protected

Parameters

path: GeneralPath
The path of the edge.
arrow: IArrow
The arrow.

Return Value

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

isHit

(
context: IInputModeContext
location: Point
edge: IEdge
): boolean
protected
Checks whether any style is hit at the given location.
protected

Parameters

context: IInputModeContext
The input mode context.
location: Point
The point to test.
edge: IEdge
The edge to which this style instance is assigned.

Return Value

boolean
true if the specified edge is hit; false otherwise.

isInBox

(
context: IInputModeContext
rectangle: Rect
edge: IEdge
): boolean
protected
Determines if the edge is in the box based on any style.
protected

Parameters

context: IInputModeContext
The input mode context.
rectangle: Rect
The marquee selection box.
edge: IEdge
The edge to which this style instance is assigned.

Return Value

boolean
true if the specified edge is visible and selected by the marquee rectangle; false otherwise.

isInPath

(
context: IInputModeContext
path: GeneralPath
edge: IEdge
): boolean
protected
Determines if the edge is in the path based on any style.
protected

Parameters

context: IInputModeContext
The input mode context.
path: GeneralPath
The lasso selection path.
edge: IEdge
The edge to which this style instance is assigned.

Return Value

boolean
true if the specified edge is visible and selected by the lasso path; false otherwise.

isVisible

(
context: ICanvasContext
rectangle: Rect
edge: IEdge
): boolean
protected
Determines visibility based on the visibility of all styles.
protected

Parameters

context: ICanvasContext
The canvas context.
rectangle: Rect
The clipping rectangle.
edge: IEdge
The edge to which this style instance is assigned.

Return Value

boolean
true if the specified edge is visible in the clipping rectangle; false otherwise.

lookup

(edge: IEdge, type: Constructor): any
protected
Performs a lookup using the first style as the reference.
protected

Parameters

edge: IEdge
The edge to use for the context lookup.
type: Constructor
The type to query.

Return Value

any
An implementation of the type or null.

updateArrows

(
context: IRenderContext
group: SVGGElement
edge: IEdge
edgePath: GeneralPath
sourceArrow: IArrow
targetArrow: IArrow
)
protected
Updates the arrows in a given container.
protected

Parameters

context: IRenderContext
The context for the rendering.
group: SVGGElement
The container to which the arrows should be added.
edge: IEdge
The edge that is being rendered.
edgePath: GeneralPath
The edge path.
sourceArrow: IArrow
The source arrow.
targetArrow: IArrow
The target arrow.

updateVisual

(
context: IRenderContext
oldVisual: Visual
edge: IEdge
): Visual
protected
Updates the visual by delegating to all styles.
This implementation updates all Visual of the styles from a single compound SvgVisualGroup.
protected

Parameters

context: IRenderContext
The render context.
oldVisual: Visual
The visual that has been created in the call to createVisual.
edge: IEdge
The edge to which this style instance is assigned.

Return Value

Visual
The visual as required by the createVisual interface.

See Also

API
createVisual