Provides an arc representation for an edge.
Remarks
The rendering does not take into account bends of an edge, instead the arc's height is determined as a fixed ratio or fixed height.
This style uses an ArcEdgeStyleRenderer for its visualization.
Type Details
- yfiles module
- styles-other
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.styles.ArcEdgeStyle
See Also
Constructors
Creates a new instance using ArcEdgeStyleRenderer as renderer.
Parameters
A map of options to pass to the method.
- stroke - Stroke
- height - number
The "height" of the arc. This option sets the height property on the created object.
- fixedHeight - boolean
A value indicating whether this ArcEdgeStyle interprets the height value as an absolute or relative value. This option sets the fixedHeight property on the created object.
- provideHeightHandle - boolean
A value indicating whether the ArcEdgeStyleRenderer 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.
- cssClass - string
A CSS class that will be applied to the visualization. This option sets the cssClass property on the created object.
Creates a new instance using the provided renderer.
Parameters
A map of options to pass to the method.
- renderer - ArcEdgeStyleRenderer
- The custom renderer for this style instance.
- stroke - Stroke
- height - number
The "height" of the arc. This option sets the height property on the created object.
- fixedHeight - boolean
A value indicating whether this ArcEdgeStyle interprets the height value as an absolute or relative value. This option sets the fixedHeight property on the created object.
- provideHeightHandle - boolean
A value indicating whether the ArcEdgeStyleRenderer 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.
- cssClass - string
A CSS class that will be applied to the visualization. This option sets the cssClass property on the created object.
Properties
Gets or sets a value indicating whether this ArcEdgeStyle interprets the height value as an absolute or relative value.
Gets or sets the "height" of the arc.
Remarks
Depending on the setting of fixedHeight, this value is interpreted differently: If fixedHeight is disabled, the height of the arc will depend on its width. The width will be multiplied by this value to obtain the height. If the fixedHeight feature is enabled, this value will be interpreted as the absolute height.
The default value is 0.
See Also
Gets or sets a value indicating whether the ArcEdgeStyleRenderer 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 arc
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