A polygonal edge style for use in WebGL2 rendering.
Remarks
This style connects the bends of an edge with straight-line segments.
Note that unlike IEdgeStyle implementations, this class is immutable and can not be used with setStyle. All properties are read-only and immutable and the class cannot be subclassed, either. Its sole purpose is to be used with the setStyle method of WebGL2GraphModelManager.
Type Details
- yfiles module
- view-webgl
- yfiles-umd modules
- view-webgl, view
- Legacy UMD name
- yfiles.view.WebGL2PolylineEdgeStyle
See Also
Constructors
WebGL2PolylineEdgeStyle
(stroke?: WebGL2Stroke, sourceArrow?: WebGL2ArrowType, targetArrow?: WebGL2ArrowType, selfLoopDistance?: number, smoothingLength?: number, effect?: WebGL2Effect)Creates a new polyline edge style that is rendered with WebGL.
Remarks
This style can be applied to edges that are rendered by the WebGL2GraphModelManager. 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
A map of options to pass to the method.
- stroke - WebGL2Stroke
- The color and thickness of the edge. Defaults to BLACK.
- sourceArrow - WebGL2ArrowType
- The arrow at the edge's source end. Defaults to NONE.
- targetArrow - WebGL2ArrowType
- 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
. - smoothingLength - number
- The smoothing length used to create smooth bends. A value of
0
will disable smoothing. The default value is0
. - effect - WebGL2Effect
- The effect around the edge. Defaults to NONE.
Properties
Gets the applied effects on this style.
Gets the arrow at the edge's source end.
Gets the stroke that specifies the color and thickness of the edge.
Gets the arrow at the edge's target end.