Packagecom.yworks.yfiles.layout.planar
Classpublic class BCCSubgraph
InheritanceBCCSubgraph Inheritance YObject Inheritance Object
Implements InitialPlanarSubgraph

This class calculates a planar subgraph for the each biconnected component of the graph and then puts these planar subgraphs together.



Public Properties
 PropertyDefined By
  hiddenEdges : EdgeList
[read-only] Returns a list of edges that have been removed in order to gain a planarization of the input graph.
BCCSubgraph
Public Methods
 MethodDefined By
  
BCCSubgraph(ips:InitialPlanarSubgraph, init:Boolean = true)
BCCSubgraph
  
This method planarizes a graph by finding (a maximum) planar sub- graph.
BCCSubgraph
  
dispose():void
BCCSubgraph
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
BCCSubgraph
 Inherited
hashCode():int
YObject
  
[static]
BCCSubgraph
Protected Methods
 MethodDefined By
  
Initializes this object.
BCCSubgraph
  
This method traces the edge order of the embeddings of biconnected components.
BCCSubgraph
Property Detail
hiddenEdgesproperty
hiddenEdges:EdgeList  [read-only]

Returns a list of edges that have been removed in order to gain a planarization of the input graph. The createPlanarization method of this class must have been called earlier to compute the list of hidden edges. If not so, a runtime exception is thrown!


Implementation
    public function get hiddenEdges():EdgeList

Throws
Error — if createPlanarization has not been called prior to calling this method.

See also

Constructor Detail
BCCSubgraph()Constructor
public function BCCSubgraph(ips:InitialPlanarSubgraph, init:Boolean = true)

Parameters
ips:InitialPlanarSubgraph
 
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.
Method Detail
createPlanarization()method
public function createPlanarization(p:PlanarInformation):void

This method planarizes a graph by finding (a maximum) planar sub- graph. To gain a planar graph, sometimes some edges have to be removed in order to prevent crossings. The removed edges are returned by the method getHiddenEdges() below. A circular edge order is also computed. Note: the input graph is modified

Parameters

p:PlanarInformation — the PlanarInformation object associated with the input graph

dispose()method 
public function dispose():void

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

Returns
Class
initBCCSubgraph()method 
protected final function initBCCSubgraph(ips:InitialPlanarSubgraph):void

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

Parameters

ips:InitialPlanarSubgraph

See also

newBCCSubgraph()method 
public static function newBCCSubgraph(ips:InitialPlanarSubgraph):BCCSubgraph

Parameters

ips:InitialPlanarSubgraph

Returns
BCCSubgraph
traceComponentEdgeOrder()method 
protected function traceComponentEdgeOrder(edgeOrder:NodeMap):void

This method traces the edge order of the embeddings of biconnected components. The logged information is needed to build each node's circular edge order to gain a global (graph wide) embedding.

Parameters

edgeOrder:NodeMap