prorm API Reference
    Preparing search index...

    Interface ToERDiagramOptions

    Options shared by the ER-producing adapters.

    interface ToERDiagramOptions {
        title?: string;
        columns?: number;
        hGap?: number;
        vGap?: number;
        theme?: "light" | "dark";
        color?: string;
        exclude?: string[];
    }

    Hierarchy

    Index
    title? columns? hGap? vGap? theme? color? exclude?
    title?: string

    Diagram title shown in the top banner

    columns?: number

    Number of entity columns in the grid.

    3
    hGap?: number

    Horizontal gap between entity boxes (px)

    vGap?: number

    Vertical gap between entity boxes (px)

    theme?: "light" | "dark"

    Accepted for backward compatibility and ignored: diagrams render in a single monochrome theme.

    color?: string

    Accepted for backward compatibility and ignored.

    exclude?: string[]

    Models to leave out, by model name. Handy for join tables and audit tables that add noise without adding information.

    Settings
    Member Visibility

    On This Page
    Properties