Documentation

configurator-core/src/services/configurator-ui-callback.default

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

• new default(creator)

# Parameters

Name Type
creator string

# Overrides

UiCallback.constructor

# Properties

# _creator_

• _creator_: string

# Inherited from

UiCallback.creator

# onComponentPositionsUpdated

• onComponentPositionsUpdated: (positions: UIComponentInfo[]) => void = null

# Type declaration

▸ (positions): void

gets called when the screen position of components/previews changes

# Parameters
Name Type
positions UIComponentInfo[]
# Returns

void

# onKernelIsReady

• onKernelIsReady: () => void = null

# Type declaration

▸ (): void

When kernel initialization is complete

# Returns

void

# Methods

# cameraStartsMoving

▸ cameraStartsMoving(): void

# Returns

void

# Inherited from

UiCallback.cameraStartsMoving

# get

▸ get(target, prop): string | (target: UiCallback, prop: keyof UiCallback) => string | (target: UiCallback, prop: keyof UiCallback) => string | ... | (() => void) | (() => void) | (() => void) | () => void | () => void | () => void | () => void | () => void | () => void

# Parameters

Name Type
target UiCallback
prop keyof UiCallback

# Returns

string | (target: UiCallback, prop: keyof UiCallback) => string | (target: UiCallback, prop: keyof UiCallback) => string | ... | (() => void) | (() => void) | (() => void) | () => void | () => void | () => void | () => void | () => void | () => void

# Inherited from

UiCallback.get

# mute

▸ mute(): void

# Returns

void

# Inherited from

UiCallback.mute

# onAddonPlusHidden

▸ onAddonPlusHidden(): void

When all addon plus symbols are hidden in the user interface

# Returns

void

# onAddonPlusHover

▸ onAddonPlusHover(): void

When user hovers over an addon plus symbol

# Returns

void

# onAddonPlusHoverOff

▸ onAddonPlusHoverOff(): void

When user hovers over an addon plus symbol

# Returns

void

# onAddonPlusShown

▸ onAddonPlusShown(): void

When all addon plus symbols are shown in the user interface

# Returns

void

# onBoundsUpdate

▸ onBoundsUpdate(bounds): void

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

# Parameters

Name Type
bounds Object
bounds.depth string
bounds.height string
bounds.kernelBounds KernelCube
bounds.width string

# Returns

void

# onCameraPositionChanges

▸ onCameraPositionChanges(): void

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

# Returns

void

# onChangeTypeChangeTag

▸ onChangeTypeChangeTag(rapiId): void

When @roomle/web-sdk/configurator-core/src/roomle-configurator#RoomleConfigurator.changeTypeChangeTag as been called and the sync has been started

# Parameters

Name Type
rapiId string

# Returns

void

# onClickComponent

▸ onClickComponent(component): void

This function gets called when a selectable component on a configurable element has been clicked on. An equivalent function for component clicks is onClickElement in the roomle-planner-ui-callback.ts

# Parameters

Name Type Description
component RoomleComponent RoomleComponent instance of the clicked component

# Returns

void

# onClickOutside

▸ onClickOutside(): void

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

# Returns

void

# onComponentLoadError

▸ onComponentLoadError(error, id): void

When a requested component could not be loaded from RAPI

# Parameters

Name Type
error Error
id string

# Returns

void

# onConfigurationHasChildren

▸ onConfigurationHasChildren(hasChildren): void

Updates when the current configuration changes

# Parameters

Name Type
hasChildren boolean

# Returns

void

# onConfigurationLabelChange

▸ onConfigurationLabelChange(catalogName, rapiItemLabel, rootComponentLabel): void

Gets called when a new item/configuration has been loaded

# Parameters

Name Type
catalogName string
rapiItemLabel string
rootComponentLabel string

# Returns

void

# onConfigurationLoadError

▸ onConfigurationLoadError(): void

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

# Returns

void

# onConfigurationReady

▸ onConfigurationReady(partList, hash, rootComponentLabel): void

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

# Parameters

Name Type
partList KernelPartList
hash string
rootComponentLabel string

# Returns

void

# onConfigurationSaved

▸ onConfigurationSaved(configurationHash): void

is called when the configuration is saved to our backend

# Parameters

Name Type
configurationHash string

# Returns

void

# onConfiguratorKernelIsReady

▸ onConfiguratorKernelIsReady(kernelContainer, kernelInstance): void

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

# Parameters

Name Type
kernelContainer PlannerKernelContainer | ConfiguratorKernelContainer
kernelInstance ConfiguratorKernelClass

# Returns

void

# onContentProblem

▸ onContentProblem(data): void

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

# Parameters

Name Type
data Object
data.ids string[]
data.message string
data.rapiPath RAPI_PATHS

