C

MultiPageLayoutContext

Show Usages
This class represents the layout context.
Inheritance Hierarchy

Remarks

It provides several methods to access data as well as adding and removing elements.

This class cannot be instantiated

Members

No filters for this type

Methods

getEdgeId

(edge: LayoutEdge): any
Gets the unique ID of the associated edge.
final

Parameters

edge: LayoutEdge
The edge for which to retrieve the unique ID.

Return Value

any
The ID of the associated edge.

See Also

API
EDGE_ID_DATA_KEY

getEdgeLabelId

(label: LayoutEdgeLabel): any
Gets the unique ID of the associated edge label.
final

Parameters

label: LayoutEdgeLabel
The edge label for which to retrieve the unique ID.

Return Value

any
the unique ID of the associated edge label

See Also

API
EDGE_LABEL_ID_DATA_KEY

getEdgeType

(edge: LayoutEdge): MultiPageEdgeType
Gets the type of the associated edge.
final

Parameters

edge: LayoutEdge
The edge for which to retrieve the associated type.

Return Value

MultiPageEdgeType
The type of the associated edge.

getNodeId

(node: LayoutNode): any
Gets the unique ID of the given node.
final

Parameters

node: LayoutNode
The node for which to retrieve the unique ID.

Return Value

any
the ID of the node

See Also

API
NODE_ID_DATA_KEY

getNodeLabelId

(label: LayoutNodeLabel): any
Gets the unique ID of the associated node label.
final

Parameters

label: LayoutNodeLabel
The node label for which to retrieve the unique ID.

Return Value

any
the unique ID of the associated node label

See Also

API
NODE_LABEL_ID_DATA_KEY

getNodeType

(node: LayoutNode): MultiPageNodeType
Gets the type of the given node.
final

Parameters

node: LayoutNode
The node for which to retrieve the associated type.

Return Value

MultiPageNodeType
The type of the node

See Also

Developer's Guide

getPage

(node: LayoutNode): number
Gets the page number of the page graph that contains the node associated with the given node.
This information is first available after the layout run.
final

Parameters

node: LayoutNode
The node for which to retrieve the associated page number.

Return Value

number
the page number of the page graph that contains the node associated with the given node

getPageEdge

(edgeId: any): LayoutEdge
Returns the edge of a page graph (a graph that represents the result of the multi-page layout) with the given ID or null if there is no such edge.
final

Parameters

edgeId: any
the ID of the edge that should be returned

Return Value

LayoutEdge
the edge of a page graph with the given ID or null if there is no such edge

getPageNode

(nodeId: any): LayoutNode
Returns the node of a page graph (a graph that represents the result of the multi-page layout) with the given ID or null if there is no such node.
final

Parameters

nodeId: any
the ID of the node that should be returned

Return Value

LayoutNode
the node of a page graph with the given ID or null if there is no such node

getReferencingNode

(node: LayoutNode): LayoutNode
Gets the node that refers to the one associated with the given node.
More precisely, if the node associated with this info object
final

Parameters

node: LayoutNode
The node for which to retrieve the referencing node.

Return Value

LayoutNode
the node that refers to the one associated with the given node

See Also

API
CONNECTOR, PROXY, PROXY_REFERENCE, useProxyReferenceNodes

getRepresentedEdge

(edge: LayoutEdge): LayoutEdge
Gets the original edge associated with this info.
More precisely, for edges of type CONNECTOR, this method returns the edge of the input graph that was split by the connector edge. Otherwise, it returns null.
final

Parameters

edge: LayoutEdge
The edge for which to retrieve the original associated edge.

Return Value

LayoutEdge
The original edge if the type of the edge is CONNECTOR, null otherwise

See Also

API
CONNECTOR

getRepresentedNode

(node: LayoutNode): LayoutNode
Gets the node of the input graph that is represented by the given node.
Note that, for the special nodes inserted to guarantee that no information is lost, there are no corresponding nodes in the input graph. Hence, special nodes are mapped to common nodes in the following way:
  • A CONNECTOR node is mapped to the common node connected to the matching connector.
  • A PROXY node is mapped to the associated common node (i.e., the proxy is a copy of that node).
  • A PROXY_REFERENCE node is not mapped to any node, and, thus this method returns null for such nodes.
All nodes of the pageGraphs are created by the layout algorithm, the input graph remains unchanged. Matching elements are mapped to the same item ID, see getOriginalItem . This method always returns a node of the input graph!
final

Parameters

node: LayoutNode
The node for which to retrieve the associated node.

Return Value

LayoutNode
the node of the input graph that is represented by the given node