Documentation

API Reference › Globals › ConfiguratorUiCallbacks

# Class: ConfiguratorUiCallbacks

# Hierarchy

# Implements

# Index

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new ConfiguratorUiCallbacks(creator: string): ConfiguratorUiCallbacks

Overrides UiCallback.constructor

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:300

Parameters:

Name Type
creator string

Returns: ConfiguratorUiCallbacks

# Properties

# creator

• creator: string

_Implementation of Context.creator_

_Inherited from UiCallback.creator_

Defined in packages/common-core/src/utils/ui-callback.ts:8

# onComponentPositionsUpdated

• onComponentPositionsUpdated: function = null

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:44

gets called when the screen position of components/previews changes

param

# Type declaration:

▸ (positions: UIComponentInfo[]): void

Parameters:

Name Type
positions UIComponentInfo[]

# onKernelIsReady

• onKernelIsReady: function = null

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:38

When kernel initialization is complete

# Type declaration:

▸ (): void

# Methods

# get

▸ get(target: UiCallback, prop: keyof UiCallback): UiCallback[keyof UiCallback]

Inherited from UiCallback.get

Defined in packages/common-core/src/utils/ui-callback.ts:34

Parameters:

Name Type
target UiCallback
prop keyof UiCallback

Returns: UiCallback[keyof UiCallback]

# mute

▸ mute(): void

Inherited from UiCallback.mute

Defined in packages/common-core/src/utils/ui-callback.ts:17

Returns: void

# onAddonPlusHidden

▸ onAddonPlusHidden(): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:213

When all addon plus symbols are hidden in the user interface

Returns: void

# onAddonPlusHover

▸ onAddonPlusHover(): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:198

When user hovers over an addon plus symbol

Returns: void

# onAddonPlusHoverOff

▸ onAddonPlusHoverOff(): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:203

When user hovers over an addon plus symbol

Returns: void

# onAddonPlusShown

▸ onAddonPlusShown(): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:208

When all addon plus symbols are shown in the user interface

Returns: void

# onBoundsUpdate

▸ onBoundsUpdate(bounds: object): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:96

When the bounds of the object are changed/updated, this event is triggered on start up and when a configuration changes

Parameters:

▪ bounds: object

Name Type
depth string
height string
kernelBounds KernelCube
width string

Returns: void

# onCameraPositionChanges

▸ onCameraPositionChanges(): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:293

called when camera position starts to change or is changing at the moment

Returns: void

# onChangeTypeChangeTag

▸ onChangeTypeChangeTag(rapiId: RapiId): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:257

When {@link changeTypeChangeTag} as been called and the sync has been started

Parameters:

Name Type Description
rapiId RapiId

Returns: void

# onClickOutside

▸ onClickOutside(): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:125

When the user clicks on no UI element, can be used to deselect

Returns: void

# onComponentLoadError

▸ onComponentLoadError(error: Error, id: RapiId): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:246

When a requested component could not be loaded from RAPI

Parameters:

Name Type Description
error Error -
id RapiId

Returns: void

# onConfigurationHasChildren

▸ onConfigurationHasChildren(hasChildren: boolean): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:173

Updates when the current configuration changes

Parameters:

Name Type Description
hasChildren boolean

Returns: void

# onConfigurationLabelChange

▸ onConfigurationLabelChange(catalogName: string, rapiItemLabel: string, rootComponentLabel: string): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:271

Gets called when a new item/configuration has been loaded

Parameters:

Name Type Description
catalogName string -
rapiItemLabel string -
rootComponentLabel string

Returns: void

# onConfigurationLoadError

▸ onConfigurationLoadError(): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:251

Gets called when configuration/configurable-item could not be loaded

Returns: void

# onConfigurationReady

▸ onConfigurationReady(partList: KernelPartList, hash: ConfigurationHash, rootComponentLabel: string): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:109

When configuration has been loaded completely, this can be useful to hide loading indicators

Parameters:

Name Type Description
partList KernelPartList -
hash ConfigurationHash -
rootComponentLabel string

Returns: void

# onConfigurationSaved

▸ onConfigurationSaved(configurationHash: ConfigurationHash): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:288

is called when the configuration is saved to our backend

Parameters:

Name Type
configurationHash ConfigurationHash

Returns: void

# onConfiguratorKernelIsReady

▸ onConfiguratorKernelIsReady(kernelContainer: ConfiguratorKernelContainer | PlannerKernelContainer, kernelInstance: ConfiguratorKernelClass): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:283

is called when the configurator kernel is ready. It returns the container and the instance

Parameters:

Name Type Description
kernelContainer ConfiguratorKernelContainer | PlannerKernelContainer -
kernelInstance ConfiguratorKernelClass

Returns: void

# onContentProblem

▸ onContentProblem(data: object): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:219

When an asset could not be loaded (for example an image or texture). See paths or ids to identify the problem.

Parameters:

▪ data: object

Name Type
ids RapiId[]
message string
rapiPath RAPI_PATHS

Returns: void

# onDimensionsVisibilityChange

▸ onDimensionsVisibilityChange(visible: boolean): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:150

