Package | com.yworks.yfiles.layout.labeling |
Class | public class SALabeling |
Inheritance | SALabeling MISLabelingAlgorithm AbstractLabelingAlgorithm AbstractLayoutStage YObject Object |
Property | Defined By | ||
---|---|---|---|
applyPostprocessing : Boolean
Getter:
Returns true if the postprocessing step is applied. | AbstractLabelingAlgorithm | ||
autoFlippingEnabled : Boolean
Determines whether or not edge labels associated with a "free" label model (see for example y.view.SmartEdgeLabelModel) should be automatically flipped if they would be upside-down. | AbstractLabelingAlgorithm | ||
boxesToNodesInternal : Map [read-only] | MISLabelingAlgorithm | ||
conflictGraphInternal : Graph [read-only] | MISLabelingAlgorithm | ||
coreLayouter : Layouter
Specifies the core layouter. | AbstractLayoutStage | ||
customProfitModelRatio : Number
Getter:
Returns the custom profit model ratio. | MISLabelingAlgorithm | ||
deterministicMode : Boolean
Specifies whether or not this labeling algorithm should work deterministically. | SALabeling | ||
edgeGroupOverlapAllowed : Boolean
Getter:
Returns whether edge labels may overlap with edges belonging to the same edge group. | AbstractLabelingAlgorithm | ||
graph : LayoutGraph | MISLabelingAlgorithm | ||
maximalDuration : uint
Getter:
Returns the time limit for the algorithm (in milliseconds). | SALabeling | ||
moveInternalNodeLabels : Boolean
Specifies true if the labeling algorithm is allowed to move internal node labels. | AbstractLabelingAlgorithm | ||
nodesToIDInternal : NodeMap [read-only] | MISLabelingAlgorithm | ||
optimizationStrategy : int
Specifies the optimization strategy of the labeling algorithm. | MISLabelingAlgorithm | ||
placeEdgeLabels : Boolean
Specifies whether labels assigned to edges in a graph should be placed or ignored. | AbstractLabelingAlgorithm | ||
placeNodeLabels : Boolean
Specifies whether labels assigned to nodes in a graph should be placed or ignored. | AbstractLabelingAlgorithm | ||
profitModel : ProfitModel
Sets the profit model that is used to rank the available positions for each label. | AbstractLabelingAlgorithm | ||
rects : YList [read-only]
Returns the set of all generated candidate rectangles. | AbstractLabelingAlgorithm | ||
removeEdgeOverlaps : Boolean
Specifies how label candidates which overlap with edges are handled. | AbstractLabelingAlgorithm | ||
removeNodeOverlaps : Boolean
Specifies how label candidates which overlap with nodes are handled. | AbstractLabelingAlgorithm | ||
selectedLabelsDpKey : Object
Getter:
Returns the labeling selection DataProvider key. | AbstractLabelingAlgorithm | ||
storeRects : Boolean
Specifies whether the candidate rectangles should be stored to be retrieved. | AbstractLabelingAlgorithm | ||
useAlternativeSideHandling : Boolean
Getter:
Returns true if the preference on which side of an edge a corresponding label should be placed is interpreted by human perception instead of always following the edge from source to target. | AbstractLabelingAlgorithm |
Method | Defined By | ||
---|---|---|---|
SALabeling(init:Boolean = true) | SALabeling | ||
canLayout(graph:LayoutGraph):Boolean [override]
Returns true. | AbstractLabelingAlgorithm | ||
doLayout(graph:LayoutGraph):void [override]
Place the labels in the graph. | AbstractLabelingAlgorithm | ||
equals(o:Object):Boolean | YObject | ||
getClass():Class [override] | SALabeling | ||
getProfit(l:LabelCandidate):Number
Returns the profit model that is used to rank the available positions for each label. | AbstractLabelingAlgorithm | ||
hashCode():int | YObject | ||
label(gl:LayoutGraph):void
Place the labels in the graph. | AbstractLabelingAlgorithm | ||
labelSome(gl:LayoutGraph, key:Object):void
Place a subset of the labels. | AbstractLabelingAlgorithm | ||
Place some labels in the graph. | AbstractLabelingAlgorithm | ||
[static] | SALabeling |
Method | Defined By | ||
---|---|---|---|
Creates a node map which assigns to each node the profit. | MISLabelingAlgorithm | ||
canLayoutCore(graph:LayoutGraph):Boolean
Queries the core layouter whether or not the given graph can be laid out. | AbstractLayoutStage | ||
checkGroupNodeSize(layout:GraphLayout, node:Object):void
This method throws an com.yworks.bridge.util.IllegalArgumentException if the width/height of the given group node object is zero. | AbstractLabelingAlgorithm | ||
checkNodeSize(layout:GraphLayout, node:Object):void
This method throws an com.yworks.bridge.util.IllegalArgumentException if the width/height of the given node object is zero. | AbstractLabelingAlgorithm | ||
createEdges():void
Creates one edge between two nodes if the corresponding label candidates are intersecting. | MISLabelingAlgorithm | ||
doLayoutCore(graph:LayoutGraph):void
Invokes the layout routine of the core layouter. | AbstractLayoutStage | ||
Calculates the overlapping factor between a label candidate and an edge segment. | MISLabelingAlgorithm | ||
Calculates the overlapping factor between a label candidate and a node halo. | MISLabelingAlgorithm | ||
Calculates the overlapping factor between two label candidates. | MISLabelingAlgorithm | ||
Calculates the overlapping factor between a label candidate and a node. | MISLabelingAlgorithm | ||
AbstractLabelingAlgorithm | |||
initAbstractLayoutStage1():void | AbstractLayoutStage | ||
initAbstractLayoutStage2(core:Layouter):void | AbstractLayoutStage | ||
initMISLabelingAlgorithm():void | MISLabelingAlgorithm | ||
initSALabeling():void | SALabeling |
deterministicMode | property |
deterministicMode:Boolean
Specifies whether or not this labeling algorithm should work deterministically. In deterministic mode this labeling algorithm produces the same layout results for the same input graph and layout/labeling parameters.
By default deterministic mode is disabled.
public function get deterministicMode():Boolean
public function set deterministicMode(value:Boolean):void
maximalDuration | property |
maximalDuration:uint
Getter: Returns the time limit for the algorithm (in milliseconds). Note, that this limit is not strictly observed.
Setter: Sets a time limit for the labeling algorithm. Note, that this limit is not strictly observed. public function get maximalDuration():uint
public function set maximalDuration(value:uint):void
SALabeling | () | Constructor |
public function SALabeling(init:Boolean = true)
init:Boolean (default = true )
|
getClass | () | method |
override public function getClass():Class
ReturnsClass |
initSALabeling | () | method |
protected final function initSALabeling():void
newSALabeling | () | method |