Mermaid: {
    codeToUrl(this: void, code: string, edit?: boolean): string;
    escape(this: void, text: string): string;
    escapeId(this: void, text: string | number): string;
    name: "Mermaid";
    replacements: {
        _: "#95;";
        "-": "#45;";
        ":": "#58;";
        "'": "#39;";
        "\"": "#34;";
        "[": "#91;";
        "]": "#93;";
        "{": "#123;";
        "}": "#125;";
        "*": "#42;";
        "\\": "#92;";
        "\\n": "\n";
        "&": "#38;";
        "`": "#96;";
        "→": "#8594;";
        "↔": "#8596;";
        "⇒": "#8658;";
        "⇔": "#8660;";
        "∀": "#8704;";
        "∃": "#8707;";
        "∈": "#8712;";
        "∉": "#8713;";
        "∋": "#8715;";
        "∌": "#8716;";
        "+": "#43;";
        "<": "#60;";
        ">": "#62;";
        "¬": "#172;";
        "∧": "#8743;";
        "∨": "#8744;";
        "∩": "#8745;";
        "∪": "#8746;";
        "∫": "#8747;";
        "⊕": "#8853;";
    };
} = ...

Global mermaid helper object with useful functions.

Type declaration

  • codeToUrl:function
    • Converts mermaid code (potentially produced by DataflowMermaid.convert) to an url that presents the graph in the mermaid editor.

      Parameters

      • this: void
      • code: string

        code to convert

      • edit: boolean = false

        if true, the url will point to the editor, otherwise it will point to the viewer

      Returns string

  • escape:function
    • Escapes markdown special characters in a string.

      Parameters

      • this: void
      • text: string

      Returns string

  • escapeId:function
    • Escapes a string or number to be used as a mermaid node id.

      Parameters

      • this: void
      • text: string | number

      Returns string

  • Readonlyname: "Mermaid"
  • Readonlyreplacements: {
        _: "#95;";
        "-": "#45;";
        ":": "#58;";
        "'": "#39;";
        "\"": "#34;";
        "[": "#91;";
        "]": "#93;";
        "{": "#123;";
        "}": "#125;";
        "*": "#42;";
        "\\": "#92;";
        "\\n": "\n";
        "&": "#38;";
        "`": "#96;";
        "→": "#8594;";
        "↔": "#8596;";
        "⇒": "#8658;";
        "⇔": "#8660;";
        "∀": "#8704;";
        "∃": "#8707;";
        "∈": "#8712;";
        "∉": "#8713;";
        "∋": "#8715;";
        "∌": "#8716;";
        "+": "#43;";
        "<": "#60;";
        ">": "#62;";
        "¬": "#172;";
        "∧": "#8743;";
        "∨": "#8744;";
        "∩": "#8745;";
        "∪": "#8746;";
        "∫": "#8747;";
        "⊕": "#8853;";
    }

    Replacements applied by escape functions!