Documentation

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

# Interface: UiState

exposed-api.<internal>.UiState

# Hierarchy

# Table of contents

# Properties

# Properties

# activeAddon

• activeAddon: Nullable<UiPossibleChild>

# Defined in

src/configurator/store/ui-state.ts:75 (opens new window)

# currentInteractionView

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

# Defined in

src/configurator/store/ui-state.ts:100 (opens new window)

# currentSelection

• currentSelection: Nullable<SceneSelection>

# Defined in

src/configurator/store/ui-state.ts:76 (opens new window)

# currentVariants

• currentVariants: Nullable<RapiTagForUi>

# Defined in

src/configurator/store/ui-state.ts:80 (opens new window)

# email

• email: Nullable<string>

# Defined in

src/configurator/store/ui-state.ts:85 (opens new window)

# firstTimeRoomView

• firstTimeRoomView: boolean

# Defined in

src/configurator/store/ui-state.ts:99 (opens new window)

# initData

• initData: Nullable<UiInitData>

# Defined in

src/configurator/store/ui-state.ts:77 (opens new window)

# initPlannerWithObjID

• initPlannerWithObjID: boolean

# Defined in

src/configurator/store/ui-state.ts:95 (opens new window)

# interactionsExpanded

• interactionsExpanded: boolean

# Inherited from

SharedUiState.interactionsExpanded

# Defined in

src/common/store/index.ts:47 (opens new window)

# isConfigurator

• isConfigurator: boolean

# Defined in

src/configurator/store/ui-state.ts:83 (opens new window)

# isDesktop

• isDesktop: boolean

# Inherited from

SharedUiState.isDesktop

# Defined in

src/common/store/index.ts:49 (opens new window)

# isExpandedForConfigure

• isExpandedForConfigure: boolean

# Defined in

src/configurator/store/ui-state.ts:78 (opens new window)

# isFullscreen

• isFullscreen: boolean

# Inherited from

SharedUiState.isFullscreen

# Defined in

src/common/store/index.ts:48 (opens new window)

# isInIframe

• isInIframe: boolean

# Defined in

src/configurator/store/ui-state.ts:98 (opens new window)

# isLandscape

• isLandscape: boolean

# Inherited from

SharedUiState.isLandscape

# Defined in

src/common/store/index.ts:50 (opens new window)

# isLoadingInProgress

• isLoadingInProgress: boolean

# Defined in

src/configurator/store/ui-state.ts:79 (opens new window)

# isPlanSaved

• isPlanSaved: boolean

# Defined in

src/configurator/store/ui-state.ts:97 (opens new window)

# isPlanner

• isPlanner: boolean

# Defined in

src/configurator/store/ui-state.ts:84 (opens new window)

# isPlannerEditMode

• isPlannerEditMode: boolean

# Defined in

src/configurator/store/ui-state.ts:96 (opens new window)

# isViewer

• isViewer: boolean

# Defined in

src/configurator/store/ui-state.ts:82 (opens new window)

# lastRegularViewMode

• lastRegularViewMode: Nullable<boolean>

# Overrides

SharedUiState.lastRegularViewMode

# Defined in

src/configurator/store/ui-state.ts:73 (opens new window)

# lastSelectedVariant

• lastSelectedVariant: Nullable<GridViewVariantElement>

# Defined in

src/configurator/store/ui-state.ts:86 (opens new window)

# materialMultiSelect

• materialMultiSelect: boolean

# Defined in

src/configurator/store/ui-state.ts:92 (opens new window)

# objPosOnPlanner

• objPosOnPlanner: PlanObjectPosition[]

# Defined in

src/configurator/store/ui-state.ts:94 (opens new window)

# onlyShowAddons

• onlyShowAddons: boolean

# Defined in

src/configurator/store/ui-state.ts:74 (opens new window)

# overlays

• overlays: OverlaysOpenState

# Defined in

src/configurator/store/ui-state.ts:72 (opens new window)

# redoEnabled

• redoEnabled: boolean

# Defined in

src/configurator/store/ui-state.ts:88 (opens new window)

# redoEnabledPlanner

• redoEnabledPlanner: boolean

# Defined in

src/configurator/store/ui-state.ts:91 (opens new window)

# selectedGroup

• selectedGroup: Nullable<ParameterGroup>

# Defined in

src/configurator/store/ui-state.ts:71 (opens new window)

# showVariants

• showVariants: boolean

# Defined in

src/configurator/store/ui-state.ts:81 (opens new window)

• sidebar: CollectionViewUiState

# Inherited from

SharedUiState.sidebar

# Defined in

src/common/store/index.ts:53 (opens new window)

# topBarSelectedActions

• topBarSelectedActions: BUTTON_ACTIONS[]

# Inherited from

SharedUiState.topBarSelectedActions

# Defined in

src/common/store/index.ts:54 (opens new window)

# undoEnabled

• undoEnabled: boolean

# Defined in

src/configurator/store/ui-state.ts:87 (opens new window)

# undoEnabledPlanner

• undoEnabledPlanner: boolean

# Defined in

src/configurator/store/ui-state.ts:89 (opens new window)

# userInitiatedSearch

• userInitiatedSearch: boolean

# Defined in

src/configurator/store/ui-state.ts:90 (opens new window)

# wallsDimensions

• wallsDimensions: WallDimensionTransferable[]

# Defined in

src/configurator/store/ui-state.ts:93 (opens new window)

# wasDesktopBefore

• wasDesktopBefore: boolean

# Inherited from

SharedUiState.wasDesktopBefore

# Defined in

src/common/store/index.ts:52 (opens new window)