Documentation

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

# Class: SdkConnectorPlanner

exposed-api.<internal>.SdkConnectorPlanner

# Hierarchy

# Table of contents

# Constructors

# Accessors

# Methods

# Constructors

# constructor

• new SdkConnectorPlanner(store, analytics?, eventEmitter?): SdkConnectorPlanner

# Parameters

Name Type Default value
store Store<StoreState> undefined
analytics Nullable<Analytics> null
eventEmitter Nullable<default> null

# Returns

SdkConnectorPlanner

# Overrides

Connector.constructor

# Defined in

src/planner/business-logic/sdk-connector-planner.ts:84 (opens new window)

# Accessors

# api

• get api(): Promise<default>

# Returns

Promise<default>

# Overrides

Connector.api

# Defined in

src/planner/business-logic/sdk-connector-planner.ts:95 (opens new window)

# Methods

# addCallback

▸ addCallback<K>(key, fun, allowMultiple?): Promise<void>

# Type parameters

Name Type
K extends "get" | "onKernelIsReady" | "onComponentPositionsUpdated" | "onUpdateParameters" | "onUpdatePossibleChildren" | "onUpdatePrice" | "onSelectionChange" | "onSelectionCancel" | "onPartListUpdate" | "onBoundsUpdate" | "onLoadConfiguration" | "onConfigurationReady" | "onOpenTag" | "onOpenAddOns" | "onClickOutside" | "onNoDockingsAvailable" | "onUiIntersectionChange" | "onZoomChange" | "onZoomToComponent" | "onDimensionsVisibilityChange" | "onErrorDueToOffline" | "onError" | "onElementDocked" | "onDockingsPreviewRemoved" | "onConfigurationHasChildren" | "onTrackTiming" | "onUserInitiatedDockDone" | "onAddonPlusHover" | "onAddonPlusHoverOff" | "onAddonPlusShown" | "onAddonPlusHidden" | "onContentProblem" | "onSyncStarted" | "onSyncDone" | "onOpenFloorMaterials" | "onOpenPartList" | "onComponentLoadError" | "onConfigurationLoadError" | "onChangeTypeChangeTag" | "onRemoveTypeChangeTag" | "onConfigurationLabelChange" | "onMemoryCorruption" | "onConfiguratorKernelIsReady" | "onConfigurationSaved" | "onCameraPositionChanges" | "onHistoryChange" | "onClickComponent" | "onRequestExternalMesh" | "onGeometryReady" | "onGeometryNotReady" | "_creator_" | "mute" | "unmute" | "cameraStartsMoving" | "onItemsLoaded" | "onCameraChanged" | "onCameraIdle" | "onTotalFloorAreaChanged" | "onPlanInteractionHandlerCreated" | "onPlannerKernelIsReady" | "onPlanChanged" | "onPlanElementChanged" | "onCompletelyLoaded" | "onRotationCancel" | "onUpdateWallDimensions" | "onUpdateMeasurementLineDimensions" | "onUpdateConstructionElementsMeasurements" | "onUpdateObjectMeasurements" | "disableWallDimensions" | "onUpdatePlanObjectPositions" | "onDrawCancel" | "onHandlerSwitchedPlans" | "onDragElementStart" | "onDragElementEnd" | "onClickElement" | "onMultiSelectionChange" | "onSelectionModeChange" | "onMeasurementLineStateChange" | "onFloorPlanAreasUpdated"

# Parameters

Name Type Default value
key K undefined
fun CallbackApi[K] undefined
allowMultiple boolean false

# Returns

Promise<void>

# Inherited from

Connector.addCallback

# Defined in

src/common/business-logic/connector.ts:16 (opens new window)

# cancelSelection

▸ cancelSelection(): Promise<void>

# Returns

Promise<void>

# Defined in

src/planner/business-logic/sdk-connector-planner.ts:595 (opens new window)

# confirmRoom

▸ confirmRoom(switchTo2D): Promise<void>

# Parameters

Name Type
switchTo2D boolean

# Returns

Promise<void>

# Defined in

src/planner/business-logic/sdk-connector-planner.ts:582 (opens new window)

