API ReferenceGlobalsPlan

# Class: Plan

# Hierarchy

AbstractModelWrapper

# Index

# Properties

# Methods

# Properties

# defaultParapetHeight

defaultParapetHeight: number

Defined in packages/typings/planner-kernel-container.ts:239

Defined in packages/typings/planner.ts:28


# defaultWallColor

defaultWallColor: number

Defined in packages/typings/planner-kernel-container.ts:240


# defaultWallHeight

defaultWallHeight: number

Defined in packages/typings/planner-kernel-container.ts:241

Defined in packages/typings/planner.ts:29


# defaultWallThickness

defaultWallThickness: number

Defined in packages/typings/planner-kernel-container.ts:242

Defined in packages/typings/planner.ts:30


# extRef

extRef: number

Inherited from AbstractModel.extRef

Overrides KernelObject.extRef

Defined in packages/typings/planner-kernel-container.ts:75

# Methods

# applySettings

applySettings(aRoomHeight: number, aParapetHeight: number): void

Defined in packages/typings/planner-kernel-container.ts:262

Parameters:

Name Type
aRoomHeight number
aParapetHeight number

Returns: void


# clone

clone(): KernelObject

Inherited from KernelObject.clone

Defined in packages/typings/planner.ts:20

Returns: KernelObject


# delete

delete(): void

Inherited from KernelObject.delete

Defined in packages/typings/planner.ts:22

Returns: void


# getBounds

getBounds(): KernelCube

Defined in packages/typings/planner-kernel-container.ts:250

Returns: KernelCube

getBounds(): KernelCube

Defined in packages/typings/planner.ts:34

Returns: KernelCube


# getId

getId(): number

Inherited from AbstractModelWrapper.getId

Overrides AbstractModel.getId

Defined in packages/typings/planner-kernel-container.ts:81

Returns: number


# getImageCount

getImageCount(): number

Defined in packages/typings/planner-kernel-container.ts:256

Returns: number


# getPlanObjects

getPlanObjects(): PlanObjectPtrVector

Defined in packages/typings/planner-kernel-container.ts:252

Returns: PlanObjectPtrVector

getPlanObjects(): any

Defined in packages/typings/planner.ts:32

Returns: any


# getPlanXML

getPlanXML(): string

Defined in packages/typings/planner-kernel-container.ts:246

Returns: string

getPlanXML(includeRuntimeId: boolean, xmlVersion: number): string

Defined in packages/typings/planner.ts:38

Parameters:

Name Type
includeRuntimeId boolean
xmlVersion number

Returns: string


# getPlanXMLWithNormalizedLockLevels

getPlanXMLWithNormalizedLockLevels(): string

Defined in packages/typings/planner-kernel-container.ts:248

Returns: string


# getTotalFloorArea

getTotalFloorArea(): number

Defined in packages/typings/planner-kernel-container.ts:260

Returns: number

getTotalFloorArea(): number

Defined in packages/typings/planner.ts:36

Returns: number


# getWallCount

getWallCount(): number

Defined in packages/typings/planner-kernel-container.ts:254

Returns: number

getWallCount(): number

Defined in packages/typings/planner.ts:40

Returns: number


# increaseLockLevels

increaseLockLevels(): void

Defined in packages/typings/planner-kernel-container.ts:244

Returns: void


# isEmpty

isEmpty(): boolean

Defined in packages/typings/planner-kernel-container.ts:258

Returns: boolean


# syncToView

syncToView(): void

Defined in packages/typings/planner-kernel-container.ts:264

Returns: void