When the visibility of the dimensions changes from visible to gone or vice versa. Doesn't matter if triggered by the user or via SDK

Parameters:

Name Type Description
visible boolean

Returns: void

# onDockingsPreviewRemoved

▸ onDockingsPreviewRemoved(): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:167

When dockings/ghosts are no longer visible

Returns: void

# onError

▸ onError(error: Error): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:162

When any generic error is thrown while requesting data

Parameters:

Name Type Description
error Error

Returns: void

# onErrorDueToOffline

▸ onErrorDueToOffline(error: Error): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:156

When not connected to the internet

Parameters:

Name Type Description
error Error

Returns: void

# onHistoryChange

▸ onHistoryChange(undo: boolean, redo: boolean): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:300

gets called if history changes

Parameters:

Name Type Description
undo boolean true if undo is possible
redo boolean true if redo is possible

Returns: void

# onLoadConfiguration

▸ onLoadConfiguration(): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:101

When a new item or configuration is loading, this can be useful to display loading screens etc

Returns: void

# onMemoryCorruption

▸ onMemoryCorruption(): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:276

When kernel failed to load a mesh

Returns: void

# onNoDockingsAvailable

▸ onNoDockingsAvailable(): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:130

When previewDockings has no available dockings

Returns: void

# onOpenAddOns

▸ onOpenAddOns(): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:120

When UI should show add ons

Returns: void

# onOpenFloorMaterials

▸ onOpenFloorMaterials(): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:234

When UI should show floor material selection

Returns: void

# onOpenPartList

▸ onOpenPartList(): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:239

When UI should show part list

Returns: void

# onOpenTag

▸ onOpenTag(tag: RapiTagForUi): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:115

When UI should show the overlay based on the selected tag. Gets triggered when CommonInitData.startTag is set

Parameters:

Name Type Description
tag RapiTagForUi

Returns: void

# onPartListUpdate

▸ onPartListUpdate(partList: KernelPartList, hash: ConfigurationHash): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:89

When part list has been changed/updated, this event is triggered on start up and when a configuration changes

Parameters:

Name Type Description
partList KernelPartList -
hash ConfigurationHash

Returns: void

# onRemoveTypeChangeTag

▸ onRemoveTypeChangeTag(rapiId: RapiId): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:263

When removeTypeChangeTag as been called

Parameters:

Name Type Description
rapiId RapiId

Returns: void

# onSelectionCancel

▸ onSelectionCancel(): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:81

When a component or item selection has been canceled

Returns: void

# onSelectionChange

▸ onSelectionChange(selectionMode: string, isRoot: boolean, hasChildren: boolean, components: KernelComponent[]): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:76

When a/another (different) component has been selected

Parameters:

Name Type Description
selectionMode string -
isRoot boolean -
hasChildren boolean -
components KernelComponent[]

Returns: void

# onSyncDone

▸ onSyncDone(): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:229

When a previously requested sync has been completed

Returns: void

# onSyncStarted

▸ onSyncStarted(): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:224

When a sync has been started

Returns: void

# onUiIntersectionChange

▸ onUiIntersectionChange(intersections: UIIntersection[]): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:136

When the configuration overlaps the UI (defined by CanvasOffset)

Parameters:

Name Type Description
intersections UIIntersection[]

Returns: void

# onUpdateParameters

▸ onUpdateParameters(parameters: UiKernelParameter[]): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:51

When component parameters are changed/updated, this event is triggered on start up and when a configuration changes

Parameters:

Name Type Description
parameters UiKernelParameter[]

Returns: void

# onUpdatePossibleChildren

▸ onUpdatePossibleChildren(tags: UiPossibleChildTag[], defaultChild: UiPossibleChild): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:59

When children of a component change, this event is triggered on start up and when a configuration changes

Parameters:

Name Type Description
tags UiPossibleChildTag[] -
defaultChild UiPossibleChild

Returns: void

# onUpdatePrice

▸ onUpdatePrice(currencySymbol: string, price: number): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:67

When the price of a configuration/item changes, this event is triggered on start up and when a configuration changes

Parameters:

Name Type Description
currencySymbol string -
price number

Returns: void

# onUserInitiatedDockDone

▸ onUserInitiatedDockDone(childDbId: RapiId, childDockId: number, parentDbId: RapiId, parentDockId: number, position: KernelVector3): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:193

When a dock component call has been completed

Parameters:

Name Type Description
childDbId RapiId the database id of the component which is docked
childDockId number the number of the dock position
parentDbId RapiId the database id of the component to which is docked
parentDockId number the number of the dock position to which is docked
position KernelVector3 vector where the dock is done can be null

Returns: void

# onZoomChange

▸ onZoomChange(minZoom: boolean, maxZoom: boolean): void

Defined in packages/configurator-core/src/services/configurator-ui-callback.ts:143

When the zoom level has been changed by the user

Parameters:

Name Type Description
minZoom boolean true when zoomed out as far as possible
maxZoom boolean true when zoomed in as much as possible

Returns: void

# unmute

▸ unmute(): void

Inherited from UiCallback.unmute

Defined in packages/common-core/src/utils/ui-callback.ts:21

Returns: void