gcode-preview - v3.0.0-alpha.6
    Preparing search index...

    Interface GCodePreviewOptions

    Options for configuring the G-code preview

    interface GCodePreviewOptions {
        arcChordTolerance?: number;
        backgroundColor?: ColorRepresentation;
        boundingBoxColor?: ColorRepresentation;
        buildVolume?: BuildVolumeDef;
        canvas?: HTMLCanvasElement;
        devMode?: boolean | DevModeOptions;
        disableGradient?: boolean;
        droppable?: boolean;
        endLayer?: number;
        extrusionColor?: ColorRepresentation | ColorRepresentation[];
        extrusionWidth?: number;
        initialCameraPosition?: number[];
        keepLines?: boolean;
        lastSegmentColor?: ColorRepresentation;
        lineHeight?: number;
        lineWidth?: number;
        liveRenderInterval?: number;
        minLayerThreshold?: number;
        orthographic?: boolean;
        renderExtrusion?: boolean;
        renderTravel?: boolean;
        renderTubes?: boolean;
        startLayer?: number;
        topLayerColor?: ColorRepresentation;
        travelColor?: ColorRepresentation;
    }
    Index

    Properties

    arcChordTolerance? backgroundColor? boundingBoxColor? buildVolume? canvas? devMode? disableGradient? droppable? endLayer? extrusionColor? extrusionWidth? initialCameraPosition? keepLines? lastSegmentColor? lineHeight? lineWidth? liveRenderInterval? minLayerThreshold? orthographic? renderExtrusion? renderTravel? renderTubes? startLayer? topLayerColor? travelColor?

    Properties

    arcChordTolerance?: number

    Maximum deviation, in millimeters, between rendered G2/G3 arcs and the true arc (default 0.05). Lower values produce smoother arcs at the cost of more geometry; higher values trade smoothness for performance.

    backgroundColor?: ColorRepresentation

    Background color of the preview

    boundingBoxColor?: ColorRepresentation

    Color for the bounding box. If undefined, the bounding box is not rendered.

    buildVolume?: BuildVolumeDef

    Build volume dimensions

    canvas?: HTMLCanvasElement

    Canvas element to render into

    devMode?: boolean | DevModeOptions

    Enable developer mode with additional controls

    disableGradient?: boolean

    Disable color gradient between layers

    droppable?: boolean

    Enable drag and drop file handling

    endLayer?: number

    Last layer to render (1-based index)

    extrusionColor?: ColorRepresentation | ColorRepresentation[]

    Color(s) for extruded paths

    extrusionWidth?: number

    Width of extruded material, for paths whose width the slicer metadata did not announce (;WIDTH: comments always win per path; built-in default 0.6)

    initialCameraPosition?: number[]

    Initial camera position [x, y, z]

    keepLines?: boolean

    Keep the parsed G-code source on preview.parser.lines.

    Off by default. Nothing in the library reads the source back, and holding it costs several megabytes on a large file.

    lastSegmentColor?: ColorRepresentation

    Color for the last segment of each path

    lineHeight?: number

    Height of extruded lines, for paths whose height the slicer metadata did not announce (;HEIGHT: comments always win per path; built-in default 0.2)

    lineWidth?: number

    Width of rendered lines

    liveRenderInterval?: number

    How often, in milliseconds, the paths parsed so far are drawn while a G-code stream is being read.

    Defaults to 250. Lower values grow the model more smoothly — 0 draws on every chunk, effectively once per frame — but every draw adds a geometry batch, so very low values cost draw calls on large files.

    minLayerThreshold?: number

    Minimum layer height threshold

    orthographic?: boolean

    Use an orthographic (flat, no perspective distortion) camera instead of the default perspective camera

    renderExtrusion?: boolean

    Whether to render extrusion paths

    renderTravel?: boolean

    Whether to render travel moves

    renderTubes?: boolean

    Render paths as 3D tubes instead of lines

    startLayer?: number

    First layer to render (1-based index)

    topLayerColor?: ColorRepresentation

    Color for the top layer

    travelColor?: ColorRepresentation

    Color for travel moves

    Settings

    Member Visibility

    On This Page

    Properties