Embedding API Reference / Modules / exposed-api / <internal>
# Module: <internal>
# Table of contents
# Enumerations
# Classes
- Connector
- MessageHandler
- RoomleSdkWrapper
- SdkConnector
- SdkConnectorConfigurator
- SdkConnectorPlanner
- SdkConnectorViewer
- UiCallbacks
- default
- default
- default
# Interfaces
- Analytics
- CollectionViewComponentIcon
- CollectionViewElement
- CollectionViewUiState
- CommonUiState
- CoreData
- CoreState
- EmbeddingCommand
- EmbeddingResponse
- GridViewElement
- GridViewUiState
- GridViewVariantElement
- IncomingMessageBus
- KernelBoundsFormatted
- OutgoingMessageBus
- OverlayState
- ParameterGroup
- PartlistResponse
- PlannerCoreData
- PlannerUiState
- SampleRoom
- SceneSelection
- SharedUiState
- StoreState
- TabCategory
- UIColorParameterValue
- UiPossibleChildTagWithKey
- UiState
# Type Aliases
- CallbackApi
- CollectionViewElementPossibleTypes
- CollectionViewTypes
- CommunicationSide
- Enumify
- EventCallback
- EventMap
- EventsDataMap
- GoogleAnalyticsCallback
- GridViewElementPossiblePayload
- LoadResponse
- MessageExecution
- MessageExecutionResult
- Nullable
- OverlaysOpenState
- RgbHexValue
- RoomType
- SampleMaterial
- SelectionType
- ViewTypeState
- WallSide
# Variables
# Type Aliases
# CallbackApi
Ƭ CallbackApi: ConfiguratorUiCallbacks
& RoomlePlannerUiCallback
# Defined in
src/configurator/business-logic/sdk-connector.ts:108 (opens new window)
# CollectionViewElementPossibleTypes
Ƭ CollectionViewElementPossibleTypes: UiPossibleChildTag
| UiKernelParameter
| RapiTagForUi
# Defined in
src/common/components/collection-view/-utils/types.ts:33 (opens new window)
# CollectionViewTypes
Ƭ CollectionViewTypes: Enumify
<typeof COLLECTION_VIEW_TYPES
>
# Defined in
src/common/store/collection-view-state.ts:31 (opens new window)
# CommunicationSide
Ƭ CommunicationSide: "iframe"
| "website"
# Defined in
src/configurator/embedding/message-handler.ts:19 (opens new window)
# Enumify
Ƭ Enumify<T
>: T
[keyof T
]
# Type parameters
Name |
---|
T |
# Defined in
src/common/utils/types.ts:12 (opens new window)
# EventCallback
Ƭ EventCallback<T
>: (payload
: T
) => void
# Type parameters
Name | Type |
---|---|
T | unknown |
# Type declaration
▸ (payload
): void
# Parameters
Name | Type |
---|---|
payload | T |
# Returns
void
# Defined in
src/common/business-logic/event-emitter.ts:1 (opens new window)
# EventMap
Ƭ EventMap<T
>: Map
<string
, Set
<EventCallback
<T
>>>
# Type parameters
Name |
---|
T |
# Defined in
src/common/business-logic/event-emitter.ts:3 (opens new window)
# EventsDataMap
Ƭ EventsDataMap<T
>: Map
<string
, T
>
# Type parameters
Name |
---|
T |
# Defined in
src/common/business-logic/event-emitter.ts:5 (opens new window)
# GoogleAnalyticsCallback
Ƭ GoogleAnalyticsCallback: (...args
: any
[]) => void
# Type declaration
▸ (...args
): void
# Parameters
Name | Type |
---|---|
...args | any [] |
# Returns
void
# Defined in
src/common/utils/google-analytics.ts:97 (opens new window)
# GridViewElementPossiblePayload
Ƭ GridViewElementPossiblePayload: RapiMaterial
| KernelValue
| UiPossibleChild
| RapiItem
| UIColorParameterValue
| SampleRoom
| SampleMaterial
| RapiComponent
# Defined in
src/configurator/components/grid-view/-utils/GridViewHelper.ts:23 (opens new window)
# LoadResponse
Ƭ LoadResponse: PartlistResponse
| void
# Defined in
src/configurator/business-logic/sdk-connector.ts:88 (opens new window)
# MessageExecution
Ƭ MessageExecution: (message
: EmbeddingCommand
, event
: MessageEvent
) => MessageExecutionResult
# Type declaration
▸ (message
, event
): MessageExecutionResult
# Parameters
Name | Type |
---|---|
message | EmbeddingCommand |
event | MessageEvent |
# Returns
# Defined in
src/configurator/embedding/message-handler.ts:23 (opens new window)
# MessageExecutionResult
Ƭ MessageExecutionResult: Promise
<EmbeddingResponse
| void
> | undefined
# Defined in
src/configurator/embedding/message-handler.ts:20 (opens new window)
# Nullable
Ƭ Nullable<T
>: T
| null
# Type parameters
Name |
---|
T |
# Defined in
src/common/utils/types.ts:9 (opens new window)
# OverlaysOpenState
Ƭ OverlaysOpenState: Object
# Index signature
▪ [key: string
]: OverlayState
# Defined in
src/common/components/utils/-utils/overlays.ts:23 (opens new window)
# RgbHexValue
Ƭ RgbHexValue: `#${string}`
# Defined in
src/common/utils/color.ts:168 (opens new window)
# RoomType
Ƭ RoomType: "empty"
| "floor"
| "wall"
| "corner"
| "square"
| "L"
# Defined in
src/planner/business-logic/rooms.ts:15 (opens new window)
# SampleMaterial
Ƭ SampleMaterial: Object
# Type declaration
Name | Type |
---|---|
__IS_SAMPLE_COLOR__ | 1 |
color | RgbHexValue |
id | string |
label | string |
# Defined in
src/planner/components/overlays/rooms/utils/ral-colors.ts:5 (opens new window)
# SelectionType
Ƭ SelectionType: Enumify
<typeof PLAN_OBJECT_TYPES
>
# Defined in
src/planner/store/planner-ui-state.ts:39 (opens new window)
# ViewTypeState
Ƭ ViewTypeState: "list"
| "small"
| "big"
# Defined in
src/common/store/collection-view-state.ts:11 (opens new window)
# WallSide
Ƭ WallSide: "left"
| "right"
# Defined in
src/planner/business-logic/selected-wall-parameters.ts:12 (opens new window)
# 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" |
# Defined in
src/common/store/collection-view-state.ts:20 (opens new window)
# PLAN_OBJECT_TYPES
• Const
PLAN_OBJECT_TYPES: Object
# Type declaration
Name | Type |
---|---|
CONFIGURATION | "configuration" |
DOOR | "door" |
FLOOR | "floor" |
MEASURE | "measure" |
STATIC | "static" |
UNKNOWN | "unknown" |
WALL | "wall" |
WINDOW | "window" |