ExposedApi.Internal

Embedding API Reference / Modules / exposed-api / <internal>

Module: <internal>

Table of contents

Enumerations

• BUTTON_ACTIONS

• GA_CATEGORY

• GA_CUSTOM

• SDK_MODULES

Enumeration Members

• EXPORT_3D

• LOAD_PRODUCT

• OPEN_AR

• SAVE_DRAFT

• TUTORIALS

Classes

• Connector

• ExposedApiDragGhost

• ExposedApiDragHandler

• Libs

• MessageHandler

• RoomleSdkWrapper

• SdkConnector

• SdkConnectorConfigurator

• SdkConnectorPlanner

• SdkConnectorViewer

• UiCallbacks

• default

• default

• default

Interfaces

• Analytics

• CollectionViewComponentIcon

• CollectionViewElement

• CollectionViewState

• CoreData

• CoreState

• DragGhostOptions

• DragInOptions

• DragInSettings

• EmbeddingCommand

• EmbeddingResponse

• GridViewElement

• GridViewUiState

• GridViewVariantElement

• IncomingMessageBus

• KernelBoundsFormatted

• OutgoingMessageBus

• OverlayState

• ParameterGroup

• PartlistResponse

• PlannerCoreData

• PlannerUiState

• PointRect

• SampleRoom

• SceneSelection

• SharedUiState

• StoreState

• TabCategory

• Translator

• UiLabels

• UiPossibleChildTagWithKey

• UiState

• WrapLines

Type Aliases

• CallbackApi

• CollectionViewElementPossibleTypes

• CollectionViewTypes

• CommunicationSide

• CustomViewCommunicationSide

• CustomViewCommunicationSideParent

• EmbeddingPluginMode

• Enumify

• EventCallback

• EventMap

• EventsDataMap

• ExposedOverlays

• GoogleAnalyticsCallback

• GridViewElementPossiblePayload

• LoadResponse

• MaterialsForObjects

• MessageExecution

• MessageExecutionResult

• Nullable

• OverlaysOpenState

• RgbHexValue

• RoomType

• RoomleConfiguratorType

• RoomleConfiguratorWithExtObjs

• RoomlePlannerWithExtObjs

• SampleMaterial

• SelectionType

• ViewTypeState

• WithUiLabels

Variables

• COLLECTION_VIEW_TYPES

• PLAN_OBJECT_TYPES

Enumeration Members

EXPORT_3D

• EXPORT_3D: 5

---

LOAD_PRODUCT

• LOAD_PRODUCT: 12

---

OPEN_AR

• OPEN_AR: 4

---

SAVE_DRAFT

• SAVE_DRAFT: 1

---

TUTORIALS

• TUTORIALS: 11

Type Aliases

CallbackApi

Ƭ CallbackApi: ConfiguratorUiCallbacks & RoomlePlannerUiCallback

---

CollectionViewElementPossibleTypes

Ƭ CollectionViewElementPossibleTypes: UiPossibleChildTag | UiKernelParameter | RapiTagForUi

---

CollectionViewTypes

Ƭ CollectionViewTypes: Enumify<typeof COLLECTION_VIEW_TYPES>

---

CommunicationSide

Ƭ CommunicationSide: "iframe" | "website" | "main" | CustomViewCommunicationSide | CustomViewCommunicationSideParent

---

CustomViewCommunicationSide

Ƭ CustomViewCommunicationSide: `custom-view-${PossibleCustomViews}`

---

CustomViewCommunicationSideParent

Ƭ CustomViewCommunicationSideParent: `custom-view-${PossibleCustomViews}-parent`

---

EmbeddingPluginMode

Ƭ EmbeddingPluginMode: "website" | "custom-view"

---

Enumify

Ƭ Enumify<T>: T[keyof T]

Type parameters

Name
T

---

EventCallback

Ƭ EventCallback<T>: (payload: T) => void

Type parameters

Name	Type
T	unknown

Type declaration

▸ (payload): void

Parameters

Name	Type
payload	T

Returns

void

---

EventMap

Ƭ EventMap<T>: Map<string, Set<EventCallback<T>>>

Type parameters

