getElementProperties Method
| Overloads | |
|---|---|
| getElementProperties(requestOptions) | |
| getElementProperties<TParsedContent>(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<TParsedContent>(requestOptions)
Retrieves property data in simplified format for multiple elements specified by class or all element.
getElementProperties<TParsedContent>(requestOptions: MultiElementPropertiesRequestOptions<IModelDb, TParsedContent> & { priority?: number } & { cancelEvent?: BeEvent<() => void> } & BackendDiagnosticsAttribute): Promise<MultiElementPropertiesResponse<TParsedContent>>
@returns An object that contains element count and AsyncGenerator to iterate over properties of those elements in batches of undefined size.
| Parameter | Type | Description |
|---|---|---|
| requestOptions | MultiElementPropertiesRequestOptions<IModelDb, TParsedContent> & { priority?: number } & { cancelEvent?: BeEvent<() => void> } & BackendDiagnosticsAttribute |
Returns - Promise<MultiElementPropertiesResponse<TParsedContent>>
An object that contains element count and AsyncGenerator to iterate over properties of those elements in batches of undefined size.
Defined in
Last Updated: 16 April, 2024