ExposedApi.Internal.SdkConnectorConfigurator

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

Class: SdkConnectorConfigurator

exposed-api.<internal>.SdkConnectorConfigurator

Hierarchy

• Connector

  ↳ SdkConnectorConfigurator

Table of contents

Constructors

• constructor

Accessors

• api

Methods

• addCallback

• addUiCallback

• init

• initConfigurator

• removeUiCallback

• saveConfigurationToIdb

• setParameter

• setPrice

Constructors

constructor

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

Parameters

Name	Type	Default value
store		undefined
analytics		null
eventEmitter		undefined

Returns

SdkConnectorConfigurator

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

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" | "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" | "onDeleteExternalObjectGroup" | "onDeleteExternalObjectRootModule" | "onDeleteExternalObjectSubModule" | "onDuplicateExternalObjectGroup" | "onMovedExternalObjectGroup" | "onExternalObjectEnvironmentChanged" | "onExternalObjectGroupChanged" | "onExternalObjectGroupLoaded" | "onExternalObjectAttributeChanged" | "onExternalObjectModuleSelected" | "onExternalObjectSelectionCancel"

Parameters

Name	Type	Default value
key	K	undefined
fun		undefined
allowMultiple	boolean	false

Returns

Promise<void>

Inherited from

Connector.addCallback

---

addUiCallback

▸ addUiCallback(listener): void

Parameters

Name	Type
listener

Returns

void

---

init

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

Parameters

Name	Type
sdkWrapper
element	HTMLElement
initData

Returns

Promise<void>

Overrides

Connector.init

---

initConfigurator

▸ initConfigurator(configurator): Promise<void>

Parameters

Name	Type
configurator	default

Returns

Promise<void>

---

removeUiCallback

▸ removeUiCallback(listener): void

Parameters

Name	Type
listener

Returns

void

---

saveConfigurationToIdb

▸ saveConfigurationToIdb(): Promise<void>

Returns

Promise<void>

---

setParameter

▸ setParameter(parameter, value, isRaw?): Promise<void>

Parameters

Name	Type	Default value
parameter	KernelParameter	undefined
value	string	undefined
isRaw	boolean	false

Returns

Promise<void>

---

setPrice

▸ setPrice(currencySymbol, price): void

Parameters

Name	Type
currencySymbol	string
price	number

Returns

void