# Returns

void

# onDimensionsVisibilityChange

▸ onDimensionsVisibilityChange(visible): void

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
visible boolean

# Returns

void

# onDockingsPreviewRemoved

▸ onDockingsPreviewRemoved(): void

When dockings/ghosts are no longer visible

# Returns

void

# onElementDocked

▸ onElementDocked(component, id): void

Fires after an element has been docked

# Parameters

Name Type Description
component KernelComponent the child component that was docked to the parent component
id number the runtime id of the child component

# Returns

void

# onError

▸ onError(error): void

When any generic error is thrown while requesting data

# Parameters

Name Type
error Error

# Returns

void

# onErrorDueToOffline

▸ onErrorDueToOffline(error): void

When not connected to the internet

# Parameters

Name Type
error Error

# Returns

void

# onGeometryNotReady

▸ onGeometryNotReady(runtimeId): void

This function gets called when a geometry is not ready

# Parameters

Name Type
runtimeId number

# Returns

void

# onGeometryReady

▸ onGeometryReady(runtimeId): void

This function gets called when a geometry is ready

# Parameters

Name Type Description
runtimeId number number

# Returns

void

void

# onHistoryChange

▸ onHistoryChange(undo, redo): void

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

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

# Returns

void

# onMemoryCorruption

▸ onMemoryCorruption(): void

When kernel failed to load a mesh

# Returns

void

# onNoDockingsAvailable

▸ onNoDockingsAvailable(): void

Is triggered when @roomle/web-sdk/configurator-core/src/roomle-configurator#RoomleConfigurator.previewDockings has no available dockings

# Returns

void

# onOpenAddOns

▸ onOpenAddOns(): void

When UI should show add ons

# Returns

void

# onOpenFloorMaterials

▸ onOpenFloorMaterials(): void

When UI should show floor material selection

# Returns

void

# onOpenPartList

▸ onOpenPartList(): void

When UI should show part list

# Returns

void

# onOpenTag

▸ onOpenTag(tag): void

When UI should show the overlay based on the selected tag. Gets triggered when @roomle/web-sdk/configurator-core/src/utils/shims#CommonInitData.startTag is set

# Parameters

Name Type
tag RapiTagForUi

# Returns

void

# onPartListUpdate

▸ onPartListUpdate(partList, hash): void

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

# Parameters

Name Type
partList KernelPartList
hash string

# Returns

void

# onRemoveTypeChangeTag

▸ onRemoveTypeChangeTag(rapiId): void

When @roomle/web-sdk/configurator-core/src/roomle-configurator#RoomleConfigurator.removeTypeChangeTag as been called

# Parameters

Name Type
rapiId string

# Returns

void

# onRequestExternalMesh

▸ onRequestExternalMesh(meshId, quality): void

This function gets called when an external mesh is requested

# Parameters

Name Type Description
meshId string meshId
quality number number between 0 and 100

# Returns

void

void

# onSelectionCancel

▸ onSelectionCancel(): void

When a component or item selection has been canceled

# Returns

void

# onSelectionChange

▸ onSelectionChange(selectionMode, isRoot, hasChildren, components): void

When a/another (different) component has been selected

# Parameters

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

# Returns

void

# onSyncDone

▸ onSyncDone(): void

When a previously requested sync has been completed

# Returns

void

# onSyncStarted

▸ onSyncStarted(): void

When a sync has been started

# Returns

void

# onUiIntersectionChange

▸ onUiIntersectionChange(intersections): void

When the configuration overlaps the UI (defined by @roomle/web-sdk/configurator-core/src/configurator-interfaces#CanvasOffset)

# Parameters

Name Type
intersections UIIntersection[]

# Returns

void

# onUpdateParameters

▸ onUpdateParameters(parameters): void

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

# Parameters

Name Type
parameters UiKernelParameter[]

# Returns

void

# onUpdatePossibleChildren

▸ onUpdatePossibleChildren(tags, defaultChild): void

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

# Parameters

Name Type
tags UiPossibleChildTag[]
defaultChild UiPossibleChild

# Returns

void

# onUpdatePrice

▸ onUpdatePrice(currencySymbol, price): void

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

# Parameters

Name Type
currencySymbol string
price number

# Returns

void

# onUserInitiatedDockDone

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

When a dock component call has been completed

# Parameters

Name Type Description
childDbId string the database id of the component which is docked
childDockId number the number of the dock position
parentDbId string 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, maxZoom): void

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

# onZoomToComponent

▸ onZoomToComponent(): void

When the use clicks on a configurable element twice to zoom the camera onto said element. Doesn't matter if triggered by the user or via SDK

# Returns

void

# unmute

▸ unmute(): void

# Returns

void

# Inherited from

UiCallback.unmute