deleteElementTree Function
Deletes an element tree starting with the specified top element. The top element is also deleted. Uses ElementTreeDeleter.
deleteElementTree(txn: EditTxn, topElement: string, maxPasses?: number): void
| Parameter | Type | Description |
|---|---|---|
| txn | EditTxn | The EditTxn used to perform the deletes. |
| topElement | string | The parent of the sub-tree |
| maxPasses | number | The maximum number of passes to make when deleting definition elements. |
Returns - void
Deletes an element tree starting with the specified top element. The top element is also deleted. Uses ElementTreeDeleter.
deleteElementTree(iModel: IModelDb, topElement: string): void
| Parameter | Type | Description |
|---|---|---|
| iModel | IModelDb | The iModel |
| topElement | string | The parent of the sub-tree |
Returns - void
Deletes an element tree starting with the specified top element. The top element is also deleted. Uses ElementTreeDeleter.
deleteElementTree(args: DeleteElementTreeArgs): void
| Parameter | Type | Description |
|---|---|---|
| args | DeleteElementTreeArgs | Specifies the transaction and top element. |
Returns - void
Deletes an element tree starting with the specified top element. The top element is also deleted. Uses ElementTreeDeleter.
deleteElementTree(args: { iModel: IModelDb, maxPasses?: number, topElement: string }): void
| Parameter | Type | Description |
|---|---|---|
| args | { iModel: IModelDb, maxPasses?: number, topElement: string } | Specifies the iModel and top element. |
Returns - void
Defined in
- backend/src/ElementTreeWalker.ts Line 517
Last Updated: 05 May, 2026