| Package | com.yworks.yfiles.layout |
| Class | public class EdgeLabelOrientationSupport |
| Inheritance | EdgeLabelOrientationSupport  YObject Object |
To calculate the position and orientation of edge labels, whose placements are defined with the com.yworks.yfiles.layout.PreferredPlacementDescriptor, the com.yworks.yfiles.layout.OrientationLayouter would need the direction of the associated edge. Since this direction is not available for the OrientationLayouter, because it is a wrapper, the calculation must be done in the core layouter itself with the help of the EdgeLabelOrientationSupport.
Important: Since all layouters with integrated edge labeling could not deal with ambiguous preferred placement descriptors (combinations of the same setting e.g. source or target for the com.yworks.yfiles.layout.PreferredPlacementDescriptor.placeAlongEdge), preProcessLabel() removes combinations and replaces the original descriptor with a "non-ambiguous" one during the layout calculation.
See also
| Method | Defined By | ||
|---|---|---|---|
EdgeLabelOrientationSupport(init:Boolean = true)
Creates an instance. | EdgeLabelOrientationSupport | ||
 | equals(o:Object):Boolean | YObject | |
getClass():Class [override] | EdgeLabelOrientationSupport | ||
[static]
Calculates the up vector of an edge label considering the preferred placement of the label as well as the direction of the edge segment the label is attached to. | EdgeLabelOrientationSupport | ||
getLabelUpVector(rightVectorAngle:Number):YVector [static]
Calculates the up vector for a label whose right vector is rotated clockwise by the given rightVectorAngle. | EdgeLabelOrientationSupport | ||
[static]
Transforms a direction of the layout to the oriented layout. | EdgeLabelOrientationSupport | ||
| hashCode():int | YObject | |
isOrientationMirrored(orientation:int, mirrorMask:int):Boolean [static]
Returns whether or not the orientation is mirrored. | EdgeLabelOrientationSupport | ||
[static]
Creates an instance. | EdgeLabelOrientationSupport | ||
Called by the core layouter with the integrated edge labeling for each edge label after the location of the label is determined. | EdgeLabelOrientationSupport | ||
Called by the core layouter with the integrated edge labeling for each edge label before the layouter uses the labels geometry. | EdgeLabelOrientationSupport | ||
replaceAmbiguousLabelDescriptors(graph:Graph):void
Replaces the com.yworks.yfiles.layout.PreferredPlacementDescriptor s of all edge labels in the given graph with non-ambiguous descriptors. | EdgeLabelOrientationSupport | ||
resetAmbiguousLabelDescriptors(graph:Graph):void
Restores the com.yworks.yfiles.layout.PreferredPlacementDescriptor s of all edge labels in the given graph with their original descriptors. | EdgeLabelOrientationSupport | ||
[static]
Calculates and sets the up vector of an edge label considering the preferred placement of the label as well as the direction of the edge segment the label is attached to. | EdgeLabelOrientationSupport | ||
| Method | Defined By | ||
|---|---|---|---|
Initializes this object. | EdgeLabelOrientationSupport | ||
| EdgeLabelOrientationSupport | () | Constructor |
Hide Inherited Public Methods
Show Inherited Public Methodspublic function EdgeLabelOrientationSupport(init:Boolean = true)Creates an instance. Since this class handles the orientation of the edge labels, the core layouter should switch the calculation in its com.yworks.yfiles.layout.OrientationLayouter off.
Parametersinit:Boolean (default = true) |
See also
| getClass | () | method |
override public function getClass():ClassReturnsClass |
| getEdgeLabelUpVector | () | method |
public static function getEdgeLabelUpVector(descriptor:PreferredPlacementDescriptor, segmentDirection:Direction):YVectorCalculates the up vector of an edge label considering the preferred placement of the label as well as the direction of the edge segment the label is attached to.
Parameters
descriptor:PreferredPlacementDescriptor — The data describing the preferred label orientation.
| |
segmentDirection:Direction — The direction the edge segment is pointing to.
|
YVector — An up vector for the edge label that considers the preferred placement of the label as well as the direction of the edge segment the label is attached to.
|
| getLabelUpVector | () | method |
public static function getLabelUpVector(rightVectorAngle:Number):YVectorCalculates the up vector for a label whose right vector is rotated clockwise by the given rightVectorAngle.
Parameters
rightVectorAngle:Number — The angle in radians the right vector is rotated by.
|
YVector — The up vector for a label whose right vector is rotated clockwise by the given angle.
|
| getOrientedDirection | () | method |
public static function getOrientedDirection(direction:Direction, orientation:int, mirrorMask:int):DirectionTransforms a direction of the layout to the oriented layout.
Parameters
direction:Direction — direction in the layout
| |
orientation:int | |
mirrorMask:int — @return the direction in the oriented layout
|
Direction |
| initEdgeLabelOrientationSupport | () | method |
protected final function initEdgeLabelOrientationSupport():void
Initializes this object. See the documentation of the corresponding factory method newEdgeLabelOrientationSupport() for details.
See also
| isOrientationMirrored | () | method |
public static function isOrientationMirrored(orientation:int, mirrorMask:int):BooleanReturns whether or not the orientation is mirrored.
Parameters
orientation:int | |
mirrorMask:int |
Boolean — true if the orientation is mirrored; false otherwise
|
| newEdgeLabelOrientationSupport | () | method |
public static function newEdgeLabelOrientationSupport():EdgeLabelOrientationSupportCreates an instance. Since this class handles the orientation of the edge labels, the core layouter should switch the calculation in its com.yworks.yfiles.layout.OrientationLayouter off.
ReturnsEdgeLabelOrientationSupport |
See also
| postProcessLabel | () | method |
public function postProcessLabel(graph:Graph, label:LabelLayoutData):voidCalled by the core layouter with the integrated edge labeling for each edge label after the location of the label is determined.
It restores the original com.yworks.yfiles.layout.LabelLayoutData.preferredPlacementDescriptor that has been replaced in preProcessLabel() . Then it move and rotates the label (com.yworks.yfiles.layout.LabelLayoutData.bounds) in respect of the orientation.
Parameters
graph:Graph — graph to get the orientation information from
| |
label:LabelLayoutData — edge label whose location is determined
|
See also
| preProcessLabel | () | method |
public function preProcessLabel(graph:Graph, label:LabelLayoutData, segmentDirection:Direction):voidCalled by the core layouter with the integrated edge labeling for each edge label before the layouter uses the labels geometry. The method should be called as soon as the direction of the segment the label belongs to is determined.
First it replaces the com.yworks.yfiles.layout.LabelLayoutData.preferredPlacementDescriptor of the edge label by a PreferredPlacementDescriptor that has only relative references. This descriptor is orientation independent and could be used in the core layouter. Second it rotates the label (com.yworks.yfiles.layout.LabelLayoutData.bounds) in respect of it PreferredPlacementDescriptor and the direction of the segment it belongs to. After that call the core layouter could use the geometry ( com.yworks.yfiles.layout.LabelLayoutData.width and com.yworks.yfiles.layout.LabelLayoutData.width) of the label to calculate its location.
Parameters
graph:Graph — graph to get the orientation information from
| |
label:LabelLayoutData — edge label whose segment direction is determined
| |
segmentDirection:Direction — direction of the segment the edge label belongs to
|
See also
| replaceAmbiguousLabelDescriptors | () | method |
public function replaceAmbiguousLabelDescriptors(graph:Graph):voidReplaces the com.yworks.yfiles.layout.PreferredPlacementDescriptor s of all edge labels in the given graph with non-ambiguous descriptors.
It should be called by a layouter at the beginning of layout calculation to assure that the label's placement is handled consistently.
Parameters
graph:Graph |
See also
| resetAmbiguousLabelDescriptors | () | method |
public function resetAmbiguousLabelDescriptors(graph:Graph):voidRestores the com.yworks.yfiles.layout.PreferredPlacementDescriptor s of all edge labels in the given graph with their original descriptors.
It should be called by a layouter at the end of layout calculation to assure that the original state of the graph is not corrupted.
Parameters
graph:Graph |
See also
| updateLabelOrientation | () | method |
public static function updateLabelOrientation(label:LabelLayoutData, segmentDirection:Direction):voidCalculates and sets the up vector of an edge label considering the preferred placement of the label as well as the direction of the edge segment the label is attached to.
Parameters
label:LabelLayoutData — The data that describes the label orientation and is used to set the new up vector.
| |
segmentDirection:Direction — The direction the edge segment is pointing to.
|
See also