This class represents the layout context.
Remarks
Type Details
- yfiles module
- layout-multipage
- yfiles-umd modules
- layout-multipage, layout
- Legacy UMD name
- yfiles.multipage.LayoutContext
Properties
Gets the relevant graph.
Gets the layouter object that belongs to this layout context.
Methods
Adds a label to a given edge.
Parameters
A map of options to pass to the method.
- label - IEdgeLabelLayout
- the label that should be added to the given edge
- labeledElement - Edge
- the edge to which the label should be added
Adds a label to a given node.
Parameters
A map of options to pass to the method.
- label - INodeLabelLayout
- the label that should be added to the given node
- labeledElement - YNode
- the node to which the label should be added
All methods of the IElementFactory have to use this method to create an edge.
Parameters
A map of options to pass to the method.
- source - YNode
- the source of the edge
- target - YNode
- the target of the edge
- sameDataElementId - Object
- the ID of the edge whose data should be copied to the created edge (or
nullif no data should be copied)
Returns
- ↪Edge
- the created edge
See Also
All methods of the IElementFactory have to use this method to create a node.
Returns the edge label information object of the given edge label layout.
Parameters
A map of options to pass to the method.
- edgeLabelLayout - IEdgeLabelLayout
- the edge label layout for which the information object should be returned
Returns
- ↪IEdgeLabelInfo
- the edge label information object of the given edge label layout
Implements
Returns the node label layout information object of the given node label layout.
Parameters
A map of options to pass to the method.
- nodeLabelLayout - INodeLabelLayout
- the node label layout for which the information object should be returned
Returns
- ↪INodeLabelInfo
- the node label information object of the given node label layout
Implements
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.
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.
Removes a label from a given edge.
Parameters
A map of options to pass to the method.
- label - IEdgeLabelLayout
- the label that should be removed
- labeledElement - Edge
- the edge owning the label
Removes a label from a given node.
Parameters
A map of options to pass to the method.
- label - INodeLabelLayout
- the label that should be removed
- labeledElement - YNode
- the node owning the label