RoomleConfiguratorApi.default

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

Implementation of

RoomleEmbeddingApiKeys.analytics


extended

extended: SdkType

Implementation of

RoomleEmbeddingApiKeys.extended


global

global: Object

Type declaration

Name
Type

callbacks

GlobalCallback

Implementation of

RoomleEmbeddingApiKeys.global


ui

ui: ExposedApi

Implementation of

RoomleEmbeddingApiKeys.ui

Methods

teardown

teardown(): void

Returns

void


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

settings with which the configurator should be started

Returns

Promise<RoomleConfiguratorApi>

Deprecated

please use "createConfigurator"


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

settings with which the configurator should be started

Returns

Promise<RoomleConfiguratorApi>


createPlanner

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

Parameters

Name
Type

configuratorId

string

container

HTMLElement

initData

Returns

Promise<RoomlePlannerApi>


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

settings with which the configurator should be started

Returns

Promise<RoomleViewerApi>

Last updated