API Reference › Globals › RoomlePlannerUiCallback
# Class: RoomlePlannerUiCallback
# Hierarchy
-
↳ RoomlePlannerUiCallback
# Implements
# Index
# Constructors
# Properties
# Methods
- get
- mute
- onCameraChanged
- onCompletelyLoaded
- onConfiguratorKernelIsReady
- onHistoryChange
- onItemsLoaded
- onPlanChanged
- onPlanElementChanged
- onPlanInteractionHandlerCreated
- onPlannerKernelIsReady
- onRotationCancel
- onSelectionCancel
- onSelectionChange
- onTotalFloorAreaChanged
- unmute
# Constructors
# constructor
+ new RoomlePlannerUiCallback(creator: string): RoomlePlannerUiCallback
Overrides UiCallback.constructor
Defined in packages/planner-core/src/roomle-planner-ui-callback.ts:18
Parameters:
| Name | Type |
|---|---|
creator | string |
Returns: RoomlePlannerUiCallback
# Properties
# creator
• creator: string
_Implementation of Context.creator_
_Inherited from UiCallback.creator_
Defined in packages/common-core/src/utils/ui-callback.ts:8
# 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
# onCameraChanged
▸ onCameraChanged(type: CAMERA_TYPE): void
Defined in packages/planner-core/src/roomle-planner-ui-callback.ts:28
Parameters:
| Name | Type |
|---|---|
type | CAMERA_TYPE |
Returns: void
# onCompletelyLoaded
▸ onCompletelyLoaded(): void
Defined in packages/planner-core/src/roomle-planner-ui-callback.ts:81
When the plan has been completely loaded
Returns: void
# onConfiguratorKernelIsReady
▸ onConfiguratorKernelIsReady(kernelContainer: PlannerKernelContainer, kernelInstance: ConfiguratorKernelClass): void
Defined in packages/planner-core/src/roomle-planner-ui-callback.ts:52
is called when the configurator kernel is ready. It returns the container and the instance
Parameters:
| Name | Type | Description |
|---|---|---|
kernelContainer | PlannerKernelContainer | - |
kernelInstance | ConfiguratorKernelClass |
Returns: void
# onHistoryChange
▸ onHistoryChange(undo: boolean, redo: boolean): void
Defined in packages/planner-core/src/roomle-planner-ui-callback.ts:93
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
# onItemsLoaded
▸ onItemsLoaded(): void
Defined in packages/planner-core/src/roomle-planner-ui-callback.ts:24
Returns: void
# onPlanChanged
▸ onPlanChanged(): void
Defined in packages/planner-core/src/roomle-planner-ui-callback.ts:71
When something in the plan has changed
Returns: void
# onPlanElementChanged
▸ onPlanElementChanged(): void
Defined in packages/planner-core/src/roomle-planner-ui-callback.ts:76
When an element in the plan has been added, removed or changed
Returns: void
# onPlanInteractionHandlerCreated
▸ onPlanInteractionHandlerCreated(planInteractionHandler: PlanInteractionHandler): void
Defined in packages/planner-core/src/roomle-planner-ui-callback.ts:36
Parameters:
| Name | Type |
|---|---|
planInteractionHandler | PlanInteractionHandler |
Returns: void
# onPlannerKernelIsReady
▸ onPlannerKernelIsReady(kernelContainer: PlannerKernelContainer): void
Defined in packages/planner-core/src/roomle-planner-ui-callback.ts:45
is called when the planner kernel is ready. It returns the container and the instance
Parameters:
| Name | Type |
|---|---|
kernelContainer | PlannerKernelContainer |
Returns: void
# onRotationCancel
▸ onRotationCancel(): void
Defined in packages/planner-core/src/roomle-planner-ui-callback.ts:86
When rotation mode has been canceled
Returns: void
# onSelectionCancel
▸ onSelectionCancel(): void
Defined in packages/planner-core/src/roomle-planner-ui-callback.ts:66
When an item selection has been canceled
Returns: void
# onSelectionChange
▸ onSelectionChange(selectionMode: SELECTIONMODE, objectType: "static" | "configuration", payload: SelectionPayload, payloadPromise: Promise‹SelectionPayload›): _void
Defined in packages/planner-core/src/roomle-planner-ui-callback.ts:61
When an item has been selected
Parameters:
| Name | Type | Description |
|---|---|---|
selectionMode | SELECTION_MODE | - |
objectType | "static" | "configuration" | currently only static items and configurations are supported |
payload | SelectionPayload | returns the data which is available immediatelly (sync), currently this is catalogItemId and/or configurationRuntimeId |
payloadPromise | Promise‹SelectionPayload› | this promise resolves when the data of an object is fetched |
Returns: void
# onTotalFloorAreaChanged
▸ onTotalFloorAreaChanged(totalFloorArea: number): void
Defined in packages/planner-core/src/roomle-planner-ui-callback.ts:32
Parameters:
| Name | Type |
|---|---|
totalFloorArea | number |
Returns: void
# unmute
▸ unmute(): void
Inherited from UiCallback.unmute
Defined in packages/common-core/src/utils/ui-callback.ts:21
Returns: void