Variable DataflowMermaidConst

Type Declaration

• convert: function

  • convert(
        this: void,
        config: MermaidGraphConfiguration,
    ): { mermaid: MermaidGraph; string: string }

    Converts a dataflow graph to mermaid graph code that visualizes the graph.

    Parameters

    • this: void
    • config: MermaidGraphConfiguration

    Returns { mermaid: MermaidGraph; string: string }

    See

    DataflowMermaid.url - render the given graph to a url to mermaid.live

• Readonlyname: "DataflowMermaid"

• raw: function

  • raw(
        this: void,
        graph: DataflowInformation | DataflowGraph<DataflowGraphVertexInfo, DfEdge>,
        includeEnvironments?: boolean,
        mark?: ReadonlySet<NodeId>,
        simplified?: boolean,
        qualifyBaseR?: boolean,
    ): string

    This is a simplified version of DataflowMermaid.convert

    Parameters

    • this: void
    • graph: DataflowInformation | DataflowGraph<DataflowGraphVertexInfo, DfEdge>
    • OptionalincludeEnvironments: boolean
    • Optionalmark: ReadonlySet<NodeId>
    • simplified: boolean = false
    • qualifyBaseR: boolean = true

    Returns string

• url: function

  • url(
        this: void,
        graph: DataflowInformation | DataflowGraph<DataflowGraphVertexInfo, DfEdge>,
        includeEnvironments?: boolean,
        mark?: ReadonlySet<NodeId>,
        simplified?: boolean,
        qualifyBaseR?: boolean,
    ): string

    Converts a dataflow graph to a mermaid url that visualizes the graph. This is basically a combination of DataflowMermaid.raw and Mermaid.codeToUrl.

    Parameters

    • this: void
    • graph: DataflowInformation | DataflowGraph<DataflowGraphVertexInfo, DfEdge>

      the dataflow graph to render

    • OptionalincludeEnvironments: boolean

      whether to include the environment content in the output

    • Optionalmark: ReadonlySet<NodeId>

      which vertices to highlight in the visualization

    • simplified: boolean = false

      whether to show a simplified use of the graph with fewer details on the vertices and edges

    • qualifyBaseR: boolean = true

      show the edge-free base-R qualification (stats::acf); false when the signature database is disabled

    Returns string