structurizr-d2-exporter icon indicating copy to clipboard operation
structurizr-d2-exporter copied to clipboard

Export structurizr views to D2 diagrams

trafficstars

Structurizr D2 Exporter

OpenSSF Scorecard OpenSSF Best Practices CodeQL Maven Central

The D2Exporter class provides a way to export Structurizr views to diagram definitions that are compatible with D2.

This library is developed to be included in the Structurizr CLI, and is available on Maven Central, for inclusion in your own Java applications:

  • groupId: io.github.goto1134
  • artifactId: structurizr-d2-exporter

amazon.png

Table of Content

  • Structurizr D2 Exporter
  • Table of Content
  • Customization
    • d2.title_position
    • d2.animation
    • d2.animated
    • d2.fill_pattern

Customization

d2.title_position

  • Entity: views, view
  • Values: top-left, top-center, top-right, center-left, center-right, bottom-left, bottom-center, bottom-right
  • Default: top-center

Specifies diagram title position. For more details, see d2 near.

Example:

Source: title-position/workspace.dsl

bottom-left title: title-position.png

d2.animation

  • Entity: views, view
  • Values: d2, frames, no
  • Default: d2

Specifies animation variant for animated structurizr views.

  • d2 is for d2 steps animation that allows you to produce animated images.
  • frames is for structurizr default frame animation. Unfortunately, it is not exportable yet.
  • no can be used in case you have animation steps, but do not want the animation.

Example:

amazon-animated.svg

d2.animated

Example

Source: animated-relation/workspace.dsl

animated-relation.svg

Hint: Do not forget to provide --animate-interval flag when producing SVG to see the animation.

d2.fill_pattern

When set on views or view, adds a fill pattern to the background. When set on an element style, adds fill pattern to its body.

Example

Source: fill-pattern/workspace.dsl

fill-pattern.png