ExposedApi.Internal
Embedding API Reference / Modules / exposed-api / <internal>
Module: <internal>
Table of contents
Enumerations
Enumeration Members
Classes
Interfaces
Type Aliases
Variables
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
EventCallback
Ƭ EventCallback<T
>: (payload
: T
) => void
Type parameters
Type declaration
▸ (payload
): void
Parameters
Returns
void
EventMap
Ƭ EventMap<T
>: Map
<string
, Set
<EventCallback
<T
>>>
Type parameters
EventsDataMap
Ƭ EventsDataMap<T
>: Map
<string
, T
>
Type parameters
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
Returns
void
GridViewElementPossiblePayload
Ƭ GridViewElementPossiblePayload: RapiMaterial
| KernelValue
| UiPossibleChild
| RapiItem
| UIColorParameterValue
| SampleRoom
| SampleMaterial
| RapiComponent
LoadResponse
Ƭ LoadResponse: PartlistResponse
| void
MessageExecution
Ƭ MessageExecution: (message
: EmbeddingCommand
, event
: MessageEvent
) => MessageExecutionResult
| Promise
<MessageExecutionResult
>
Type declaration
▸ (message
, event
): MessageExecutionResult
| Promise
<MessageExecutionResult
>
Parameters
Returns
MessageExecutionResult
| Promise
<MessageExecutionResult
>
MessageExecutionResult
Ƭ MessageExecutionResult: Promise
<EmbeddingResponse
| void
> | undefined
Nullable
Ƭ Nullable<T
>: T
| null
Type parameters
OverlaysOpenState
Ƭ OverlaysOpenState: Object
Index signature
▪ [key: string
]: OverlayState
RgbHexValue
Ƭ RgbHexValue: `#${string}`
RoomType
Ƭ RoomType: "empty"
| "floor"
| "wall"
| "corner"
| "square"
| "L"
SampleMaterial
Ƭ SampleMaterial: Object
Type declaration
SelectionType
Ƭ SelectionType: Enumify
<typeof PLAN_OBJECT_TYPES
>
ViewTypeState
Ƭ ViewTypeState: "list"
| "small"
| "big"
WallSide
Ƭ WallSide: "left"
| "right"
Variables
COLLECTION_VIEW_TYPES
• Const
COLLECTION_VIEW_TYPES: Object
Type declaration
PLAN_OBJECT_TYPES
• Const
PLAN_OBJECT_TYPES: Object
Type declaration
Last updated