Class BimCTMetadataAccessor

Class to access BIM CT Design Models Metadata like Tree Structure, Element Properties, etc.

Hierarchy

BimCTMetadataAccessor

Index

Constructors

Methods

checkElementVisible getAggregatedPropertyValues getBulkElementData getChildrenElementIds getContainsElementIds getElementData getElementDescription getElementMembershipData getElementName getMemberships getModelGeolocationData getModelRootElementIds getPartialElementData getPathIds

Constructors

constructor

new BimCTMetadataAccessor(): BimCTMetadataAccessor
Constructor to initialize the metadata accessor.

Returns BimCTMetadataAccessor
- Defined in loader/metadata.ts:17

Methods

checkElementVisible

checkElementVisible(modelId: Int64, elementId: Int64): boolean
Checks if an element is visible.

Returns
True if the element is visible, otherwise false.
Parameters
- modelId: Int64
  
  The model ID.
- elementId: Int64
  
  The element ID.
Returns boolean
- Defined in loader/metadata.ts:33

getAggregatedPropertyValues

getAggregatedPropertyValues(elementIds: Int64[], props: { propGroup: string; propName: string }[], visibleOnly?: boolean): number[]
Gets the aggregated property values of elements.

Returns
An array of aggregated property values.
Parameters
- elementIds: Int64[]
  
  The element IDs.
- props: { propGroup: string; propName: string }[]
  
  The properties to aggregate.
- visibleOnly: boolean = true
  
  Whether to include only visible elements (default: true).
Returns number[]
- Defined in loader/metadata.ts:597

getBulkElementData

getBulkElementData(elementIds: Int64[], visibleOnly?: boolean, aggregateProperties?: boolean): BulkElementData
Gets the bulk data of elements.

Returns
The bulk element data.
Parameters
- elementIds: Int64[]
  
  The element IDs.
- visibleOnly: boolean = true
  
  Whether to include only visible elements (default: true).
- aggregateProperties: boolean = false
  
  Whether to aggregate properties (default: false).
Returns BulkElementData
- Defined in loader/metadata.ts:627

getChildrenElementIds

getChildrenElementIds(modelId: Int64, elementId: Int64): Int64[]
Gets the children element IDs of a model element.

Returns
An array of children element IDs.
Parameters
- modelId: Int64
  
  The model ID.
- elementId: Int64
  
  The element ID.
Returns Int64[]
- Defined in loader/metadata.ts:66

getContainsElementIds

getContainsElementIds(modelId: Int64, elementId: Int64): Int64[]
Gets the contained element IDs of a model element.

Returns
An array of contained element IDs.
Parameters
- modelId: Int64
  
  The model ID.
- elementId: Int64
  
  The element ID.
Returns Int64[]
- Defined in loader/metadata.ts:87

getElementData

getElementData(modelId: Int64, elementId: Int64, includeProperties?: boolean): ElementData
Gets the data of a model element.

Returns
The element data.
Parameters
- modelId: Int64
  
  The model ID.
- elementId: Int64
  
  The element ID.
- includeProperties: boolean = true
  
  Whether to include properties (default: true).
Returns ElementData
- Defined in loader/metadata.ts:385

getElementDescription

getElementDescription(modelId: Int64, elementId: Int64): { name: string; type: string }
Gets the description of a model element.

Returns
An object containing the name and type of the element.
Parameters
- modelId: Int64
  
  The model ID.
- elementId: Int64
  
  The element ID.
Returns { name: string; type: string }
- name: string
- type: string
- Defined in loader/metadata.ts:129

getElementMembershipData

getElementMembershipData(modelId: Int64, elementId: Int64): MembershipData[]
Gets the membership data of a model element.

Returns
An array of membership data.
Parameters
- modelId: Int64
  
  The model ID.
- elementId: Int64
  
  The element ID.
Returns MembershipData[]
- Defined in loader/metadata.ts:337

getElementName

getElementName(modelId: Int64, elementId: Int64): string
Gets the name of a model element.

Returns
The name of the element.
Parameters
- modelId: Int64
  
  The model ID.
- elementId: Int64
  
  The element ID.
Returns string
- Defined in loader/metadata.ts:555

getMemberships

getMemberships(modelId: Int64): MembershipData[]
Gets the memberships of a model.

Returns
An array of membership data.
Parameters
- modelId: Int64
  
  The model ID.
Returns MembershipData[]
- Defined in loader/metadata.ts:295

getModelGeolocationData

getModelGeolocationData(modelId?: Int64): ModelLocation
Gets the geolocation data of a model.

Returns
The geolocation data of the model.
Parameters
- Optional modelId: Int64
  
  The model ID (optional).
Returns ModelLocation
- Defined in loader/metadata.ts:236

getModelRootElementIds

getModelRootElementIds(modelId: Int64): Int64[]
Gets the root element IDs of a model.

Returns
An array of root element IDs.
Parameters
- modelId: Int64
  
  The model ID.
Returns Int64[]
- Defined in loader/metadata.ts:45

getPartialElementData

getPartialElementData(modelId: Int64, elementId: Int64): ElementData
Gets the partial data of a model element.

Returns
The partial element data.
Parameters
- modelId: Int64
  
  The model ID.
- elementId: Int64
  
  The element ID.
Returns ElementData
- Defined in loader/metadata.ts:475

getPathIds

getPathIds(modelId: Int64, elementId: Int64): Int64[]
Gets the path IDs of a model element.

Returns
An array of path IDs.
Parameters
- modelId: Int64
  
  The model ID.
- elementId: Int64
  
  The element ID.
Returns Int64[]
- Defined in loader/metadata.ts:108

Class BimCTMetadataAccessor

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns BimCTMetadataAccessor

Methods

checkElementVisible

Returns

Parameters

modelId: Int64

elementId: Int64

Returns boolean

getAggregatedPropertyValues

Returns

Parameters

elementIds: Int64[]

props: { propGroup: string; propName: string }[]

visibleOnly: boolean = true

Returns number[]

getBulkElementData

Returns

Parameters

elementIds: Int64[]

visibleOnly: boolean = true

aggregateProperties: boolean = false

Returns BulkElementData

getChildrenElementIds

Returns

Parameters

modelId: Int64

elementId: Int64

Returns Int64[]

getContainsElementIds

Returns

Parameters

modelId: Int64

elementId: Int64

Returns Int64[]

getElementData

Returns

Parameters

modelId: Int64

elementId: Int64

includeProperties: boolean = true

Returns ElementData

getElementDescription

Returns

Parameters

modelId: Int64

elementId: Int64

Returns { name: string; type: string }

name: string

type: string

getElementMembershipData

Returns

Parameters

modelId: Int64

elementId: Int64

Returns MembershipData[]

getElementName

Returns

Parameters

modelId: Int64

elementId: Int64

Returns string

getMemberships

Returns

Parameters

modelId: Int64

Returns MembershipData[]

getModelGeolocationData

Returns

Parameters

Optional modelId: Int64

Returns ModelLocation

getModelRootElementIds

Returns

`Optional` modelId: Int64