Packagecom.yworks.yfiles.layout.planar
Classpublic class Face
InheritanceFace Inheritance YObject Inheritance Object

This class represents a face (region) in a planar graph. A face is determined by the cyclic order of its adjacent edges.



Public Methods
 MethodDefined By
  
Face(init:Boolean = true)
Face
  
contains(node:Node):Boolean
Returns whether a given node is adjacent to the face.
Face
  
Returns a cursor over the edges in the face.
Face
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
Face
 Inherited
hashCode():int
YObject
  
insertEdges(e1:Edge, e2:Edge):void
Inserts two edges,which are reverse to each other, into the edge list of the face.
Face
  
Returns a cursor over the edge-pairs in the face.
Face
  
toString():String
Returns the edges in the face as string.
Face
Constructor Detail
Face()Constructor
public function Face(init:Boolean = true)



Parameters
init:Boolean (default = true)
Method Detail
contains()method
public function contains(node:Node):Boolean

Returns whether a given node is adjacent to the face.

Parameters

node:Node

Returns
Boolean
edges()method 
public function edges():EdgeCursor

Returns a cursor over the edges in the face.

Returns
EdgeCursor — An EdgeCursor over the edges in the face.
getClass()method 
override public function getClass():Class

Returns
Class
insertEdges()method 
public function insertEdges(e1:Edge, e2:Edge):void

Inserts two edges,which are reverse to each other, into the edge list of the face. This is needed to insert degree 1 nodes into a face

Parameters

e1:Edge — the first edge to be inserted.
 
e2:Edge — the second edge to be inserted. Precondition: source(e1) == target(e2) source(e2) == target(e1)

pairs()method 
public function pairs():EdgePairCursor

Returns a cursor over the edge-pairs in the face.

Returns
EdgePairCursor — an Edge{airCursor over the edge-pairs in the face.
toString()method 
public function toString():String

Returns the edges in the face as string.

Returns
String — A String containing the names of the edges in the face.