Documentation

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

# Class: SdkConnectorConfigurator

exposed-api.<internal>.SdkConnectorConfigurator

# Hierarchy

# Table of contents

# Constructors

# Accessors

# Methods

# Constructors

# constructor

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

# Parameters

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

# Returns

SdkConnectorConfigurator

# Overrides

Connector.constructor

# Defined in

src/configurator/business-logic/sdk-connector-configurator.ts:60 (opens new window)

# Accessors

# api

• get api(): Promise<default>

# Returns

Promise<default>

# Overrides

Connector.api

# Defined in

src/configurator/business-logic/sdk-connector-configurator.ts:71 (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)

# addUiCallback

▸ addUiCallback(listener): void

# Parameters

Name Type
listener UiCallbacks

# Returns

void

# Defined in

src/configurator/business-logic/sdk-connector-configurator.ts:395 (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/configurator/business-logic/sdk-connector-configurator.ts:78 (opens new window)

# initConfigurator

▸ initConfigurator(configurator): Promise<void>

# Parameters

Name Type
configurator default

# Returns

Promise<void>

# Defined in

src/configurator/business-logic/sdk-connector-configurator.ts:91 (opens new window)

# removeUiCallback

▸ removeUiCallback(listener): void

# Parameters

Name Type
listener UiCallbacks

# Returns

void

# Defined in

src/configurator/business-logic/sdk-connector-configurator.ts:402 (opens new window)

# saveConfigurationToIdb

▸ saveConfigurationToIdb(): Promise<void>

# Returns

Promise<void>

# Defined in

src/configurator/business-logic/sdk-connector-configurator.ts:440 (opens new window)

# setParameter

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

# Parameters

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

# Returns

Promise<void>

# Defined in

src/configurator/business-logic/sdk-connector-configurator.ts:369 (opens new window)

# setPrice

▸ setPrice(currencySymbol, price): void

# Parameters

Name Type
currencySymbol string
price number

# Returns

void

# Defined in

src/configurator/business-logic/sdk-connector-configurator.ts:388 (opens new window)