ExposedApi.Internal.SdkConnectorPlanner

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

NameTypeDefault value

store

Store<StoreState>

undefined

analytics

null

eventEmitter

null

Returns

SdkConnectorPlanner

Overrides

Connector.constructor

Accessors

api

get api(): Promise<default>

Returns

Promise<default>

Overrides

Connector.api

Methods

addCallback

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

Type parameters

NameType

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" | "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" | "onContextChanged"

Parameters

NameTypeDefault value

key

K

undefined

fun

undefined

allowMultiple

boolean

false

Returns

Promise<void>

Inherited from

Connector.addCallback


cancelSelection

cancelSelection(): Promise<void>

Returns

Promise<void>


confirmRoom

confirmRoom(switchTo2D): Promise<void>

Parameters

NameType

switchTo2D

boolean

Returns

Promise<void>


getObjects

getObjects(): Promise<UiPlanObject[]>

Returns

Promise<UiPlanObject[]>


init

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

Parameters

NameType

sdkWrapper

element

HTMLElement

initData

Returns

Promise<void>

Overrides

Connector.init


initPlanner

initPlanner(planner): Promise<void>

Parameters

NameType

planner

default

Returns

Promise<void>


loadPlan

loadPlan(id): Promise<void>

Parameters

NameType

id

string

Returns

Promise<void>


loadPlanBasedOnObjectId

loadPlanBasedOnObjectId(id): Promise<number>

Parameters

NameType

id

string

Returns

Promise<number>


onPlanElementChanged

onPlanElementChanged(changeType): Promise<void>

Parameters

NameType

changeType

Returns

Promise<void>


onSelectionCancel

onSelectionCancel(reason): Promise<void>

Parameters

NameType

reason

CancelSelectionReasons

Returns

Promise<void>


onSelectionChange

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

Parameters

NameType

_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


preparePartListData

preparePartListData(selectedItemPayload): Promise<void>

Parameters

NameType

selectedItemPayload

SelectionPayload

Returns

Promise<void>


saveCurrentPlan

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

Returns

Promise<Nullable<RapiPlanSnapshotGetData | RapiPlan>>


savePlanToIdb

savePlanToIdb(): Promise<void>

Returns

Promise<void>


switch2D

switch2D(): Promise<void>

Returns

Promise<void>


switch3D

switch3D(): Promise<void>

Returns

Promise<void>


switchFp

switchFp(): Promise<void>

Returns

Promise<void>


updateProductList

updateProductList(): Promise<void>

Returns

Promise<void>

Last updated