Package com.structurizr.view

Class AutomaticLayout

java.lang.Object

com.structurizr.view.AutomaticLayout

public final class AutomaticLayout
extends Object

A wrapper for automatic layout configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AutomaticLayout.Implementation
static enum	AutomaticLayout.RankDirection

Method Summary

Modifier and Type	Method	Description
int	getEdgeSeparation()	Gets the edge separation (in pixels).
AutomaticLayout.Implementation	getImplementation()	Gets the name of the implementation to use.
int	getNodeSeparation()	Gets the node separation (in pixels).
AutomaticLayout.RankDirection	getRankDirection()	Gets the rank direction.
int	getRankSeparation()	Gets the rank separation (in pixels).
boolean	isVertices()	Gets whether the automatic layout algorithm should create vertices.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getImplementation

public AutomaticLayout.Implementation getImplementation()

Gets the name of the implementation to use.

Returns:

an enum representing Graphviz or Dagre

getRankDirection

public AutomaticLayout.RankDirection 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