Class Host<SP>

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>

Readonlyoff

Readonlyon

Readonlyonce

closeConfigurator

• closeConfigurator(): void

• Closes the active configurator

  Returns void

dispose

• dispose(): void

• Cleanes up internal event handlers

  Returns void

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>

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>

exportConfigurationAsImage

• exportConfigurationAsImage(
      params: ExportImageParams,
  ): Promise<ExportImageResult>

• Exports an image of the scene.

  Expects a configuration to be active.

  Parameters

  • params: ExportImageParams

  Returns Promise<ExportImageResult>

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.

saveConfiguration

• saveConfiguration(): Promise<HostSaveConfigurationResult>

• Saves the current configuration.

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

  Returns Promise<HostSaveConfigurationResult>