Skip to main content

Graphviz rendering

Overview​

We provide a function to render a use-coordination specification to Graphviz DOT format. The functionality described on this page is available in the sub-package @use-coordination/graphviz-renderer (and not contained in the main use-coordination package).

To make this approach as modular as possible, we do not include the functionality to render the DOT-formatted string to an image. We leave the choice of Graphviz rendering engine to the user.

toGraphviz(spec)​

Parameters:​

  • spec (object) - The specification to render to DOT format.

Returns:​

  • Type: string - The DOT-formatted string.
import { toGraphviz } from '@use-coordination/graphviz-renderer';