ExposedApi.Internal.SdkConnectorPlanner

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

Class: SdkConnectorPlanner

exposed-api.<internal>.SdkConnectorPlanner

Hierarchy

• Connector

  ↳ SdkConnectorPlanner

Table of contents

Constructors

• constructor

Accessors

• api

Methods

• addCallback

• cancelSelection

• confirmRoom

• getObjects

• init

• initPlanner

• loadPlan

• loadPlanBasedOnObjectId

• onPlanElementChanged

• onSelectionCancel

• onSelectionChange

• preparePartListData

• saveCurrentConfigurationInPlanSnapshot

• saveCurrentPlan

• savePlanToIdb

• switch2D

• switch3D

• switchFp

• updateProductList

Constructors

constructor

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

Parameters

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

Returns

SdkConnectorPlanner

Overrides

Connector.constructor

Accessors

api

• get api(): Promise<RoomlePlannerWithExtObjs>

Returns

Promise<RoomlePlannerWithExtObjs>

Overrides

Connector.api

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" | "onValueMapChanged" | "_creator_" | "mute" | "unmute" | "cameraStartsMoving" | "onReadyForRender" | "onItemsLoaded" | "onCameraChanged" | "onCameraIdle" | "onTotalFloorAreaChanged" | "onPlanInteractionHandlerCreated" | "onPlannerKernelIsReady" | "onPlanChanged" | "onPlanElementChanged" | "onCompletelyLoaded" | "onRotationCancel" | "onUpdateWallDimensions" | "onUpdateMeasurementLineDimensions" | "onUpdateConstructionElementsMeasurements" | "onUpdateObjectMeasurements" | "disableWallDimensions" | "onUpdatePlanObjectPositions" | "onDrawCancel" | "onDrawingStateChanged" | "onHandlerSwitchedPlans" | "onDragElementStart" | "onDragElementEnd" | "onClickElement" | "onMultiSelectionChange" | "onSelectionModeChange" | "onMeasurementLineStateChange" | "onFloorPlanAreasUpdated" | "onComponentSelectionCancel" | "onPlanSnapshotCreated" | "onStartConfiguring" | "onBackToPlanner" | "onContextChanged" | "onMergeExternalObjectGroup" | "onSplitExternalObjectGroup" | "onExternalObjectGroupArrangementChanged" | "onDeleteExternalObjectGroup" | "onDeleteExternalObjectRootModule" | "onDeleteExternalObjectSubModule" | "onDuplicateExternalObjectGroup" | "onChangedExternalObjectGroupPlan" | "onMovedExternalObjectGroup" | "onExternalObjectEnvironmentChanged" | "onExternalObjectGroupChanged" | "onExternalObjectGroupLoaded" | "onExternalObjectAttributeChanged" | "onExternalObjectModuleSelected" | "onExternalObjectSelectionCancel" | "onGetConfigurationForExternalObject"

Parameters

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

Returns

Promise<void>

Inherited from

Connector.addCallback

---

cancelSelection

▸ cancelSelection(reason): Promise<void>

Parameters

Name	Type
reason	CancelSelectionReasons

Returns

Promise<void>

---

confirmRoom

▸ confirmRoom(switchTo2D): Promise<void>

Parameters

Name	Type
switchTo2D	boolean

Returns

Promise<void>

---

getObjects

▸ getObjects(): Promise<UiPlanObject[]>

Returns

Promise<UiPlanObject[]>

---

init

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

Parameters

Name	Type
sdkWrapper	RoomleSdkWrapper
element	HTMLElement
initData	UiInitData

Returns

Promise<void>

Overrides

Connector.init

---

initPlanner

▸ initPlanner(planner): Promise<void>

Parameters

Name	Type
planner	RoomlePlannerWithExtObjs

Returns

Promise<void>

---

loadPlan

▸ loadPlan(id): Promise<void>

Parameters

Name	Type
id	string

Returns

Promise<void>

---

loadPlanBasedOnObjectId

▸ loadPlanBasedOnObjectId(id): Promise<number>

Parameters

Name	Type
id	string

Returns

Promise<number>

---

onPlanElementChanged

▸ onPlanElementChanged(changeType): Promise<void>

Parameters

Name	Type
changeType	Enumify<{}>

Returns

Promise<void>

---

onSelectionCancel

▸ onSelectionCancel(reason): Promise<void>

Parameters

Name	Type
reason	CancelSelectionReasons

Returns

Promise<void>

---

onSelectionChange

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

Parameters

Name	Type
_mode	string
objectType	Enumify<{ CONFIGURATION: "configuration" = 'configuration'; DOOR: "door" = 'door'; EXTERNAL_CONFIGURATION: "external-configuration" = 'external-configuration'; 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

---

preparePartListData

▸ preparePartListData(selectedItemPayload): Promise<void>

Parameters

Name	Type
selectedItemPayload	SelectionPayload

Returns

Promise<void>

---

saveCurrentConfigurationInPlanSnapshot

▸ saveCurrentConfigurationInPlanSnapshot(configuration): Promise<Nullable<RapiPlanSnapshotGetData | RapiPlan>>

Parameters

Name	Type
configuration	RapiConfigurationEnhanced | ExternalConfiguration

Returns

Promise<Nullable<RapiPlanSnapshotGetData | RapiPlan>>

---

saveCurrentPlan

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

Returns

Promise<Nullable<RapiPlanSnapshotGetData | RapiPlan>>

---

savePlanToIdb

▸ savePlanToIdb(): Promise<void>

Returns

Promise<void>

---

switch2D

▸ switch2D(switchScene?): Promise<void>

Parameters

Name	Type	Default value
switchScene	boolean	true

Returns

Promise<void>

---

switch3D

▸ switch3D(switchScene?): Promise<void>

Parameters

Name	Type	Default value
switchScene	boolean	true

Returns

Promise<void>

---

switchFp

▸ switchFp(switchScene?): Promise<void>

Parameters

Name	Type	Default value
switchScene	boolean	true

Returns

Promise<void>

---

updateProductList

▸ updateProductList(): Promise<void>

Returns

Promise<void>