BridgeEdgeStyle

Provides a bridge representation for an edge.

Inheritance Hierarchy

BridgeEdgeStyle

Implemented Interfaces

Remarks

The rendering does not take into account bends of an edge, instead the bridge's height is determined by the height and fanLength properties.

Type Details

yFiles module: view

Constructors

BridgeEdgeStyle

()

ParametersOptions Overload

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

stroke - Stroke: The Stroke that is used to draw the path This option sets the stroke property on the created object.
height - number: The height of the path. This option sets the height property on the created object.
fanLength - number: The length of the "fan" part of the style. This option sets the fanLength 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.
provideHeightHandle - boolean: A value indicating whether the renderer should provide an IHandle if queried for the IHandleProvider implementation that allows for adjusting the height of this instance. This option sets the provideHeightHandle 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.

fanLength

: number

Gets or sets the length of the "fan" part of the style.

Remarks

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.

The default value is 0.2.

height

: number

Gets or sets the height of the path.

Remarks

The default value is 0.

Property Value

The height of the arc

provideHeightHandle

: boolean

Gets or sets a value indicating whether the renderer should provide an IHandle if queried for the IHandleProvider implementation that allows for adjusting the height of this instance.

Remarks

The default value is true.

Property Value

true (which is the default) if a handle should be provided; false otherwise.

renderer

: IEdgeStyleRenderer

Gets the renderer implementation that has been supplied to this instance in the constructor.

Implements

IEdgeStyle

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.

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.