Member Junction
    Preparing search index...

    Interface ERDConfig

    Configuration options for the ERD diagram.

    interface ERDConfig {
        animationDuration?: number;
        chargeStrength?: number;
        collisionPadding?: number;
        colors?: ERDColorScheme;
        crowsFoot?: boolean;
        dagreConfig?: ERDDagreConfig;
        emptyStateIcon?: string;
        emptyStateMessage?: string;
        enableDragging?: boolean;
        enableMultiSelect?: boolean;
        enablePan?: boolean;
        enableZoom?: boolean;
        fieldHeight?: number;
        fitOnLoad?: boolean;
        initialZoom?: number;
        layoutAlgorithm?: ERDLayoutAlgorithm;
        linkDistance?: number;
        maxFitZoom?: number;
        maxNodeHeight?: number;
        maxVisibleFields?: number;
        maxZoom?: number;
        minZoom?: number;
        nodeBaseHeight?: number;
        nodeWidth?: number;
        showAllFields?: boolean;
        showFieldDetails?: boolean;
        showHeader?: boolean;
        showLegend?: boolean;
        showMinimap?: boolean;
        showNodeCount?: boolean;
        showRelationshipLabels?: boolean;
        showSchemaBands?: boolean;
        skipAnimation?: boolean;
    }
    Index

    Properties

    animationDuration? chargeStrength? collisionPadding? colors? crowsFoot? dagreConfig? emptyStateIcon? emptyStateMessage? enableDragging? enableMultiSelect? enablePan? enableZoom? fieldHeight? fitOnLoad? initialZoom? layoutAlgorithm? linkDistance? maxFitZoom? maxNodeHeight? maxVisibleFields? maxZoom? minZoom? nodeBaseHeight? nodeWidth? showAllFields? showFieldDetails? showHeader? showLegend? showMinimap? showNodeCount? showRelationshipLabels? showSchemaBands? skipAnimation?

    Properties

    animationDuration?: number

    Duration of zoom/pan animations in milliseconds. Default: 750

    chargeStrength?: number

    Charge strength for force simulation (negative = repel)

    collisionPadding?: number

    Collision radius padding

    colors?: ERDColorScheme

    Colors for different node states

    crowsFoot?: boolean

    Draw crow's-foot markers at the source end of edges (many side). Default: true

    dagreConfig?: ERDDagreConfig

    Dagre-specific layout configuration (only used when layoutAlgorithm is 'dagre', 'horizontal', or 'vertical')

    emptyStateIcon?: string

    Icon class for empty state. Default: 'fa-solid fa-diagram-project'

    emptyStateMessage?: string

    Message to show when no nodes are provided. Default: 'No entities to display'

    enableDragging?: boolean

    Whether to enable node dragging

    enableMultiSelect?: boolean

    Enable multi-select with Ctrl+click. Default: false

    enablePan?: boolean

    Enable panning by dragging background. Default: true

    enableZoom?: boolean

    Whether to enable zoom/pan

    fieldHeight?: number

    Height per field in pixels

    fitOnLoad?: boolean

    Whether to auto-fit diagram to container on initial load. Default: true

    initialZoom?: number

    Initial zoom level

    layoutAlgorithm?: ERDLayoutAlgorithm

    Layout algorithm to use. Default: 'schema-grid'

    linkDistance?: number

    Link distance for force simulation

    maxFitZoom?: number

    Maximum zoom level applied during fit-to-view. Default 2.5 — allows small diagrams (e.g. Database Designer wizard preview with 1–3 entities) to scale up enough to fill the pane without looking "lost", while still letting manual zoom (wheel/pinch) go higher up to maxZoom.

    maxNodeHeight?: number

    Maximum height of a node in pixels

    maxVisibleFields?: number

    Max visible fields on a node before the "+N more" toggle kicks in. Default: Infinity when showAllFields is true; when showAllFields is false, only PK + FK fields are shown regardless of this value.

    maxZoom?: number

    Maximum zoom level. Default: 4

    minZoom?: number

    Minimum zoom level. Default: 0.1

    nodeBaseHeight?: number

    Base height of each node box in pixels

    nodeWidth?: number

    Width of each node box in pixels

    showAllFields?: boolean

    Whether to render all non-PK/non-FK fields as well. When true, every field on each node is rendered (PKs first, FKs next, then all other fields in declaration order). Use for "table card" style diagrams where users want to see every column. Defaults to false (classic schema-relationship view: keys only).

    showFieldDetails?: boolean

    Whether to show field details in nodes (PK + FK rows). Defaults to true.

    showHeader?: boolean

    Whether to show the header bar with controls. Default: true

    showLegend?: boolean

    Whether to show a legend explaining colors. Default: false

    showMinimap?: boolean

    Whether to show a minimap for navigation. Default: false

    showNodeCount?: boolean

    Whether to show node count in header. Default: true

    showRelationshipLabels?: boolean

    Whether to show relationship labels

    showSchemaBands?: boolean

    Draw rounded rectangular bands grouping nodes by schema. Default: true (schema-grid layout only)

    skipAnimation?: boolean

    Skip the D3 force simulation animation and render immediately. When true, the simulation runs to completion synchronously and nodes are positioned immediately without animation. Default: false

    Settings

    Member Visibility

    On This Page

    Properties