Packagecom.yworks.yfiles.layout
Classpublic class FreeEdgeLabelLayoutModel
InheritanceFreeEdgeLabelLayoutModel Inheritance YObject Inheritance Object
Implements EdgeLabelModel

An edge label model that allows placement of labels at a fixed offset from the source intersection point of the node.



Public Properties
 PropertyDefined By
  defaultParameter : Object
[read-only] Returns the default parameter.
FreeEdgeLabelLayoutModel
Public Methods
 MethodDefined By
  
FreeEdgeLabelLayoutModel(init:Boolean = true)
Creates a new instance of com.yworks.yfiles.layout.FreeEdgeLabelLayoutModel.
FreeEdgeLabelLayoutModel
  
createModelParameter(labelBounds:YOrientedRectangle, edgeLayout:EdgeLayout, sourceNode:NodeLayout, targetNode:NodeLayout):Object
Returns a model parameter that represents the given edge label context.
FreeEdgeLabelLayoutModel
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
FreeEdgeLabelLayoutModel
  
getLabelCandidates(label:EdgeLabelLayout, edgeLayout:EdgeLayout, sourceNode:NodeLayout, targetNode:NodeLayout):YList
Returns exactly one label candidate that corresponds to the actual label layout of the given label.
FreeEdgeLabelLayoutModel
  
getLabelPlacement(labelSize:YDimension, edgeLayout:EdgeLayout, sourceNode:NodeLayout, targetNode:NodeLayout, param:Object):YOrientedRectangle
Returns the positions of the upper left corner of the label with given parameter.
FreeEdgeLabelLayoutModel
 Inherited
hashCode():int
YObject
  
[static] Creates a new instance of com.yworks.yfiles.layout.FreeEdgeLabelLayoutModel.
FreeEdgeLabelLayoutModel
Protected Methods
 MethodDefined By
  
Initializes this object.
FreeEdgeLabelLayoutModel
Property Detail
defaultParameterproperty
defaultParameter:Object  [read-only]

Returns the default parameter.


Implementation
    public function get defaultParameter():Object
Constructor Detail
FreeEdgeLabelLayoutModel()Constructor
public function FreeEdgeLabelLayoutModel(init:Boolean = true)

Creates a new instance of com.yworks.yfiles.layout.FreeEdgeLabelLayoutModel.

Parameters
init:Boolean (default = true) — An internally used switch to help handle proper instance initialization in inheritance chains where classes can have multiple constructor-like factory methods. This parameter can safely be ignored/omitted when calling the constructor.

See also

Method Detail
createModelParameter()method
public function createModelParameter(labelBounds:YOrientedRectangle, edgeLayout:EdgeLayout, sourceNode:NodeLayout, targetNode:NodeLayout):Object

Returns a model parameter that represents the given edge label context. The created model parameter reproduces the location of the given label bounds.

Parameters

labelBounds:YOrientedRectangle
 
edgeLayout:EdgeLayout
 
sourceNode:NodeLayout
 
targetNode:NodeLayout

Returns
Object
getClass()method 
override public function getClass():Class

Returns
Class
getLabelCandidates()method 
public function getLabelCandidates(label:EdgeLabelLayout, edgeLayout:EdgeLayout, sourceNode:NodeLayout, targetNode:NodeLayout):YList

Returns exactly one label candidate that corresponds to the actual label layout of the given label.

Parameters

label:EdgeLabelLayout
 
edgeLayout:EdgeLayout
 
sourceNode:NodeLayout
 
targetNode:NodeLayout

Returns
YList
getLabelPlacement()method 
public function getLabelPlacement(labelSize:YDimension, edgeLayout:EdgeLayout, sourceNode:NodeLayout, targetNode:NodeLayout, param:Object):YOrientedRectangle

Returns the positions of the upper left corner of the label with given parameter.

Parameters

labelSize:YDimension
 
edgeLayout:EdgeLayout
 
sourceNode:NodeLayout
 
targetNode:NodeLayout
 
param:Object

Returns
YOrientedRectangle
initFreeEdgeLabelLayoutModel()method 
protected final function initFreeEdgeLabelLayoutModel():void

Initializes this object. See the documentation of the corresponding factory method newFreeEdgeLabelLayoutModel() for details.

See also

newFreeEdgeLabelLayoutModel()method 
public static function newFreeEdgeLabelLayoutModel():FreeEdgeLabelLayoutModel

Creates a new instance of com.yworks.yfiles.layout.FreeEdgeLabelLayoutModel.

Returns
FreeEdgeLabelLayoutModel

See also