getElementProperties Method

Overloads
getElementProperties(requestOptions)  
getElementProperties(requestOptions)  

getElementProperties(requestOptions)

Retrieves property data in a simplified format for a single element specified by ID.

getElementProperties(requestOptions: SingleElementPropertiesRequestOptions<IModelDb> & { priority?: number } & { cancelEvent?: BeEvent<() => void> } & BackendDiagnosticsAttribute): Promise<undefined | ElementProperties>

Parameter Type Description
requestOptions SingleElementPropertiesRequestOptions<IModelDb> & { priority?: number } & { cancelEvent?: BeEvent<() => void> } & BackendDiagnosticsAttribute  

Returns - Promise<undefined | ElementProperties>



getElementProperties(requestOptions)

Retrieves property data in simplified format for multiple elements specified by class or all element.

getElementProperties(requestOptions: MultiElementPropertiesRequestOptions<IModelDb> & { priority?: number } & { cancelEvent?: BeEvent<() => void> } & BackendDiagnosticsAttribute): Promise<MultiElementPropertiesResponse>

Parameter Type Description
requestOptions MultiElementPropertiesRequestOptions<IModelDb> & { priority?: number } & { cancelEvent?: BeEvent<() => void> } & BackendDiagnosticsAttribute  

Returns - Promise<MultiElementPropertiesResponse>

An object that contains element count and AsyncGenerator to iterate over properties of those elements in batches of undefined size.


Defined in

Last Updated: 30 November, 2023