Packagecom.yworks.graph.drawing
Classpublic class PolylineEdgeStyle
InheritancePolylineEdgeStyle Inheritance AbstractEdgeStyle Inheritance AbstractStyle
ImplementsIPolylineEdgeStyle

An edge style that draws edges consisting of multiple lines using a chosen IStroke.

This style can be used together with a PolylineEdgeStyleRenderer.


Public Properties
 PropertyDefined by
  smoothing : Number
The smoothing length used for creating smooth bends.
PolylineEdgeStyle
 InheritedsourceArrow : IArrow
Gets the visual arrow at the source end of edges that use this style.
AbstractEdgeStyle
  stroke : IStroke
The stroke used for painting an edge with this style.
PolylineEdgeStyle
 InheritedstyleRenderer : IStyleRenderer
Gets the renderer implementation that has been supplied to this instance upon creation.
AbstractStyle
 InheritedtargetArrow : IArrow
Gets the visual arrow at the target end of edges that use this style.
AbstractEdgeStyle
Public Methods
 MethodDefined by
  
PolylineEdgeStyle(edgeStyleRenderer:IStyleRenderer = null)
Creates a new instance.
PolylineEdgeStyle
  
clone():Object
Creates a clone of this instance.
PolylineEdgeStyle
  
install(canvas:CanvasComponent, group:ICanvasObjectGroup, modelItem:IModelItem):Array
Prepares the rendering of an IModelItem in a CanvasComponent by adding ICanvasObject's to the provided canvas.
PolylineEdgeStyle
Protected Methods
 MethodDefined by
  
createClone():AbstractEdgeStyle
Called by clone() to get a new instance of this.
PolylineEdgeStyle
  
createDefaultStroke():IStroke
Creates a dark gray stroke with width 1.0
PolylineEdgeStyle
Property detail
smoothingproperty
smoothing:Number  [read-write]

The smoothing length used for creating smooth bends.

A value of 0.0 will disable smoothing.

Implementation
    public function get smoothing():Number
    public function set smoothing(value:Number):void
strokeproperty 
stroke:IStroke  [read-write]

The stroke used for painting an edge with this style.

Implementation
    public function get stroke():IStroke
    public function set stroke(value:IStroke):void
Constructor detail
PolylineEdgeStyle()constructor
public function PolylineEdgeStyle(edgeStyleRenderer:IStyleRenderer = null)

Creates a new instance.

Parameters
edgeStyleRenderer:IStyleRenderer (default = null) — The style renderer used by this instance. If none is provided, a new PolylineEdgeStyleRenderer instance will be used.
Method detail
clone()method
public override function clone():Object

Creates a clone of this instance.

Returns
Object — A clone of this instance.
createClone()method 
protected override function createClone():AbstractEdgeStyle

Called by clone() to get a new instance of this.

Subclasses have to override this method

Returns
AbstractEdgeStyle — A new configured instance of this.
createDefaultStroke()method 
protected function createDefaultStroke():IStroke

Creates a dark gray stroke with width 1.0

Returns
IStroke — An IStroke instance
install()method 
public override function install(canvas:CanvasComponent, group:ICanvasObjectGroup, modelItem:IModelItem):Array

Prepares the rendering of an IModelItem in a CanvasComponent by adding ICanvasObject's to the provided canvas.

Implementations may add zero or more ICanvasObject instances to the given CanvasComponent. The group parameter can be used as a hint for implementations. They can add their newly created canvas objects to the given group. However they are not obliged to do that.

Parameters
canvas:CanvasComponent — The canvas to install the canvas objects in.
 
group:ICanvasObjectGroup — A hint that tells the implementation where to add the canvas objects.
 
modelItem:IModelItem — The item to install a visual representation for.

Returns
Array — An array of zero or more canvas objects that have been installed in the canvas by this method or null if nothing was installed.