deleteElements Method

Deletes target element trees, using one native operation unless references between the trees require more. Requested roots in doNotUpdateElementIds are skipped. This does not prevent an element in that set from being deleted as part of another root's cascade. Elements that something outside the deleted trees still references are kept, along with their child elements and sub-models and the elements that contain them. A warning lists them.

deleteElements(elementIds: ReadonlySet<string>): Promise<void>

@throws ElementBulkDeleteError if a native operation fails for any root, for example because geometry outside the deleted trees uses a geometry part in them, or because of a reference in a domain schema. The transformer does not check those references first. Deletions from that and earlier native operations stay pending in the caller-owned transaction. Abandon the transaction before retrying.

Parameter Type Description
elementIds ReadonlySet<string>  

Returns - Promise

Defined in

Last Updated: 02 October, 2026