API Reference › Globals › Plan
# Class: Plan
# Hierarchy
-
↳ Plan
# Index
# Properties
# Methods
- applySettings
- clone
- delete
- getBounds
- getId
- getImageCount
- getPlanObjects
- getPlanXML
- getPlanXMLWithNormalizedLockLevels
- getTotalFloorArea
- getWallCount
- increaseLockLevels
- isEmpty
- syncToView
# Properties
# defaultParapetHeight
• defaultParapetHeight: number
Defined in packages/typings/planner-kernel-container.ts:194
# defaultWallColor
• defaultWallColor: number
Defined in packages/typings/planner-kernel-container.ts:195
# defaultWallHeight
• defaultWallHeight: number
Defined in packages/typings/planner-kernel-container.ts:196
# defaultWallThickness
• defaultWallThickness: number
Defined in packages/typings/planner-kernel-container.ts:197
# extRef
• extRef: number
Inherited from AbstractModel.extRef
Overrides KernelObject.extRef
Defined in packages/typings/planner-kernel-container.ts:58
# Methods
# applySettings
▸ applySettings(aRoomHeight: number, aParapetHeight: number): void
Defined in packages/typings/planner-kernel-container.ts:208
Parameters:
| Name | Type |
|---|---|
aRoomHeight | number |
aParapetHeight | number |
Returns: void
# clone
▸ clone(): KernelObject
Inherited from KernelObject.clone
Defined in packages/typings/planner.ts:14
Returns: KernelObject
# delete
▸ delete(): void
Inherited from KernelObject.delete
Defined in packages/typings/planner.ts:16
Returns: void
# getBounds
▸ getBounds(): KernelCube
Defined in packages/typings/planner-kernel-container.ts:202
Returns: KernelCube
▸ getBounds(): KernelCube
Defined in packages/typings/planner.ts:22
Returns: KernelCube
# getId
▸ getId(): number
Inherited from AbstractModelWrapper.getId
Overrides AbstractModel.getId
Defined in packages/typings/planner-kernel-container.ts:63
Returns: number
# getImageCount
▸ getImageCount(): number
Defined in packages/typings/planner-kernel-container.ts:205
Returns: number
# getPlanObjects
▸ getPlanObjects(): PlanObjectPtrVector
Defined in packages/typings/planner-kernel-container.ts:203
Returns: PlanObjectPtrVector
▸ getPlanObjects(): any
Defined in packages/typings/planner.ts:20
Returns: any
# getPlanXML
▸ getPlanXML(): string
Defined in packages/typings/planner-kernel-container.ts:200
Returns: string
▸ getPlanXML(includeRuntimeId: boolean, xmlVersion: number): string
Defined in packages/typings/planner.ts:26
Parameters:
| Name | Type |
|---|---|
includeRuntimeId | boolean |
xmlVersion | number |
Returns: string
# getPlanXMLWithNormalizedLockLevels
▸ getPlanXMLWithNormalizedLockLevels(): string
Defined in packages/typings/planner-kernel-container.ts:201
Returns: string
# getTotalFloorArea
▸ getTotalFloorArea(): number
Defined in packages/typings/planner-kernel-container.ts:207
Returns: number
▸ getTotalFloorArea(): number
Defined in packages/typings/planner.ts:24
Returns: number
# getWallCount
▸ getWallCount(): number
Defined in packages/typings/planner-kernel-container.ts:204
Returns: number
# increaseLockLevels
▸ increaseLockLevels(): void
Defined in packages/typings/planner-kernel-container.ts:199
Returns: void
# isEmpty
▸ isEmpty(): boolean
Defined in packages/typings/planner-kernel-container.ts:206
Returns: boolean
# syncToView
▸ syncToView(): void
Defined in packages/typings/planner-kernel-container.ts:209
Returns: void