Packagecom.yworks.yfiles.layout.planar
Classpublic class PlanarityTestWrapper
InheritancePlanarityTestWrapper Inheritance YObject Inheritance Object
Implements InitialPlanarSubgraph

A class used to wrap any instance of com.yworks.yfiles.layout.planar.InitialPlanarSubgraph to make sure that the complete graph is obtained when using com.yworks.yfiles.layout.planar.InitialPlanarSubgraph.createPlanarization().

See also

com.yworks.yfiles.layout.planar.InitialPlanarSubgraph
com.yworks.yfiles.layout.planar.InitialPlanarSubgraph.createPlanarization()


Public Properties
 PropertyDefined By
  hiddenEdges : EdgeList
[read-only] Returns a list of edges that were not added to the planar subgraph returned by the function createPlanarization().
PlanarityTestWrapper
Public Methods
 MethodDefined By
  
PlanarityTestWrapper(nonPlanarGraphHandler:InitialPlanarSubgraph, init:Boolean = true)
Creates an instance of com.yworks.yfiles.layout.planar.PlanarityTestWrapper.
PlanarityTestWrapper
  
Finds a planar subgraph in the specified graph and saves a planar embedding for it in pi.
PlanarityTestWrapper
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
PlanarityTestWrapper
 Inherited
hashCode():int
YObject
  
[static] Creates an instance of com.yworks.yfiles.layout.planar.PlanarityTestWrapper.
PlanarityTestWrapper
Protected Methods
 MethodDefined By
  
Initializes this object.
PlanarityTestWrapper
Property Detail
hiddenEdgesproperty
hiddenEdges:EdgeList  [read-only]

Returns a list of edges that were not added to the planar subgraph returned by the function createPlanarization(). The function createPlanarization() must be called first.


Implementation
    public function get hiddenEdges():EdgeList

See also

Constructor Detail
PlanarityTestWrapper()Constructor
public function PlanarityTestWrapper(nonPlanarGraphHandler:InitialPlanarSubgraph, init:Boolean = true)

Creates an instance of com.yworks.yfiles.layout.planar.PlanarityTestWrapper.

Parameters
nonPlanarGraphHandler:InitialPlanarSubgraph — An instance of com.yworks.yfiles.layout.planar.InitialPlanarSubgraph which will should be used for non-planar graphs.
 
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
createPlanarization()method
public function createPlanarization(pi:PlanarInformation):void

Finds a planar subgraph in the specified graph and saves a planar embedding for it in pi. If the specified graph is planar, a planar embedding of the whole graph will be computed. Otherwise, another instance of com.yworks.yfiles.layout.planar.InitialPlanarSubgraph will be used to compute a planar subgraph. If the computed subgraph does not contain all edges, a list of missing edges can be obtained with hiddenEdges.

Parameters

pi:PlanarInformation — The graph for which a planar Subgraph should be computed.

See also

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

Returns
Class
initPlanarityTestWrapper()method 
protected final function initPlanarityTestWrapper(nonPlanarGraphHandler:InitialPlanarSubgraph):void

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

Parameters

nonPlanarGraphHandler:InitialPlanarSubgraph

See also

newPlanarityTestWrapper()method 
public static function newPlanarityTestWrapper(nonPlanarGraphHandler:InitialPlanarSubgraph):PlanarityTestWrapper

Creates an instance of com.yworks.yfiles.layout.planar.PlanarityTestWrapper.

Parameters

nonPlanarGraphHandler:InitialPlanarSubgraph — An instance of com.yworks.yfiles.layout.planar.InitialPlanarSubgraph which will should be used for non-planar graphs.

Returns
PlanarityTestWrapper

See also