Represents an embedding of a planar graph.
Inheritance Hierarchy
PlanarEmbedding
Remarks
A planar embedding is represented by a list of faces. Each face is represented by a list of Darts which describe the border of the face.
Type Details
- yFiles module
- algorithms
Querying the planar embedding after changes to the underlying graph structure may produce exceptions.
Constructors
Creates a new embedding for the specified planar graph.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- graph - LayoutGraph
- A planar graph
Throws
- Exception({ name: 'ArgumentError' })
- If the specified graph is not planar
Properties
Gets the IList<T> that represents the outer face.
Property Value
The IList<T> that represents the outer face.
See Also
The returned list is also contained in the face lists.
Methods
Returns the two darts associated with the given edge.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- edge - LayoutEdge
- an edge
Returns
- ↪Dart[]
- the two darts associated with the given edge
Returns a IList<T> containing the (cyclic ordered) outgoing darts of the specified node.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- node - LayoutNode
- A node
Returns
- ↪IList<Dart>
- An IList<T> containing the (cyclic ordered) outgoing darts
Static Methods
Return whether or not the given graph is planar.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- graph - LayoutGraph
- the input graph
Returns
- ↪boolean
trueif the given graph is planar,falseotherwise