Embed the IFC viewer in your own product

Mount into a CSS selector or element. See the options below.

Create a viewer and resolve once it is ready to accept commands.

Load IFC bytes (ArrayBuffer/Uint8Array) from your app. The buffer is transferred for a zero-copy hand-off.

Load a public, CORS-enabled IFC URL.

Unload a model by id.

Remove all loaded models.

Select and frame an element — by IFC expressID, or by GlobalId (which also finds its model).

Fly to a named view of the scene — iso, front, back, left, right, top, bottom — with all of it in frame. Fire-and-forget (between 1.14 and 1.17 the viewer ignored it).

Frame for presentation: the model fills `fill` of the frame (0.2–0.98, default 0.85), fitted to its corners rather than its bounding sphere. azimuth / elevation look from any angle.

Frame one element (expressID): from the current angle unless a view is given. Rejects when it is not in the model.

Frame the active model from the current angle, with a margin / reset the camera.

Place the camera at a position looking along a direction.

Where the camera is and what it looks at — save it, restore it with lookAt.

Fly the camera to a position, looking at a target (scene metres, Y up).

First-person walk mode (WASD, drag to look, Esc to leave). Emits walk-changed.

Whether walk mode is on, and at what speed.

Isolate a category (e.g. "IfcWall"); omit to clear.

Restore full visibility (clear hidden + isolation).

Hide / show a set of elements by expressID.

Show or hide one model of a federated scene without unloading it.

Ghost a model (0.05–1) — e.g. the architecture around the MEP.

Show only this model; null shows them all again.

Change the scene background: a preset ('white', 'paper', 'blueprint', 'sky', 'studio'), '#rrggbb', '#top,#bottom' or { top, bottom }. Not saved as the visitor's own preference.

The current scene background.

