ExposedApi.Internal.UiState

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

Interface: UiState

exposed-api.<internal>.UiState

Hierarchy

• SharedUiState

  ↳ UiState

Table of contents

Properties

• activeAddon

• currentInteractionView

• currentSelection

• currentVariants

• email

• firstTimeRoomView

• initData

• initPlannerWithObjID

• interactionsExpanded

• isConfigurator

• isDesktop

• isExpandedForConfigure

• isFullscreen

• isInIframe

• isLandscape

• isLoadingInProgress

• isPlanner

• isPlannerEditMode

• isShareLinkReady

• isViewer

• lastRegularViewMode

• lastSelectedVariant

• materialMultiSelect

• objPosOnPlanner

• onlyShowAddons

• overlays

• redoEnabled

• redoEnabledPlanner

• selectedGroup

• showVariants

• sidebar

• topBarSelectedActions

• undoEnabled

• undoEnabledPlanner

• userInitiatedSearch

• wallsDimensions

• wasDesktopBefore

Properties

activeAddon

• activeAddon: Nullable<UiPossibleChild>

---

currentInteractionView

• currentInteractionView: Enumify<{ MATERIAL_INFO: "material_info" = 'material_info'; PARTLIST: "rubens_partlist" = 'rubens_partlist'; SIDEBAR: "rubens_sidebar" = 'rubens_sidebar' }>

---

currentSelection

• currentSelection: Nullable<SceneSelection>

---

currentVariants

• currentVariants: Nullable<RapiTagForUi>

---

email

• email: Nullable<string>

---

firstTimeRoomView

• firstTimeRoomView: boolean

---

initData

• initData: Nullable<UiInitData>

---

initPlannerWithObjID

• initPlannerWithObjID: boolean

---

interactionsExpanded

• interactionsExpanded: boolean

Inherited from

SharedUiState.interactionsExpanded

---

isConfigurator

• isConfigurator: boolean

---

isDesktop

• isDesktop: boolean

Inherited from

SharedUiState.isDesktop

---

isExpandedForConfigure

• isExpandedForConfigure: boolean

---

isFullscreen

• isFullscreen: boolean

Inherited from

SharedUiState.isFullscreen

---

isInIframe

• isInIframe: boolean

---

isLandscape

• isLandscape: boolean

Inherited from

SharedUiState.isLandscape

---

isLoadingInProgress

• isLoadingInProgress: boolean

---

isPlanner

• isPlanner: boolean

---

isPlannerEditMode

• isPlannerEditMode: boolean

---

isShareLinkReady

• isShareLinkReady: boolean

---

isViewer

• isViewer: boolean

---

lastRegularViewMode

• lastRegularViewMode: Nullable<boolean>

Overrides

SharedUiState.lastRegularViewMode

---

lastSelectedVariant

• lastSelectedVariant: Nullable<GridViewVariantElement>

---

materialMultiSelect

• materialMultiSelect: boolean

---

objPosOnPlanner

• objPosOnPlanner: PlanObjectPosition[]

---

onlyShowAddons

• onlyShowAddons: boolean

---

overlays

• overlays: OverlaysOpenState

---

redoEnabled

• redoEnabled: boolean

---

redoEnabledPlanner

• redoEnabledPlanner: boolean

---

selectedGroup

• selectedGroup: Nullable<ParameterGroup>

---

showVariants

• showVariants: boolean

---

sidebar

• sidebar: CollectionViewUiState

Inherited from

SharedUiState.sidebar

---

topBarSelectedActions

• topBarSelectedActions: BUTTON_ACTIONS[]

Inherited from

SharedUiState.topBarSelectedActions

---

undoEnabled

• undoEnabled: boolean

---

undoEnabledPlanner

• undoEnabledPlanner: boolean

---

userInitiatedSearch

• userInitiatedSearch: boolean

---

wallsDimensions

• wallsDimensions: WallDimensionTransferable[]

---

wasDesktopBefore

• wasDesktopBefore: boolean

Inherited from

SharedUiState.wasDesktopBefore