Class CostNamespace

Read-only 5D cost data for a loaded model.

Reads observe the model's PENDING edits by default (#4857), so what bim.cost reports and what bim.export.ifc() writes describe the same file. Pass { includeMutations: false } for the graph as the file on disk states it — not an empty graph, and not an error.

Index

Constructors

Methods

data evaluateItem evaluateValue items schedules values

Constructors

constructor

new CostNamespace(backend: BimBackend): CostNamespace
Parameters
- backend: BimBackend
Returns CostNamespace

Methods

data

data(modelId?: string, options?: CostReadOptions): CostGraphData
Parameters
- OptionalmodelId: string
- Optionaloptions: CostReadOptions
Returns CostGraphData

evaluateItem

evaluateItem(
ref: EntityRef,
options?: CostEvaluationOptions & CostReadOptions,
): CostEvaluationData
Parameters
- ref: EntityRef
- Optionaloptions: CostEvaluationOptions & CostReadOptions
Returns CostEvaluationData

evaluateValue

evaluateValue(
ref: EntityRef,
options?: CostEvaluationOptions & CostReadOptions,
): CostEvaluationData
Parameters
- ref: EntityRef
- Optionaloptions: CostEvaluationOptions & CostReadOptions
Returns CostEvaluationData

items

items(modelId?: string, options?: CostReadOptions): CostItemData[]
Parameters
- OptionalmodelId: string
- Optionaloptions: CostReadOptions
Returns CostItemData[]

schedules

schedules(modelId?: string, options?: CostReadOptions): CostScheduleData[]
Parameters
- OptionalmodelId: string
- Optionaloptions: CostReadOptions
Returns CostScheduleData[]

values

values(modelId?: string, options?: CostReadOptions): CostValueData[]
Parameters
- OptionalmodelId: string
- Optionaloptions: CostReadOptions
Returns CostValueData[]