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

    Interface ModelViewerOptions

    interface ModelViewerOptions {
        background?: ModelBackground;
        cameraMode?: CameraMode;
        createControls?: (
            camera: PerspectiveCamera | OrthographicCamera,
            domElement: HTMLElement,
        ) => ControlsLike;
        createRenderer?: (canvas: RenderTargetCanvas) => GLRendererLike;
        filamentPalette?: readonly (undefined | string)[];
        interactionQuality?: "off" | "auto";
        limits?: ModelLimits;
        loaders?: readonly ModelLoader[];
        onProgress?: (progress: LoadProgress) => void;
        renderScope?: RenderScope;
    }
    Index

    Properties

    background? cameraMode? createControls? createRenderer? filamentPalette? interactionQuality? limits? loaders? onProgress? renderScope?

    Properties

    background?: ModelBackground

    'transparent' (default) | CSS colour | 0xRRGGBB (DD-018).

    cameraMode?: CameraMode

    Initial camera projection; default 'perspective'.

    createControls?: (
        camera: PerspectiveCamera | OrthographicCamera,
        domElement: HTMLElement,
    ) => ControlsLike

    Injected orbit controls (tests). Default: three OrbitControls via the stage.

    createRenderer?: (canvas: RenderTargetCanvas) => GLRendererLike

    Injected GL (tests / exotic hosts). Default: the shared stage builder with alpha on.

    filamentPalette?: readonly (undefined | string)[]

    3MF paint_color palette override (hex #RRGGBB per 0-based slot); parity with renderModelStill.

    interactionQuality?: "off" | "auto"

    DD-020 interaction-aware quality; default 'auto' (the interactive default).

    limits?: ModelLimits

    Source-model triangle / byte caps (DD-018 ModelLimits).

    loaders?: readonly ModelLoader[]

    Loader registry (open kind). Default: [stlLoader, threeMfLoader].

    onProgress?: (progress: LoadProgress) => void

    Staged loading-progress callback (DD-024): typed stage/done/total/unit events (no human copy), each tagged with the load generation so a consumer drops events from a superseded setSource. The consumer owns all wording/i18n. Events from a superseded load are not emitted.

    renderScope?: RenderScope

    Initial render scope (DD-030 D2) — e.g. { plateId: 3 }. Omit to render the whole source.

    Settings

    Member Visibility

    On This Page

    Properties