Documentation

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

# Interface: PlannerUiState

exposed-api.<internal>.PlannerUiState

# Hierarchy

# Table of contents

# Properties

# Properties

# actionMenuExpanded

• actionMenuExpanded: boolean

# Defined in

src/planner/store/planner-ui-state.ts:54 (opens new window)

# catalogTags

• catalogTags: Nullable<RapiTagForUi[]>

# Defined in

src/planner/store/planner-ui-state.ts:53 (opens new window)

# currentSelectedMeasurementId

• currentSelectedMeasurementId: Nullable<number>

# Defined in

src/planner/store/planner-ui-state.ts:70 (opens new window)

# drawingEnabled

• drawingEnabled: boolean

# Defined in

src/planner/store/planner-ui-state.ts:59 (opens new window)

# freeDrawFirstRoom

• freeDrawFirstRoom: boolean

# Defined in

src/planner/store/planner-ui-state.ts:66 (opens new window)

# hasChosenASampleRoom

• hasChosenASampleRoom: boolean

# Defined in

src/planner/store/planner-ui-state.ts:64 (opens new window)

# hasWalls

• hasWalls: boolean

# Defined in

src/planner/store/planner-ui-state.ts:61 (opens new window)

# interactionsExpanded

• interactionsExpanded: boolean

# Inherited from

SharedUiState.interactionsExpanded

# Defined in

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

# isCatalogSet

• isCatalogSet: boolean

# Defined in

src/planner/store/planner-ui-state.ts:67 (opens new window)

# isConfiguringInRoom

• isConfiguringInRoom: boolean

# Defined in

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

# isCurrentlyDrawing

• isCurrentlyDrawing: boolean

# Defined in

src/planner/store/planner-ui-state.ts:60 (opens new window)

# isDefiningRoom

• isDefiningRoom: boolean

# Defined in

src/planner/store/planner-ui-state.ts:63 (opens new window)

# isDesktop

• isDesktop: boolean

# Inherited from

SharedUiState.isDesktop

# Defined in

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

# isDrag

• isDrag: boolean

# Defined in

src/planner/store/planner-ui-state.ts:52 (opens new window)

# isFullscreen

• isFullscreen: boolean

# Inherited from

SharedUiState.isFullscreen

# Defined in

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

# isLandscape

• isLandscape: boolean

# Inherited from

SharedUiState.isLandscape

# Defined in

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

# lastRegularViewMode

• lastRegularViewMode: Nullable<boolean>

# Inherited from

SharedUiState.lastRegularViewMode

# Defined in

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

# lastWalls

• lastWalls: ShallowRef<KernelWall[]>

# Defined in

src/planner/store/planner-ui-state.ts:57 (opens new window)

# measurementUnit

• measurementUnit: Enumify<{ CM: "cm" = 'cm'; FEET: "feet" = 'feet'; INCH: "inch" = 'inch'; INCH_FEET: "inchfeet" = 'inchfeet'; MM: "mm" = 'mm' }>

# Defined in

src/planner/store/planner-ui-state.ts:58 (opens new window)

# mobileExpanded

• mobileExpanded: boolean

# Defined in

src/planner/store/planner-ui-state.ts:56 (opens new window)

# multiSelectionElements

• multiSelectionElements: ShallowRef<default[]>

# Defined in

src/planner/store/planner-ui-state.ts:69 (opens new window)

# selectedActions

• selectedActions: BUTTON_ACTIONS[]

# Defined in

src/planner/store/planner-ui-state.ts:55 (opens new window)

# selectionElement

• selectionElement: Nullable<ShallowRef<default>>

# Defined in

src/planner/store/planner-ui-state.ts:51 (opens new window)

# selectionPayload

• selectionPayload: Nullable<SelectionPayload>

# Defined in

src/planner/store/planner-ui-state.ts:50 (opens new window)

# selectionType

• selectionType: Nullable<SelectionType>

# Defined in

src/planner/store/planner-ui-state.ts:49 (opens new window)

# showDimensions

• showDimensions: boolean

# Defined in

src/planner/store/planner-ui-state.ts:68 (opens new window)

# showRoomConfirmBtn

• showRoomConfirmBtn: boolean

# Defined in

src/planner/store/planner-ui-state.ts:65 (opens new window)

# showRotateElement

• showRotateElement: boolean

# Defined in

src/planner/store/planner-ui-state.ts:62 (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)

# wasDesktopBefore

• wasDesktopBefore: boolean

# Inherited from

SharedUiState.wasDesktopBefore

# Defined in

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