MAIDR JavaScript API
    Preparing search index...

    Interface MermaidAdapterOptions

    Options for createMaidrFromMermaid and the binding helpers.

    interface MermaidAdapterOptions {
        id?: string;
        title?: string;
        subtitle?: string;
        caption?: string;
        idPrefix?: string;
    }
    Index

    Properties

    id? title? subtitle? caption? idPrefix?

    Properties

    id?: string

    Unique ID for the MAIDR figure. Defaults to the SVG element's id.

    title?: string

    Figure title. Defaults to the diagram's own title, when it has one.

    subtitle?: string

    Figure subtitle.

    caption?: string

    Figure caption. Defaults to the diagram's accessible description.

    idPrefix?: string

    The id the diagram was rendered under, which Mermaid prefixes its element ids with. Defaults to the SVG element's id; set it when the SVG was renamed after rendering, as Quarto does to a labelled diagram.

    Settings

    Member Visibility

    On This Page

    Properties