insert MethodStatic
insert(txn, documentListModelId, name, scaleFactor?) @beta
Insert a Drawing element and a DrawingModel that breaks it down.
insert(txn: EditTxn, documentListModelId: string, name: string, scaleFactor?: number): string
@returns The Id of the newly inserted Drawing element and the DrawingModel that breaks it down (same value).
@throws IModelError if unable to insert the element.
@throws Error if scaleFactor is less than or equal to zero.
| Parameter | Type | Description |
|---|---|---|
| txn | EditTxn | |
| documentListModelId | string | Insert the new Drawing into this DocumentListModel |
| name | string | The name of the Drawing. |
| scaleFactor | number | See scaleFactor. Must be greater than zero. |
Returns - string
The Id of the newly inserted Drawing element and the DrawingModel that breaks it down (same value).
insert(iModelDb, documentListModelId, name, scaleFactor?)
Deprecated in 5.1.9 - will not be removed until after 2026-08-04. Use Drawing.insert(txn, ...) instead.
insert(iModelDb: IModelDb, documentListModelId: string, name: string, scaleFactor?: number): string
| Parameter | Type | Description |
|---|---|---|
| iModelDb | IModelDb | |
| documentListModelId | string | |
| name | string | |
| scaleFactor | number |
Returns - string
Defined in
- backend/src/Element.ts Line 1375
Last Updated: 07 May, 2026
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.