Name
T

---

EventsDataMap

Ƭ EventsDataMap<T>: Map<string, T>

Type parameters

Name
T

---

ExposedOverlays

Ƭ ExposedOverlays: typeof SAVE_DRAFT | typeof OPEN_AR | typeof EXPORT_3D | typeof TUTORIALS | typeof LOAD_PRODUCT

---

GoogleAnalyticsCallback

Ƭ GoogleAnalyticsCallback: (...args: any[]) => void

Type declaration

▸ (...args): void

Parameters

Name	Type
...args	any[]

Returns

void

---

GridViewElementPossiblePayload

Ƭ GridViewElementPossiblePayload: WithUiLabels<RapiMaterial> | WithUiLabels<KernelValue> | WithUiLabels<UiPossibleChild> | WithUiLabels<RapiItem> | WithUiLabels<SampleRoom> | WithUiLabels<SampleMaterial> | WithUiLabels<RapiComponent> | WithUiLabels<MaterialsForObjects>

---

LoadResponse

Ƭ LoadResponse: PartlistResponse | void

---

MaterialsForObjects

Ƭ MaterialsForObjects: RapiMaterial | SampleMaterial

---

MessageExecution

Ƭ MessageExecution: (message: EmbeddingCommand, event: MessageEvent) => MessageExecutionResult | Promise<MessageExecutionResult>

Type declaration

▸ (message, event): MessageExecutionResult | Promise<MessageExecutionResult>

Parameters

Name	Type
message	EmbeddingCommand
event	MessageEvent

Returns

MessageExecutionResult | Promise<MessageExecutionResult>

---

MessageExecutionResult

Ƭ MessageExecutionResult: Promise<EmbeddingResponse | void> | undefined

---

Nullable

Ƭ Nullable<T>: T | null

Type parameters

Name
T

---

OverlaysOpenState

Ƭ OverlaysOpenState: Object

Index signature

▪ [key: string]: OverlayState

---

RgbHexValue

Ƭ RgbHexValue: `#${string}`

---

RoomType

Ƭ RoomType: "empty" | "floor" | "wall" | "corner" | "square" | "L"

---

RoomleConfiguratorType

Ƭ RoomleConfiguratorType: RoomleConfigurator | RoomleConfiguratorWithExtObjs

---

RoomleConfiguratorWithExtObjs

Ƭ RoomleConfiguratorWithExtObjs: RoomleConfigurator<["external-objects"]>

---

RoomlePlannerWithExtObjs

Ƭ RoomlePlannerWithExtObjs: RoomlePlanner<["external-objects"]>

---

SampleMaterial

Ƭ SampleMaterial: Object

Type declaration

Name	Type
__IS_SAMPLE_COLOR__	1
color	RgbHexValue
id	string
label	string

---

SelectionType

Ƭ SelectionType: Enumify<typeof PLAN_OBJECT_TYPES>

---

ViewTypeState

Ƭ ViewTypeState: "list" | "small" | "big"

---

WithUiLabels

Ƭ WithUiLabels<T>: T & { uiLabels?: UiLabels }

Type parameters

Name
T

Variables

COLLECTION_VIEW_TYPES

• Const COLLECTION_VIEW_TYPES: Object

Type declaration

Name	Type
CONFIGURATOR_SIDE_BAR	"configurator_side_bar"
DUMMY	"dummy_side_bar"
FLOOR_SIDE_BAR	"floor_side_bar"
PLANNER_SIDE_BAR	"planner_side_bar"
PRODUCT_SETTINGS	"product_settings"
STATIC_COLLECTION_VIEW	"static_collection_view"
UNIT_TEST	"test_state"
WALL_SIDE_BAR	"wall_side_bar"

---

PLAN_OBJECT_TYPES

• Const PLAN_OBJECT_TYPES: Object

Type declaration

Name	Type
CONFIGURATION	"configuration"
DOOR	"door"
EXTERNAL_CONFIGURATION	"external-configuration"
FLOOR	"floor"
MEASURE	"measure"
STATIC	"static"
UNKNOWN	"unknown"
WALL	"wall"
WINDOW	"window"