# getObjects

▸ getObjects(): Promise<UiPlanObject[]>

# Returns

Promise<UiPlanObject[]>

# Defined in

src/planner/business-logic/sdk-connector-planner.ts:430 (opens new window)

# init

▸ init(sdkWrapper, element, initData): Promise<void>

# Parameters

Name Type
sdkWrapper RoomleSdkWrapper
element HTMLElement
initData UiInitData

# Returns

Promise<void>

# Overrides

Connector.init

# Defined in

src/planner/business-logic/sdk-connector-planner.ts:102 (opens new window)

# initPlanner

▸ initPlanner(planner): Promise<void>

# Parameters

Name Type
planner default

# Returns

Promise<void>

# Defined in

src/planner/business-logic/sdk-connector-planner.ts:115 (opens new window)

# loadPlan

▸ loadPlan(id): Promise<void>

# Parameters

Name Type
id string

# Returns

Promise<void>

# Defined in

src/planner/business-logic/sdk-connector-planner.ts:370 (opens new window)

# loadPlanBasedOnObjectId

▸ loadPlanBasedOnObjectId(id): Promise<number>

# Parameters

Name Type
id string

# Returns

Promise<number>

# Defined in

src/planner/business-logic/sdk-connector-planner.ts:405 (opens new window)

# onPlanElementChanged

▸ onPlanElementChanged(changeType): Promise<void>

# Parameters

Name Type
changeType Enumify<{}>

# Returns

Promise<void>

# Defined in

src/planner/business-logic/sdk-connector-planner.ts:842 (opens new window)

# onSelectionCancel

▸ onSelectionCancel(reason): void

# Parameters

Name Type
reason CancelSelectionReasons

# Returns

void

# Defined in

src/planner/business-logic/sdk-connector-planner.ts:445 (opens new window)

# onSelectionChange

▸ onSelectionChange(_mode, objectType, payload, payloadPromise, planElementViewModel): void

# Parameters

Name Type
_mode string
objectType Enumify<{ CONFIGURATION: "configuration" = 'configuration'; DOOR: "door" = 'door'; FLOOR: "floor" = 'floor'; MEASURE: "measure" = 'measure'; STATIC: "static" = 'static'; UNKNOWN: "unknown" = 'unknown'; WALL: "wall" = 'wall'; WINDOW: "window" = 'window' }>
payload SelectionPayload
payloadPromise Promise<SelectionPayload>
planElementViewModel default

# Returns

void

# Defined in

src/planner/business-logic/sdk-connector-planner.ts:618 (opens new window)

# preparePartListData

▸ preparePartListData(selectedItemPayload): Promise<void>

# Parameters

Name Type
selectedItemPayload SelectionPayload

# Returns

Promise<void>

# Defined in

src/planner/business-logic/sdk-connector-planner.ts:807 (opens new window)

# saveCurrentPlan

▸ saveCurrentPlan(): Promise<Nullable<RapiPlanSnapshotGetData | RapiPlan>>

# Returns

Promise<Nullable<RapiPlanSnapshotGetData | RapiPlan>>

# Defined in

src/planner/business-logic/sdk-connector-planner.ts:496 (opens new window)

# savePlanToIdb

▸ savePlanToIdb(): Promise<void>

# Returns

Promise<void>

# Defined in

src/planner/business-logic/sdk-connector-planner.ts:696 (opens new window)

# switch2D

▸ switch2D(): Promise<void>

# Returns

Promise<void>

# Defined in

src/planner/business-logic/sdk-connector-planner.ts:536 (opens new window)

# switch3D

▸ switch3D(): Promise<void>

# Returns

Promise<void>

# Defined in

src/planner/business-logic/sdk-connector-planner.ts:552 (opens new window)

# switchFp

▸ switchFp(): Promise<void>

# Returns

Promise<void>

# Defined in

src/planner/business-logic/sdk-connector-planner.ts:568 (opens new window)

# updateProductList

▸ updateProductList(): Promise<void>

# Returns

Promise<void>

# Defined in

src/planner/business-logic/sdk-connector-planner.ts:437 (opens new window)