MAIDR JavaScript API
    Preparing search index...

    Interface GraphvizAdapterOptions

    Options for the figure a Graphviz drawing becomes.

    interface GraphvizAdapterOptions {
        id?: string;
        title?: string;
        subtitle?: string;
        caption?: string;
        nodeLabel?: string;
        layout?: "patchwork";
    }
    Index

    Properties

    id?: string

    The figure's id. Defaults to the SVG's own id, which the adapter sets when the drawing has none.

    title?: string

    The figure's title. Defaults to the graph's label, when it has one. Graphviz draws the graph's name (digraph Pipeline) nowhere a sighted reader sees it, so the name is never used.

    subtitle?: string

    The figure's subtitle.

    caption?: string

    The figure's caption.

    nodeLabel?: string

    What a node is on this graph -- Step, State, Module -- announced as the node noun. Defaults to MAIDR's own word for a node.

    layout?: "patchwork"

    The Graphviz layout that drew the graph, when it changes what the drawing means. 'patchwork' -- the layout that draws each node as a rectangle whose area is its area attribute, packed inside its clusters -- reads the drawing as a treemap. The SVG does not say which layout drew it, so this is the caller's to say.