G-code Preview — API Reference
    Preparing search index...

    Interface BuildVolumeStyle

    Themed styling (DD-009 D4, #153). Omitted fields keep the original constants; the origin tripod (semantic RGB axes) is never themed.

    interface BuildVolumeStyle {
        bedOutline?: ThemeBedOutline;
        bedSurface?: BedSurface;
        boxColor?: ThemeColor;
        boxOpacity?: number;
        gridColor?: ThemeColor;
        gridMajor?: ThemeGridMajor;
        gridOpacity?: number;
        showCage?: boolean;
    }
    Index
    bedOutline? bedSurface? boxColor? boxOpacity? gridColor? gridMajor? gridOpacity? showCage?
    bedOutline?: ThemeBedOutline

    Bed boundary loop for every shape, rect included (DD-032), drawn above the grid. When set, grid lines lying on the bed edge and the cage's floor edges are not drawn: the outline replaces them. Omit: no loop on rect beds, today's grid-colored loop (opacity +0.3) on non-rect beds.

    bedSurface?: BedSurface

    Build-plate surface (#185); default { mode: 'none' } (bare grid).

    boxColor?: ThemeColor
    boxOpacity?: number
    gridColor?: ThemeColor
    gridMajor?: ThemeGridMajor

    Major grid tier (DD-032). every snaps to whole minor pitches: every k-th minor line (by integer index from the bed minimum, k = max(1, round(every / grid))) is drawn as a major line instead. So every: 50 on a 15 mm grid gives majors every 45 mm, and a grid-pitch change never throws. Omit for one tier.

    gridOpacity?: number
    showCage?: boolean

    Show the full build-volume wireframe cage (the box up to def.z). Default true. When false, only the bed/plate (grid + surface + origin) shows — the cage is decoupled from the plate (#306/#6), so a consumer can present the printable bed without the whole machine volume.

    Settings
    Member Visibility

    On This Page
    Properties