Class Host<SP>

Type Parameters

SP extends object = object

Index

Constructors

Properties

Methods

closeConfigurator dispose exportConfigurationAsCustom exportConfigurationAsGLTF exportConfigurationAsImage openConfigurator saveConfiguration setLoadingState

Constructors

constructor

new Host<SP extends object = object>(
    iframe: HTMLIFrameElement,
    hostOperations?: HostOperations<SP>,
    allowPolicies?: AllowPolicies,
): Host<SP>
Type Parameters
- SP extends object = object
Parameters
- iframe: HTMLIFrameElement
- OptionalhostOperations: HostOperations<SP>
- allowPolicies: AllowPolicies = ...
Returns Host<SP>
- Defined in Host.ts:149

Properties

`Readonly`off

off: <K extends keyof HostEvents>(event: K, listener: Function) => void = ...

`Readonly`on

on: <K extends keyof HostEvents>(
event: K,
listener: (data: HostEvents[K]) => void,
) => void = ...

`Readonly`once

once: <K extends keyof HostEvents>(
event: K,
listener?: (data: HostEvents[K]) => void,
) => Promise<HostEvents[K]> = ...

Methods

closeConfigurator

closeConfigurator(): void
Closes the active configurator

Returns void
- Defined in Host.ts:352

dispose

dispose(): void
Cleanes up internal event handlers

Returns void
- Defined in Host.ts:361

exportConfigurationAsCustom

exportConfigurationAsCustom(params: ExportCustomParams): Promise<unknown>
Export the current configuration as a custom format.

These formats are dependant on the configurator and active configuration.
Parameters
- params: ExportCustomParams
Returns Promise<unknown>
- Defined in Host.ts:261

exportConfigurationAsGLTF

exportConfigurationAsGLTF(params?: ExportGLTFParams): Promise<string>
Exports the active configuration as a gltf.

Returns the url to the gltf.

Expects a configuration to be active.
Parameters
- Optionalparams: ExportGLTFParams
Returns Promise<string>
- Defined in Host.ts:225

exportConfigurationAsImage

exportConfigurationAsImage(
params: ExportImageParams,
): Promise<ExportImageResult>
Exports an image of the scene.

Expects a configuration to be active.
Parameters
- params: ExportImageParams
Returns Promise<ExportImageResult>
- Defined in Host.ts:243

openConfigurator

openConfigurator(params: HostOpenConfiguratorParams): Promise<void>
Opens a configurator
Parameters
- params: HostOpenConfiguratorParams
Returns Promise<void>
Resolves when the configurator has been initialized. Rejects when the iframe could not load the specified url or when the configurator could not be initialized.
- Defined in Host.ts:299

saveConfiguration

saveConfiguration(): Promise<HostSaveConfigurationResult>
Saves the current configuration.

Note: Expects the save method of the host operations to be implemented.

Returns Promise<HostSaveConfigurationResult>
- Defined in Host.ts:276

setLoadingState

setLoadingState(value: boolean): Promise<void>
Parameters
- value: boolean
Returns Promise<void>
- Defined in Host.ts:284