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

    Interface GcodePreviewControls

    interface GcodePreviewControls {
        frame(): void;
        setBuildVolume(def: BuildVolumeDef | MachineGeometry): void;
        setCameraMode(mode: CameraMode): void;
        setColorMode(mode: ColorMode): boolean;
        setKindVisible(kind: "extrude" | "travel", visible: boolean): void;
        setLayerRange(startLayer: number, endLayer: number): void;
        setQuality(quality: QualityMode | "auto"): void;
        setScrubPosition(segIndex: null | number): void;
        setShowRetractions(visible: boolean): void;
        setTheme(theme: Theme): void;
    }
    Index

    Methods

    frame setBuildVolume setCameraMode setColorMode setKindVisible setLayerRange setQuality setScrubPosition setShowRetractions setTheme

    Methods

    • Returns void

    • Switch camera projection (#150, DD-009 D3).

      Parameters

      Returns void

    • Parameters

      Returns boolean

    • Parameters

      • kind: "extrude" | "travel"
      • visible: boolean

      Returns void

    • Parameters

      • startLayer: number
      • endLayer: number

      Returns void

    • Parameters

      Returns void

    • Parameters

      • segIndex: null | number

      Returns void

    • Opt-in retraction/deretraction markers (DD-009 D1, #148). Off by default.

      Parameters

      • visible: boolean

      Returns void

    • Apply a bounded declarative theme (#153, DD-009 D4).

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods