PolylineEdgeStyle

Show usages

A polygonal IEdgeStyle where straight line segments are used to connect the bends.

Inheritance Hierarchy

PolylineEdgeStyle

Implemented Interfaces

IEdgeStyle

ICloneable

Type Details

yFiles module: view

Constructors

PolylineEdgeStyle

()

ParametersOptions Overload

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

stroke - Stroke: The stroke for the line. This option sets the stroke property on the created object.
smoothingLength - number: The smoothing length used for creating smooth bends. This option sets the smoothingLength property on the created object.
cssClass - string: A CSS class that will be applied to the visualization. This option sets the cssClass property on the created object.
orthogonalEditing - boolean: Whether edges using this style should be created or edited orthogonally. This option sets the orthogonalEditing property on the created object.
targetArrow - IArrow: The visual arrow at the target end of edges that use this style. This option sets the targetArrow property on the created object.
sourceArrow - IArrow: The visual arrow at the source end of edges that use this style. This option sets the sourceArrow property on the created object.

Properties

cssClass

: string

Gets or sets a CSS class that will be applied to the visualization.

Remarks

The default value is an empty string, in which case no class is set for the visualization.

Multiple classes can be set by separating them with spaces, just like with the SVG class attribute.

orthogonalEditing

: boolean

Gets or sets whether edges using this style should be created or edited orthogonally.

Remarks

Depending on this value, this style will provide a matching preconfigured IOrthogonalEdgeHelper via this renderer's context or null.

The default value is false.

renderer

: IEdgeStyleRenderer

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.

Remarks

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)

Implements

IEdgeStyle

smoothingLength

: number

Gets or sets the smoothing length used for creating smooth bends.

Remarks

A value of 0.0d will disable smoothing.

The default value is 0.

sourceArrow

: IArrow

Gets or sets the visual arrow at the source end of edges that use this style.

Remarks

Arrow instances may be shared between multiple style instances.

This property may not be null. To have no source arrow set, use NONE instead.

Note that changes to the properties of an arrow may not be immediately visible. It is therefore recommended to assign a new arrow instance to this property if you want to change aspects of the source arrow visualization.

The default value is NONE.