Provides a bridge representation for an edge.
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.
This style uses a BridgeEdgeStyleRenderer for its visualization.
Type Details
- yfiles module
- styles-other
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.styles.BridgeEdgeStyle
See Also
Constructors
Creates a new instance using BridgeEdgeStyleRenderer as renderer.
Parameters
A map of options to pass to the method.
- stroke - Stroke
- 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 BridgeEdgeStyleRenderer 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.
Creates a new instance using the provided renderer.
Parameters
A map of options to pass to the method.
- renderer - BridgeEdgeStyleRenderer
- The custom renderer for this style instance.
- stroke - Stroke
- 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 BridgeEdgeStyleRenderer 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
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.
See Also
Gets or sets the height of the path.
Gets or sets a value indicating whether the BridgeEdgeStyleRenderer should provide an IHandle if queried for the IHandleProvider implementation that allows for adjusting the height of this instance.
Gets the renderer implementation that has been supplied to this instance in the constructor.
Implements
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.
See Also
Gets or sets the Stroke that is used to draw the path
Gets or sets the visual arrow at the target 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 target arrow visualization.
The default value is NONE.
See Also
Methods
Performs a memberwiseClone