:atlas-graphviz/atlas.graphviz/GraphvizSpec

GraphvizSpec

interface GraphvizSpec : AtlasSpec(source)

Used to configure Graphviz output from Atlas. For barebones output to a .dot file, you can just add the "dev.jonpoulton.atlas.graphviz" gradle plugin. Or for a more fleshed-out config:

atlas {
  // other Atlas config

  graphviz {
    pathToDotCommand = "/custom/path/to/dot"
    fileFormat = FileFormat.Svg
    layoutEngine = LayoutEngine.Dot

    node {
      ...
    }

    edge {
      ...
    }

    graph {
      ...
    }
  }
}

Properties

edge

abstract val edge: EdgeAttributes

Configure the attributes applied by default to all links between nodes, unless overridden by that link's GraphvizLinkTypeSpec.

fileFormat

abstract val fileFormat: Property<FileFormat>

Manually interact with output formats from Graphviz. Defaults to FileFormat.Svg.

graph

abstract val graph: GraphAttributes

Configure the attributes applied to the root graph.

layoutEngine

abstract val layoutEngine: Property<LayoutEngine>

Customise the layout engine used to organise your module nodes in the chart. Defaults to LayoutEngine.Dot.

node

abstract val node: NodeAttributes

Configure the attributes applied by default to all module nodes, unless overridden by that node's GraphvizModuleTypeSpec.

pathToDotCommand

abstract val pathToDotCommand: Property<String>

Use this if you want to specify a "dot" command which isn't on the system path. This should be an absolute path.

Functions

edge

abstract fun edge(action: Action<EdgeAttributes>)

graph

abstract fun graph(action: Action<GraphAttributes>)

node

abstract fun node(action: Action<NodeAttributes>)