Interface MermaidConfig

Mermaid configuration options See: https://mermaid.js.org/config/schema-docs/config.html

interface MermaidConfig {
    class?: {
        arrowMarkerAbsolute?: boolean;
    };
    er?: {
        entityPadding?: number;
        layoutDirection?: "TB" | "LR" | "RL" | "BT";
        minEntityHeight?: number;
        minEntityWidth?: number;
    };
    flowchart?: {
        curve?: "linear" | "basis" | "step" | "stepBefore" | "stepAfter";
        defaultRenderer?: "dagre-d3" | "dagre-wrapper" | "elk";
        padding?: number;
        useMaxWidth?: boolean;
    };
    fontFamily?: string;
    fontSize?: number;
    gantt?: {
        barGap?: number;
        barHeight?: number;
        fontSize?: number;
        gridLineStartPadding?: number;
        leftPadding?: number;
        titleTopMargin?: number;
        topPadding?: number;
    };
    logLevel?: "error" | "info" | "debug" | "warn" | "fatal";
    securityLevel?: "strict" | "loose" | "sandbox";
    sequence?: {
        boxMargin?: number;
        boxTextMargin?: number;
        diagramMarginX?: number;
        diagramMarginY?: number;
        messageMargin?: number;
        mirrorActors?: boolean;
        noteMargin?: number;
        showSequenceNumbers?: boolean;
    };
    state?: {
        dividerMargin?: number;
        padding?: number;
        sizeUnit?: number;
    };
}

Properties

class? er? flowchart? fontFamily? fontSize? gantt? logLevel? securityLevel? sequence? state?

Properties

Optional class

class?: {
    arrowMarkerAbsolute?: boolean;
}

Class diagram configuration

Type declaration

  • Optional arrowMarkerAbsolute?: boolean

Optional er

er?: {
    entityPadding?: number;
    layoutDirection?: "TB" | "LR" | "RL" | "BT";
    minEntityHeight?: number;
    minEntityWidth?: number;
}

ER diagram configuration

Type declaration

  • Optional entityPadding?: number
  • Optional layoutDirection?: "TB" | "LR" | "RL" | "BT"
  • Optional minEntityHeight?: number
  • Optional minEntityWidth?: number

Optional flowchart

flowchart?: {
    curve?: "linear" | "basis" | "step" | "stepBefore" | "stepAfter";
    defaultRenderer?: "dagre-d3" | "dagre-wrapper" | "elk";
    padding?: number;
    useMaxWidth?: boolean;
}

Flowchart-specific configuration

Type declaration

  • Optional curve?: "linear" | "basis" | "step" | "stepBefore" | "stepAfter"
  • Optional defaultRenderer?: "dagre-d3" | "dagre-wrapper" | "elk"
  • Optional padding?: number
  • Optional useMaxWidth?: boolean

Optional fontFamily

fontFamily?: string

Font configuration (applies to all diagrams)

Optional fontSize

fontSize?: number

Optional gantt

gantt?: {
    barGap?: number;
    barHeight?: number;
    fontSize?: number;
    gridLineStartPadding?: number;
    leftPadding?: number;
    titleTopMargin?: number;
    topPadding?: number;
}

Gantt chart configuration

Type declaration

  • Optional barGap?: number
  • Optional barHeight?: number
  • Optional fontSize?: number
  • Optional gridLineStartPadding?: number
  • Optional leftPadding?: number
  • Optional titleTopMargin?: number
  • Optional topPadding?: number

Optional logLevel

logLevel?: "error" | "info" | "debug" | "warn" | "fatal"

Log level for debugging

Optional securityLevel

securityLevel?: "strict" | "loose" | "sandbox"

Security level

Optional sequence

sequence?: {
    boxMargin?: number;
    boxTextMargin?: number;
    diagramMarginX?: number;
    diagramMarginY?: number;
    messageMargin?: number;
    mirrorActors?: boolean;
    noteMargin?: number;
    showSequenceNumbers?: boolean;
}

Sequence diagram configuration

Type declaration

  • Optional boxMargin?: number
  • Optional boxTextMargin?: number
  • Optional diagramMarginX?: number
  • Optional diagramMarginY?: number
  • Optional messageMargin?: number
  • Optional mirrorActors?: boolean
  • Optional noteMargin?: number
  • Optional showSequenceNumbers?: boolean

Optional state

state?: {
    dividerMargin?: number;
    padding?: number;
    sizeUnit?: number;
}

State diagram configuration

Type declaration

  • Optional dividerMargin?: number
  • Optional padding?: number
  • Optional sizeUnit?: number

Settings

Member Visibility

Theme

On This Page

classerflowchartfontFamilyfontSizeganttlogLevelsecurityLevelsequencestate