RoomlePlanner.Internal.ExternalObjectAPI

planner-core/src/roomle-planner.internal.ExternalObjectAPI

Implemented by

• default

Table of contents

Methods

• configureExternalObjectApi
• getExternalObjectGroups
• loadExternalObjectGroup
• loadExternalObjectLibrary
• openOrCloseGeometryOfExternalObject
• removeExternalObjectGroup
• removeExternalObjectRootModule
• renderImagesOfExternalObjectGroup
• selectExternalObjectGroup
• selectExternalObjectRootModule
• selectExternalObjectSubModule

Methods

configureExternalObjectApi

▸ configureExternalObjectApi(configurationJson): Promise<void>

With "configureExternalObjectApi" the default representation of the objects and UI and the default behavior when interacting with external objects can be completely or partially overwritten. This configuration should be set prior to loading plans or objects.

Parameters

Name	Type	Description
configurationJson	string | ExternalObjectApiConfiguration	The configuration JSON as string or object.

Returns

Promise<void>

---

getExternalObjectGroups

▸ getExternalObjectGroups(): Promise<object[]>

"getExternalObjectGroups" returns all groups of external objects modules (PosData) that are currently loaded in the plan.

Returns

Promise<object[]>

---

loadExternalObjectGroup

▸ loadExternalObjectGroup(groupJson, findFreeSpaceInPlan, verifyArrangement?, mergedGroups?): Promise<void>

"loadExternalObjectGroup" loads a group of modules and places them in the plan. If the group has already been loaded, it is completely replaced by the new group. This function therefore has 2 use cases:

1. Load a new group of modules
2. Update or modify an existing group of modules The initial location of the group and the IDs of the modules are defined in the group JSON.

Parameters

Name	Type	Description
groupJson	string | object | string[]	The group JSON as string or object.
findFreeSpaceInPlan	boolean	A free space is automatically searched for in the plane.
verifyArrangement?	boolean	Verify whether the root modules of the group need to be rearranged as they have changed in size.
mergedGroups?	string[]	Groups that were merged into another group and have to be delete (this is required to generate correct undo/redo steps).

Returns

Promise<void>

---

loadExternalObjectLibrary

▸ loadExternalObjectLibrary(libraryJson): void

"loadExternalObjectLibrary" loads the master data of a library. If master data has already been loaded for the library, it is completely replaced by the new master data.

Parameters

Name	Type	Description
libraryJson	string | object	The library JSON as string or object.

Returns

void

---

openOrCloseGeometryOfExternalObject

▸ openOrCloseGeometryOfExternalObject(groupIdOrRootModuleId, subModuleId, open, animate): Promise<void>

"openOrCloseGeometryOfExternalObject" switches the geometry of the modules between closed and open representation. The function can switch the geometry of the group or the singe root module with the ID "groupIdOrRootModuleId". If "groupIdOrRootModuleId" is the ID of a root module and the "subModuleId" is also specified, only this one sub-module is opened or closed.

Parameters

Name	Type	Description
groupIdOrRootModuleId	string	The ID of the group of modules or the ID of the root module.
subModuleId	string	The ID of the sub module.
open	boolean	If true, the modules are opened, if false, they are closed, if the geometry is already in the desired state, nothing happens.
animate	boolean	If true the opening or closing is animated else the geometry is switched instantly.

Returns

Promise<void>

---

removeExternalObjectGroup

▸ removeExternalObjectGroup(groupId, wasMerged): Promise<void>

"removeExternalObjectGroup" removes a group and all its modules from the plan.

Parameters

Name	Type	Description
groupId	string	The ID of the group of modules.
wasMerged	boolean	Should be set to true if the group has been merged with another group (this is required to generate correct undo/redo steps).

Returns

Promise<void>

---

removeExternalObjectRootModule

▸ removeExternalObjectRootModule(rootModuleId): void

"removeExternalObjectRootModule" removes a root module from a group and splits the remaining group if the removed root module is located between other root modules. If the group consists of only one root module, the group is removed.

Parameters

Name	Type
rootModuleId	string

Returns

void

---

renderImagesOfExternalObjectGroup

▸ renderImagesOfExternalObjectGroup(groupsJson): Promise<{ [key: string]: string; }>

"renderImagesOfExternalObjectGroups" renders images of groups of modules.

Parameters

Name	Type
groupsJson	object

Returns

Promise<{ [key: string]: string; }>

---

selectExternalObjectGroup

▸ selectExternalObjectGroup(groupId): Promise<void>

"selectExternalObjectGroup" changes the selected object in the scene. The function selects a complete group of root modules and always switches to planning mode. If the group consists of only one root module, this is equivalent to selecting a single root module.

Parameters

Name	Type	Description
groupId	string	The ID of the group of modules.

Returns

Promise<void>

---

selectExternalObjectRootModule

▸ selectExternalObjectRootModule(rootModuleId): Promise<void>

"selectExternalObjectRootModule" changes the selected object in the scene. The function selects a root module within a group and always switches to planning mode.

Parameters

Name	Type	Description
rootModuleId	string	The ID of the root module.

Returns

Promise<void>

---

selectExternalObjectSubModule

▸ selectExternalObjectSubModule(rootModuleId, subModuleId): Promise<void>

"selectExternalObjectSubModule" changes the selected object in the scene. The function selects a sub module a root module and always switches to configuration mode.

Parameters

Name	Type	Description
rootModuleId	string	The ID of the root module.
subModuleId	string	The ID of the sub module.

Returns

Promise<void>