ILayoutAlgorithm describes the general interface for algorithms that perform a layout process on a LayoutGraph.
Remarks
The main method for invoking the layout calculation is applyLayout. Implementing classes will arrange the graph there.
This class also provides keys to register IDataProviders with the graph that contain information about the nodes and edges in the graph. IDataProviders registered with NODE_ID_DP_KEY and EDGE_ID_DP_KEY contain unique identifiers for both nodes and edges. These identifiers allow for ensuring consistent results even if the order of nodes and edges was changed between two layout runs.
The selection state of nodes and edges is stored in IDataProviders registered with the keys AFFECTED_NODES_DP_KEY and AFFECTED_EDGES_DP_KEY. Based on this information, the layout algorithm may reduce its calculations to the selected subset of nodes or edges.
Type Details
- yfiles module
- layout-core
- yfiles-umd modules
- All layout modules, view-layout-bridge
- Legacy UMD name
- yfiles.layout.ILayoutAlgorithm
See Also
Methods
Main layout routine that assigns new layout information to the given graph.
Remarks
Parameters
A map of options to pass to the method.
- graph - LayoutGraph
- the input graph