Documentation

Embedding API Reference / Modules / roomle-configurator-api / default

# Class: default<SdkType, SdkCallbacks>

roomle-configurator-api.default

# Type parameters

Name
SdkType
SdkCallbacks

# Implements

# Table of contents

# Properties

# Methods

# Properties

# analytics

• analytics: Object

# Type declaration

Name Type
callbacks ExposedAnalyticsCallbacks

# Implementation of

RoomleEmbeddingApiKeys.analytics

# Defined in

src/configurator/embedding/roomle-configurator-api.ts:223 (opens new window)

# extended

• extended: SdkType

# Implementation of

RoomleEmbeddingApiKeys.extended

# Defined in

src/configurator/embedding/roomle-configurator-api.ts:219 (opens new window)

# global

• global: Object

# Type declaration

Name Type
callbacks GlobalCallback

# Implementation of

RoomleEmbeddingApiKeys.global

# Defined in

src/configurator/embedding/roomle-configurator-api.ts:227 (opens new window)

# ui

• ui: ExposedApi

# Implementation of

RoomleEmbeddingApiKeys.ui

# Defined in

src/configurator/embedding/roomle-configurator-api.ts:215 (opens new window)

# Methods

# teardown

▸ teardown(): void

# Returns

void

# Defined in

src/configurator/embedding/roomle-configurator-api.ts:305 (opens new window)

# create

▸ create(configuratorId, container, initData): Promise<RoomleConfiguratorApi>

Method to create a new instance of a Roomle Configurator

# Parameters

Name Type Description
configuratorId string the id which identifies your configurator, you will get this ID from your Roomle Contact Person
container HTMLElement DOM container in which the configurator should be placed
initData UiInitData settings with which the configurator should be started

# Returns

Promise<RoomleConfiguratorApi>

Deprecated

please use "createConfigurator"

# Defined in

src/configurator/embedding/roomle-configurator-api.ts:143 (opens new window)

# createConfigurator

▸ createConfigurator(configuratorId, container, initData): Promise<RoomleConfiguratorApi>

Method to create a new instance of a Roomle Configurator

# Parameters

Name Type Description
configuratorId string the id which identifies your configurator, you will get this ID from your Roomle Contact Person
container HTMLElement DOM container in which the configurator should be placed
initData UiInitData settings with which the configurator should be started

# Returns

Promise<RoomleConfiguratorApi>

# Defined in

src/configurator/embedding/roomle-configurator-api.ts:124 (opens new window)

# createPlanner

▸ createPlanner(configuratorId, container, initData): Promise<RoomlePlannerApi>

# Parameters

Name Type
configuratorId string
container HTMLElement
initData UiInitData

# Returns

Promise<RoomlePlannerApi>

# Defined in

src/configurator/embedding/roomle-configurator-api.ts:106 (opens new window)

# createViewer

▸ createViewer(configuratorId, container, initData): Promise<RoomleViewerApi>

Method to create a new instance of a Roomle Viewer

# Parameters

Name Type Description
configuratorId string the id which identifies your configurator, you will get this ID from your Roomle Contact Person
container HTMLElement DOM container in which the configurator should be placed
initData UiInitData settings with which the configurator should be started

# Returns

Promise<RoomleViewerApi>

# Defined in

src/configurator/embedding/roomle-configurator-api.ts:161 (opens new window)