Re-theme the UI accent at runtime (#rrggbb).

Switch the client skin on or off — the stakeholder view, same as ui: 'client'.

'quality' turns on the heavier rendering for a hero shot; 'standard' for everyday.

Real shadows at a site-local date and time: { date: '06-21', time: '18:00' }. The site comes from the IFC georeference; pass location for a model without one — never a silent default city.

Date, time and time zone of the study, and where the site is.

Put the model on the map with terrain and OpenStreetMap surroundings. Calling it is your page declaring tile consent for its visitors; show the attributions.

Map mode state, the placement, and the attributions you must display.

Open another scene: a .scene.json URL, or a scene document (it travels packed in the frame address, so it must fit a link). The viewer reloads with it; waiting calls are rejected and ready fires again.

The scene on screen as a scene document — models by URL, layers, twin, map, camera — with the sources to credit and a link that carries it.

Pack a scene document for a #scene= link yourself (null when too big for a link).

The catalogue of live public sources, named in the viewer language, with what each needs in a browser (a key, a proxy) and whether it has data near the site.

Add a layer: a catalogue source ({ preset }), GeoJSON or a live feed at a URL ({ url, live }), or GeoJSON you already have ({ geojson }). Session-only: never saved into the visitor’s layers.

Every data layer: status, feature counts, extent, refresh and attribution.

Show or hide a layer.

Fly the camera to a layer’s features.

Remove a layer.

The operational twin now: device sources (state, last reading) and, per binding, the matching rule, its colour, the label value and whether it is alerting.

Add a section plane. { level: 'Level 1' } is a floor plan at that storey; { axis: 'x', offset: 4.5 } a section at 4.5 m.

Move, toggle or flip a plane.

Remove one plane, or every cut when no id is given.

A section box around the model or the selection; false removes it.

Every plane, the box, and the storeys available for level cuts.

Start a built-in tour: 'social', 'client-walkthrough' or 'technical-review' (walks the validation issues). Played by the viewer's own tour bar.

Play a tour you authored: camera stops with captions, highlights and isolated classes. autoplay: true or ms per stop.

Move between stops.

Turn self-running on or off for the tour playing now.

Stop the tour and give the camera back.

The tour and its stops, in the shape playTour() takes — save it, replay it later.

The built-in director recipes (meeting demo, reel, LinkedIn teaser, launch, editorial looks…).

Turn the model into an edited video from a recipe: shots planned from the IFC, captions, music. Opens Clip Studio with the result. Follow presentation-progress.

Encode the presentation in the visitor’s browser and receive the MP4 bytes — upload them, attach them, or play them in a <video>.

Close Clip Studio.

The recipes, templates, formats and palettes Cover Studio offers.

Make a cover: run a recipe (it captures the views it needs), then set template, format, palette and texts. Opens Cover Studio, still editable.

The cover as it stands, or null when Cover Studio is closed.

Export it: png / jpeg (one page), pdf / pptx (the whole document), zip (every page). Returns the bytes.

Close Cover Studio.

Boot a lazy viewer now (what the poster button does). Calls made before were queued.

Scrollytelling: while each paragraph crosses the middle of the screen, frame, isolate, move the sun or run your own code. Returns an unbind function.

A slow idle orbit (degrees per second; false stops it). Stops at the first touch; never under reduced motion.

Expand the figure to the whole screen, or back.

Stop or resume painting frames. pauseOffscreen does it for you.

Every group in the scene — inferred from the IFC (project, site, location) and made by users.

Create a group, optionally with models in it. Resolves with its id.

Rename or delete a user group. Automatic groups cannot be edited.

Move a model or point cloud into a group; null gives it back to automatic grouping, 'loose' leaves it in none.

Show or hide a whole group, or show only one.

Fit the camera to a group — hidden members included.

Arm a measuring tool for the visitor (opens the Measure panel), or 'none'. Results arrive on measurements-changed.

Every measurement on screen. Values are SI — metres, m², degrees — whatever the viewer displays.

Remove one measurement, or all of them.

List the loaded models. Returns a promise.

Find elements by IFC class, GlobalId and/or name across the loaded models. Each hit has what getElement(), select() and frame() take.

By expressID or GlobalId. An element’s IFC data: attributes with the GlobalId, its property sets and quantities, and its type’s — typeName, typeProperties — with units. effectivePropertySets merges both, the element’s own value winning.

Validate a model now (default: the active one) and resolve with its Health Score and issue counts. Rejects with the reason.

The validation result on screen, or null before any run has produced one. See “Validation lifecycle”.

Where validation stands right now: idle, running (with progress), done or error.

Per-category element counts per model — for dashboard charts. Returns a promise.

Validation issues for a table (filter by severity / limit). Returns a promise.

Capture the current 3D view as a PNG data URL. Returns a promise.

Compare two deliveries by URL (by GlobalId) and open the comparison workspace on the result.

Open a tool panel, or pass null to close whatever is open. A panel that is not available — the chrome hides it, or nothing is loaded for it to act on — is a no-op, not an error.

Which panel is open, and which are on offer right now. A tool missing from `available` cannot be opened; it is not merely disabled.

Limit the rail to these panels, at runtime. Same vocabulary as the `panels=` URL parameter and it outranks it. Narrows what the viewer offers and never adds; an empty array means no rail.

Load a scan from bytes — LAS, LAZ, COPC, PLY, PCD or text. The buffer is transferred, not copied. Resolves with the cloud id.

Load a scan the viewer fetches itself. The URL must allow CORS.

Every loaded scan. `pointCount` is what is resident; `declaredCount` is what the file holds — they differ when the budget truncated the parse.

Unload one scan and free its GPU buffers, or unload them all.

Show or hide a scan without unloading it.

Frame the camera on a scan, or on the first one loaded.

Point size, opacity, colour mode, density, confidence cut-off — shared by every scan. Each is a shader uniform, so it is instant on 20 million points.

Arm click-to-read. While armed, clicking a point emits `pointcloud-picked` with the coordinates IN THE FILE alongside the scene ones.

Nudge a scan by hand: position, yaw, levelling, scale. Partial and clamped; sits on top of the derived alignment rather than replacing it.

Correct which axis the scan treats as up. PLY, PCD and text declare no orientation, so the viewer infers it — check `upAxisSource` before trusting it.

Import a model from bytes. Takes a LIST: a .gltf needs its .bin and textures, an .obj its .mtl — send the entry file alone and you get grey geometry.

Import a model the viewer fetches. Pass every URL it needs; they are fetched in parallel and all must allow CORS.

Every imported model, with its triangle and texture counts. Read `unitSource` and `upAxisSource` before trusting the values beside them.

Remove an import and free its geometry, materials and textures, or remove them all.

Show or hide an import without unloading it.

Frame the camera on an import, or on all of them.

Place an import by hand: position, yaw, levelling, scale. Partial and clamped. Imports start centred on the IFC, sitting on its floor.

Correct the source's vertical axis. Only meaningful for OBJ — glTF's specification mandates Y-up, so it reports `upAxisSource: 'declared'`.

Correct the source unit: 1 metres, 0.01 centimetres, 0.001 millimetres, 0.3048 feet. None of these formats records one, so the viewer infers it from the model's size.

Check the model against a buildingSMART IDS (.ids XML). Runs in a worker. Returns pass/fail per spec.

Check the model against an EIR / BIM Validation profile — an object, its JSON (incl. the compact shorthand) or a built-in id such as 'builtin-en14351-1'. Compiles to IDS and runs on the same engine: same IdsResult shape as checkIds.

Change the UI language at runtime.

List the supported language codes (see IfcViewer.LANGUAGES for labels).

Resolves when the viewer is ready to accept commands.

Getter — true once the viewer has signalled readiness.

Subscribe to an event; returns an unsubscribe function.

Remove a previously added event listener.

Tear down the viewer and remove the iframe.