Package com.structurizr.view
Class AutomaticLayout
java.lang.Object
com.structurizr.view.AutomaticLayout
A wrapper for automatic layout configuration.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumstatic enum -
Method Summary
Modifier and TypeMethodDescriptionintGets the edge separation (in pixels).Gets the name of the implementation to use.intGets the node separation (in pixels).Gets the rank direction.intGets the rank separation (in pixels).booleanReturns whether automatic layout has been applied.booleanGets whether the automatic layout algorithm should create vertices.voidsetApplied(boolean applied) Sets whether automatic layout has been applied.
-
Method Details
-
getImplementation
Gets the name of the implementation to use.- Returns:
- an enum representing Graphviz or Dagre
-
getRankDirection
Gets the rank direction.- Returns:
- a RankDirection enum
-
getRankSeparation
public int getRankSeparation()Gets the rank separation (in pixels).- Returns:
- a positive integer
-
getNodeSeparation
public int getNodeSeparation()Gets the node separation (in pixels).- Returns:
- a positive integer
-
getEdgeSeparation
public int getEdgeSeparation()Gets the edge separation (in pixels).- Returns:
- a positive integer
-
isVertices
public boolean isVertices()Gets whether the automatic layout algorithm should create vertices.- Returns:
- a boolean
-
isApplied
public boolean isApplied()Returns whether automatic layout has been applied.- Returns:
- true if automatic layout has been applied, false otherwise
-
setApplied
public void setApplied(boolean applied) Sets whether automatic layout has been applied.- Parameters:
applied- true if automatic layout has been applied, false otherwise
-