C

WebGLBridgeEdgeStyle

Show Usages
A 3-segment edge style for use in WebGL2 rendering.
ImplementsInheritance Hierarchy

Remarks

Note that unlike other IEdgeStyle implementations, this class is immutable. All properties are read-only and immutable, and the class cannot be subclassed, either.

See Also

Developer's Guide

API

WebGLArcEdgeStyle, WebGLPolylineEdgeStyle

Members

No filters for this type

Constructors

WebGLBridgeEdgeStyle

(
height?: number
fanLength?: number
stroke?: WebGLStroke
sourceArrow?: WebGLArrowType
targetArrow?: WebGLArrowType
selfLoopDistance?: number
effect?: WebGLEffect
)
Creates a new 3-segment bridge edge style that is rendered with WebGL2.

This style can be applied to edges that are rendered by the WebGLGraphModelManager. The preferred way of calling the constructor is using option arguments, as there are many defaults and optional arguments.

To use the default value for a color option, set it to null.

Parameters

height?: number
The deviation of the bridge from the straight-line. Defaults to 0.
fanLength?: number
The value for the fanLength property. Defaults to 0.2.
stroke?: WebGLStroke
The color and thickness of the edge. Defaults to BLACK.
sourceArrow?: WebGLArrowType
The arrow at the edge's source end. Defaults to NONE.
targetArrow?: WebGLArrowType
The arrow at the edge's target end. Defaults to NONE.
selfLoopDistance?: number
The distance between the node's layout and its self-loop control points. Defaults to 20.
effect?: WebGLEffect
The effect around the edge. Defaults to NONE.

Properties

effect

: WebGLEffect
readonly
Gets the applied effects on this style.
readonlyfinal

fanLength

: number
readonly
Gets the length of the "fan" part of the style.

This is not the length of the first segment, but the distance along the straight line connection between source and target location where each initial bent segment turns into the middle segment.

Values between 0 and 1 (inclusive) are interpreted as ratios of the whole distance, where 1 means that the fan extends to the midpoint between source and target. All other values are considered as a fixed distance.

readonlyfinal

height

: number
readonly
Gets the deviation of the bridge from the straight-line.
readonlyfinal

renderer

: IEdgeStyleRenderer
readonly
Gets the renderer implementation that can be queried for implementations that provide details about the visual appearance and visual behavior for a given edge and this style instance.
The idiom for retrieving, e.g. an IVisualCreator implementation for a given style is:
const creator = style.renderer.getVisualCreator(edge, style)
const visual = creator.createVisual(context)
readonlyfinal

selfLoopDistance

: number
readonly
Gets the distance between the node's layout and its self-loop control points.
readonlyfinal

sourceArrow

: WebGLArrowType
readonly
Gets the arrow at the edge's source end.
readonlyfinal

stroke

: WebGLStroke
readonly
Gets the stroke that specifies the color and thickness of the edge.
readonlyfinal

targetArrow

: WebGLArrowType
readonly
Gets the arrow at the edge's target end.
readonlyfinal

Methods

clone

(): Object
Create a clone of this object.
final

Return Value

Object
A clone of this object.