Packagecom.yworks.yfiles.layout.planar
Classpublic class CombinatorialEmbedder
InheritanceCombinatorialEmbedder Inheritance YObject Inheritance Object
Implements Embedder

Interface implementation for an embedder.



Public Properties
 PropertyDefined By
  planarInformation : PlanarInformation
[write-only] Sets the planar information which will contain the embedding.
CombinatorialEmbedder
  planarSubgraphRandomizationIterations : int
Specifies the number of iterations used by the planar subgraph algorithm.
CombinatorialEmbedder
  rerouteIterations : int
Specifies the number of iterations over the list of all split edges.
CombinatorialEmbedder
  reroutingTime : int
[read-only]
CombinatorialEmbedder
  routingTime : int
[read-only]
CombinatorialEmbedder
  subgraphTime : int
[read-only]
CombinatorialEmbedder
  useBiconnectedComponents : Boolean
Specifies indicator for usage of bccs is allowed or not resp.
CombinatorialEmbedder
  useEdgeRerouting : Boolean
Specifies indicator for edge re-routing is allowed or not resp.
CombinatorialEmbedder
  useFaceMaximization : Boolean
Specifies indicator if the usage of a face maximizer is wanted or not.
CombinatorialEmbedder
  useRandomization : Boolean
Specifies whether randomization is used or not.
CombinatorialEmbedder
Public Methods
 MethodDefined By
  
CombinatorialEmbedder(init:Boolean = true)
CombinatorialEmbedder
  
dispose():void
Undoes the changes in the graph and removes the complete help info
CombinatorialEmbedder
  
embed():void
This method does the whole embedding work
CombinatorialEmbedder
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
CombinatorialEmbedder
 Inherited
hashCode():int
YObject
  
[static]
CombinatorialEmbedder
Protected Methods
 MethodDefined By
  
Returns an instance of which a planar subgraph.
CombinatorialEmbedder
  
CombinatorialEmbedder
Public Constants
 ConstantDefined By
  SUBGRAPH_TYPE_DFS_TREE : int = 1
[static]
CombinatorialEmbedder
  SUBGRAPH_TYPE_GT : int = 0
[static]
CombinatorialEmbedder
Property Detail
planarInformationproperty
planarInformation:PlanarInformation  [write-only]

Sets the planar information which will contain the embedding.


Implementation
    public function set planarInformation(value:PlanarInformation):void
planarSubgraphRandomizationIterationsproperty 
planarSubgraphRandomizationIterations:int

Specifies the number of iterations used by the planar subgraph algorithm. Only considered when randomization is activated.


Implementation
    public function get planarSubgraphRandomizationIterations():int
    public function set planarSubgraphRandomizationIterations(value:int):void
rerouteIterationsproperty 
rerouteIterations:int

Specifies the number of iterations over the list of all split edges.


Implementation
    public function get rerouteIterations():int
    public function set rerouteIterations(value:int):void
reroutingTimeproperty 
reroutingTime:int  [read-only]


Implementation
    public function get reroutingTime():int
routingTimeproperty 
routingTime:int  [read-only]


Implementation
    public function get routingTime():int
subgraphTimeproperty 
subgraphTime:int  [read-only]


Implementation
    public function get subgraphTime():int
useBiconnectedComponentsproperty 
useBiconnectedComponents:Boolean

Specifies indicator for usage of bccs is allowed or not resp. is wanted or not.


Implementation
    public function get useBiconnectedComponents():Boolean
    public function set useBiconnectedComponents(value:Boolean):void
useEdgeReroutingproperty 
useEdgeRerouting:Boolean

Specifies indicator for edge re-routing is allowed or not resp. is wanted or not.


Implementation
    public function get useEdgeRerouting():Boolean
    public function set useEdgeRerouting(value:Boolean):void
useFaceMaximizationproperty 
useFaceMaximization:Boolean

Specifies indicator if the usage of a face maximizer is wanted or not.


Implementation
    public function get useFaceMaximization():Boolean
    public function set useFaceMaximization(value:Boolean):void
useRandomizationproperty 
useRandomization:Boolean

Specifies whether randomization is used or not.


Implementation
    public function get useRandomization():Boolean
    public function set useRandomization(value:Boolean):void
Constructor Detail
CombinatorialEmbedder()Constructor
public function CombinatorialEmbedder(init:Boolean = true)



Parameters
init:Boolean (default = true)
Method Detail
dispose()method
public function dispose():void

Undoes the changes in the graph and removes the complete help info

embed()method 
public function embed():void

This method does the whole embedding work

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

Returns
Class
getPlanarSubgraphInstance()method 
protected function getPlanarSubgraphInstance(_subgraphType:int):InitialPlanarSubgraph

Returns an instance of which a planar subgraph.

Parameters

_subgraphType:int — specifies the technique used to find a planar subgraph

Returns
InitialPlanarSubgraph — an instance of InitialPlanarSubgraph
initCombinatorialEmbedder()method 
protected final function initCombinatorialEmbedder():void

newCombinatorialEmbedder()method 
public static function newCombinatorialEmbedder():CombinatorialEmbedder

Returns
CombinatorialEmbedder
Constant Detail
SUBGRAPH_TYPE_DFS_TREEConstant
public static const SUBGRAPH_TYPE_DFS_TREE:int = 1

SUBGRAPH_TYPE_GTConstant 
public static const SUBGRAPH_TYPE_GT:int = 0