Last updated on
Sep 15, 2025
Note
Documentation for Substance Automation Toolkit is now included in the SAT package. You can access the documentation by opening html-doc.zip inside your downloaded SAT package.
ag_layout
Module ag_layout provides the definition of the functions layoutGraph(), and layoutDoc() for automatically organizing the nodes in a graph or all graphs in a document respectively.
class autograph.ag_layout.NodesToKeepEnum
Bases: object
Enumeration of what nodes to keep when laying out a graph
KEEP_ALL_NODES= 0 KEEP_COMPUTED_NODES= 1 KEEP_COMPUTED_AND_INPUT_NODES= 2
class autograph.ag_layout.GUIElementsToKeepEnum
Bases: object
Enumeration treatments of gui elements when laying out a graph
KEEP_ALL= 0 KEEP_NONE= 1 KEEP_NON_EMPTY= 2
class autograph.ag_layout.GraphFlowDirectionEnum
Bases: object
Enumeration layout directions for graphs
RIGHTWARD= 0 UPWARD= 1
class autograph.ag_layout.GraphLayoutAlignment
Bases: object
Enumeration what side of a graph to align when laying out a graph
OUTPUTS= 0 INPUTS= 1
autograph.ag_layout.layoutGraph(graph, aNodeSpacing=160, aNodeShift=(80, 0), nodesToKeep=0, layoutAlignment=0, commentsToKeep=0, framesToKeep=0, navigationPinsToKeep=0)
Lays out a graph
| Parameters: |
|
|---|---|
| Returns: | None |
autograph.ag_layout.layoutDoc(sbsDoc, aNodeSpacing=160, aNodeShift=(80, 0), nodesToKeep=0, layoutAlignment=0, commentsToKeep=0, framesToKeep=0, navigationPinsToKeep=0)
Layout all graphs in an sbs document
| Parameters: |
|
|---|---|
| Returns: | None |
