IFClite TypeScript API
    Preparing search index...

    Interface EmbedUrlParams

    Parameters that can be passed via URL to the embed viewer.

    Every field here is parsed by the viewer AND applied, as of #2934 -- hideAxis/hideScale and controls were marked NOT YET IMPLEMENTED here until then. The one deliberate exception is camera.zoom; see its doc below. Read that as a statement about the fields below, not as a guarantee this type enforces on fields added later: nothing here fails a build when a new field is parsed and then ignored, which is exactly how the three above drifted. A new field owes its own applying call site and a test that observes the effect.

    interface EmbedUrlParams {
        autoLoad?: boolean;
        bg?: string;
        camera?: { azimuth: number; elevation: number; zoom?: number };
        controls?: "orbit" | "pan" | "all" | "none";
        hideAxis?: boolean;
        hideScale?: boolean;
        hideTypes?: string[];
        isolate?: number[];
        modelUrl?: string;
        select?: number[];
        theme?: "light" | "dark";
        view?: ViewPreset;
    }
    Index
    autoLoad? bg? camera? controls? hideAxis? hideScale? hideTypes? isolate? modelUrl? select? theme? view?
    autoLoad?: boolean

    false suppresses the automatic fetch of modelUrl. Default: load.

    bg?: string

    Background colour, hex digits without the leading #.

    camera?: { azimuth: number; elevation: number; zoom?: number }

    Initial absolute camera orientation in degrees; the model is framed at that orientation. zoom is accepted for backwards compatibility and is NOT applied — the viewer has no absolute-zoom actuator and the field carries no unit, so framing comes from a fit instead.

    controls?: "orbit" | "pan" | "all" | "none"

    Restricts interactive orbit/pan/zoom (mouse, touch, keyboard, and spacemouse gestures) at the renderer's Camera. 'orbit' allows only orbit, 'pan' only pan, 'none' freezes the view (orbit, pan AND zoom all inert), 'all' is unrestricted. Does not gate programmatic moves — SET_CAMERA, ?camera=/?view=, or host SDK calls still work in every mode.

    hideAxis?: boolean

    true hides the axis triad overlay.

    hideScale?: boolean

    true hides the scale bar overlay.

    hideTypes?: string[]

    IFC class names to hide, e.g. IfcSpace. Arbitrary class names are accepted and matched case-insensitively, so IFCSPACE, ifcspace and IfcSpace all name the same class.

    isolate?: number[]

    Entity ids to isolate once the first model is on screen.

    modelUrl?: string

    Model to fetch on load. http(s) only; other schemes are rejected.

    select?: number[]

    Entity ids to select once the first model is on screen.

    theme?: "light" | "dark"
    view?: ViewPreset

    Preset view direction. Takes precedence over camera.

    Settings
    Member Visibility

    On This Page
    Properties