Class IFCLiteEmbed

Methods

addModel

addModel(url: string, name?: string): Promise<ModelStats & { modelId: string }>
Add a model to the federation
Parameters
- url: string
- Optionalname: string
Returns Promise<ModelStats & { modelId: string }>

clearSelection

clearSelection(): Promise<void>

Clear selection

Returns Promise<void>

destroy

destroy(): void

Destroy the embed viewer and clean up resources

Returns void

fitToView

fitToView(ids?: number[]): Promise<void>
Zoom the camera to fit specific entities (or all if no IDs given)
Parameters
- Optionalids: number[]
Returns Promise<void>

getModelInfo

getModelInfo(): Promise<ModelInfo>

Get info about all loaded models

Returns Promise<ModelInfo>

getProperties

getProperties(id: number): Promise<EntityProperties>
Get properties for a specific entity
Parameters
- id: number
Returns Promise<EntityProperties>

getScreenshot

getScreenshot(width?: number, height?: number): Promise<{ dataUrl: string }>
Capture a screenshot of the viewport
Parameters
- Optionalwidth: number
- Optionalheight: number
Returns Promise<{ dataUrl: string }>

hide

hide(ids: number[]): Promise<void>
Hide specific entities
Parameters
- ids: number[]
Returns Promise<void>

isolate

isolate(ids: number[]): Promise<void>
Isolate (show only) specific entities
Parameters
- ids: number[]
Returns Promise<void>

loadModel

loadModel(url: string): Promise<ModelStats>
Load a model from a URL
Parameters
- url: string
Returns Promise<ModelStats>

loadModelBuffer

loadModelBuffer(buffer: ArrayBuffer): Promise<ModelStats>
Load a model from an ArrayBuffer (zero-copy transfer)
Parameters
- buffer: ArrayBuffer
Returns Promise<ModelStats>

on

on<K extends keyof EventMap>(
event: K,
callback: EventCallback<EventMap[K]>,
): () => void
Subscribe to an event. Returns an unsubscribe function.
Type Parameters
- K extends keyof EventMap
Parameters
- event: K
- callback: EventCallback<EventMap[K]>
Returns () => void

removeModel

removeModel(modelId: string): Promise<void>
Remove a model from the federation
Parameters
- modelId: string
Returns Promise<void>

resetColors

resetColors(): Promise<void>

Reset all color overrides

Returns Promise<void>

select

select(ids: number[]): Promise<void>
Select entities by global IDs
Parameters
- ids: number[]
Returns Promise<void>

selectByGuid

selectByGuid(guids: string[]): Promise<{ resolved: number[] }>
Select entities by IFC GlobalId GUIDs
Parameters
- guids: string[]
Returns Promise<{ resolved: number[] }>

setCamera

setCamera(azimuth: number, elevation: number, zoom?: number): Promise<void>
Set the camera's absolute orientation, in degrees, around whatever it is currently looking at. zoom is reserved and ignored by the viewer — see InboundPayloads['SET_CAMERA'].
Parameters
- azimuth: number
- elevation: number
- Optionalzoom: number
Returns Promise<void>

setColors

setColors(
colorMap: Record<number, [number, number, number, number]>,
): Promise<void>
Set color overrides for entities. Keys are entity IDs, values are [r,g,b,a].
Parameters
- colorMap: Record<number, [number, number, number, number]>
Returns Promise<void>

setSection

setSection(
    opts: {
        axis?: SectionAxis;
        enabled?: boolean;
        flipped?: boolean;
        position?: number;
    },
): Promise<void>
Control the section plane
Parameters
- opts: { axis?: SectionAxis; enabled?: boolean; flipped?: boolean; position?: number }
Returns Promise<void>

setTheme

setTheme(theme: "light" | "dark", bg?: string): Promise<void>
Change the color theme
Parameters
- theme: "light" | "dark"
- Optionalbg: string
Returns Promise<void>

setTypeVisibility

setTypeVisibility(opts: TypeVisibilityFlags): Promise<void>
Toggle IFC type visibility: spaces, spatialZones, openings, virtualElements, site, ifcAnnotations, ifcGrid. Omitted flags are left as they are. See TypeVisibilityFlags for the classes each one gates.
Parameters
- opts: TypeVisibilityFlags
Returns Promise<void>

setView

setView(preset: ViewPreset): Promise<void>
Set a preset camera view
Parameters
- preset: ViewPreset
Returns Promise<void>

show

show(ids: number[]): Promise<void>
Show specific entities
Parameters
- ids: number[]
Returns Promise<void>

showAll

showAll(): Promise<void>

Show all entities (reset visibility)

Returns Promise<void>

`Static`create

create(opts: EmbedOptions): Promise<IFCLiteEmbed>
Create an embed viewer instance. Returns a promise that resolves after the handshake.
Parameters
- opts: EmbedOptions
Returns Promise<IFCLiteEmbed>