| Package | com.yworks.yfiles.layout.hierarchic |
| Class | public class ClassicLayerSequencer |
| Inheritance | ClassicLayerSequencer  YObject Object |
| Implements | LayerSequencer |
| Property | Defined By | ||
|---|---|---|---|
| maximalDuration : uint
Getter:
Returns the proposed maximal duration for the calculation of the sequence. | ClassicLayerSequencer | ||
| randomizationRounds : int
Getter:
Returns the number of randomized rounds this algorithm will try if there was no optimal solution. | ClassicLayerSequencer | ||
| recentCrossingNumber : int [read-only]
Returns the number of edge crossings that were produced by this sequencer the last time it was applied to a graph. | ClassicLayerSequencer | ||
| removeFalseCrossings : Boolean
Getter:
Returns whether or not to remove false crossings. | ClassicLayerSequencer | ||
| useTransposition : Boolean
Getter:
Returns whether or not the transposition heuristic should be used. | ClassicLayerSequencer | ||
| usingGroups : Boolean
Specifies whether or not the layerer will preserve the groupings of nodes between each layer. | ClassicLayerSequencer | ||
| weightHeuristic : int
Getter:
Returns the currently set weight heuristic. | ClassicLayerSequencer | ||
| Method | Defined By | ||
|---|---|---|---|
ClassicLayerSequencer(init:Boolean = true)
Instantiates a new layer sequencer. | ClassicLayerSequencer | ||
adoptValues(otherSequencer:LayerSequencer):void
Tries to adopt/copy the settings of the given LayerSequencer to this sequencer. | ClassicLayerSequencer | ||
 | equals(o:Object):Boolean | YObject | |
getClass():Class [override] | ClassicLayerSequencer | ||
| ClassicLayerSequencer | |||
| hashCode():int | YObject | |
[static]
Instantiates a new layer sequencer. | ClassicLayerSequencer | ||
| Method | Defined By | ||
|---|---|---|---|
initClassicLayerSequencer():void
Initializes this object. | ClassicLayerSequencer | ||
| Constant | Defined By | ||
|---|---|---|---|
| BARYCENTER_HEURISTIC : int = 0 [static]
Weight assignment heuristic specifier. | ClassicLayerSequencer | ||
| GROUP_KEY : Object = y.layout.hierarchic.ClassicLayerSequencer.GROUP_KEY [static]
This is the key, which must be used to register the DataProvider which contains the mappings between nodes and group ids. | ClassicLayerSequencer | ||
| MEDIAN_HEURISTIC : int = 1 [static]
Weight assignment heuristic specifier. | ClassicLayerSequencer | ||
| maximalDuration | property |
Hide Inherited Public Methods
Show Inherited Public MethodsmaximalDuration:uintGetter: Returns the proposed maximal duration for the calculation of the sequence.
Setter: Sets the maximum amount of time granted for this sequencer per execution. public function get maximalDuration():uint public function set maximalDuration(value:uint):void| randomizationRounds | property |
randomizationRounds:intGetter: Returns the number of randomized rounds this algorithm will try if there was no optimal solution.
Setter: Sets the number of additional rounds the algorithm will restart with randomized solutions as long as there might be a better solution to the current best. public function get randomizationRounds():int public function set randomizationRounds(value:int):void| recentCrossingNumber | property |
recentCrossingNumber:int [read-only] Returns the number of edge crossings that were produced by this sequencer the last time it was applied to a graph.
Precondition Method getLayers() must have been called before.
public function get recentCrossingNumber():intSee also
| removeFalseCrossings | property |
removeFalseCrossings:BooleanGetter: Returns whether or not to remove false crossings.
Setter: Specifies whether or not to remove so-called false crossings in an additional phase. A false crossing is a crossing between two edges that share a common terminal node. By default this feature is active. public function get removeFalseCrossings():Boolean public function set removeFalseCrossings(value:Boolean):void| useTransposition | property |
useTransposition:BooleanGetter: Returns whether or not the transposition heuristic should be used.
Setter: Specifies whether or not an additional crossing minimization heuristic should be used. Activating this heuristic can reduce the overall number of edge crossings. On the other hand its activation increases running time. By default the transposition rule is active. public function get useTransposition():Boolean public function set useTransposition(value:Boolean):void| usingGroups | property |
usingGroups:BooleanSpecifies whether or not the layerer will preserve the groupings of nodes between each layer. Preserving groupings means nodes having the same integer group number will be placed directly next to each other within each layer.
Defaults to false.
public function get usingGroups():Boolean public function set usingGroups(value:Boolean):void| weightHeuristic | property |
weightHeuristic:intGetter: Returns the currently set weight heuristic.
Setter: Sets the weight heuristic to be used. By default BARYCENTER_HEURISTIC is set. public function get weightHeuristic():int public function set weightHeuristic(value:int):voidSee also
| ClassicLayerSequencer | () | Constructor |
public function ClassicLayerSequencer(init:Boolean = true)Instantiates a new layer sequencer.
Parametersinit:Boolean (default = true) |
| adoptValues | () | method |
public function adoptValues(otherSequencer:LayerSequencer):voidTries to adopt/copy the settings of the given LayerSequencer to this sequencer.
Parameters
otherSequencer:LayerSequencer |
| getClass | () | method |
override public function getClass():ClassReturnsClass |
| getLayers | () | method |
public function getLayers(g:LayoutGraph, layerMap:NodeMap, maxLayer:int):Vector.<Object>Parameters
g:LayoutGraph | |
layerMap:NodeMap | |
maxLayer:int |
Vector.<Object> |
| initClassicLayerSequencer | () | method |
protected final function initClassicLayerSequencer():void
Initializes this object. See the documentation of the corresponding factory method newClassicLayerSequencer() for details.
See also
| newClassicLayerSequencer | () | method |
public static function newClassicLayerSequencer():ClassicLayerSequencerInstantiates a new layer sequencer.
ReturnsClassicLayerSequencer |
| BARYCENTER_HEURISTIC | Constant |
public static const BARYCENTER_HEURISTIC:int = 0Weight assignment heuristic specifier. A node position within a layer will be determined by the barycenter of its successor (downward pass) and predecessor (upward pass) nodes.
| GROUP_KEY | Constant |
public static const GROUP_KEY:Object = y.layout.hierarchic.ClassicLayerSequencer.GROUP_KEYThis is the key, which must be used to register the DataProvider which contains the mappings between nodes and group ids. Group ids are integer objects, containing unique group numbers or null, if the node belongs to no specific group.
| MEDIAN_HEURISTIC | Constant |
public static const MEDIAN_HEURISTIC:int = 1Weight assignment heuristic specifier. A node position within a layer will be determined by the median position of its successor (downward pass) and predecessor (upward pass) nodes.