# Interface: Plan
configurator-core/src/roomle-configurator.
# Hierarchy
-
↳
Plan
# Table of contents
# Properties
# Methods
- clone
- createPlanXmlWithSingleObject
- delete
- getBounds
- getId
- getPlanObjects
- getPlanXML
- getTotalFloorArea
- getWallCount
# Properties
# defaultParapetHeight
• defaultParapetHeight: number
# Defined in
packages/typings/planner.ts:48 (opens new window)
# defaultWallHeight
• defaultWallHeight: number
# Defined in
packages/typings/planner.ts:49 (opens new window)
# defaultWallThickness
• defaultWallThickness: number
# Defined in
packages/typings/planner.ts:50 (opens new window)
# extRef
• extRef: EMSReference
# Inherited from
# Defined in
packages/typings/planner.ts:36 (opens new window)
# vectorWallThickness
• vectorWallThickness: number
# Defined in
packages/typings/planner.ts:51 (opens new window)
# Methods
# clone
▸ clone(): KernelObject
# Returns
# Inherited from
# Defined in
packages/typings/planner.ts:38 (opens new window)
# createPlanXmlWithSingleObject
▸ createPlanXmlWithSingleObject(object
, includeRuntimeId
, version
): string
# Parameters
Name | Type |
---|---|
object | PlanObject |
includeRuntimeId | boolean |
version | number |
# Returns
string
# Defined in
packages/typings/planner.ts:64 (opens new window)
# delete
▸ delete(): void
# Returns
void
# Inherited from
# Defined in
packages/typings/planner.ts:40 (opens new window)
# getBounds
▸ getBounds(): KernelCube
# Returns
# Defined in
packages/typings/planner.ts:55 (opens new window)
# getId
▸ getId(): number
# Returns
number
# Overrides
# Defined in
packages/typings/planner.ts:72 (opens new window)
# getPlanObjects
▸ getPlanObjects(): any
# Returns
any
# Defined in
packages/typings/planner.ts:53 (opens new window)
# getPlanXML
▸ getPlanXML(includeRuntimeId
, xmlVersion
): string
# Parameters
Name | Type |
---|---|
includeRuntimeId | boolean |
xmlVersion | number |
# Returns
string
# Defined in
packages/typings/planner.ts:59 (opens new window)
# getTotalFloorArea
▸ getTotalFloorArea(): number
# Returns
number
# Defined in
packages/typings/planner.ts:57 (opens new window)
# getWallCount
▸ getWallCount(): number
# Returns
number