BasicManipulationCommand Class @beta
Implementation for a EditCommand command that provides basic creation and modification operations.
Extends
Implements
Methods
| Name | Description | |
|---|---|---|
| constructor(iModel: IModelDb, _str: string): BasicManipulationCommand | ||
| addAllowedChannel(channelKey: string): Promise<void> | ||
| deleteElements(ids: string): Promise<IModelStatus> | ||
| insertGeometricElement(props: GeometricElementProps): Promise<string> | Create and insert a new geometric element. | |
| insertGeometryPart(props: GeometryPartProps): Promise<string> | Create and insert a new geometry part element. | |
| onStart(): Promise<string> | ||
| removeAllowedChannel(channelKey: string): Promise<void> | ||
| requestElementGeometry(elementId: string, filter?: FlatBufferGeometryFilter): Promise<undefined | ElementGeometryInfo> | Request geometry from an existing element. | |
| rotatePlacement(ids: string, matrixProps: Matrix3dProps, aboutCenter: boolean): Promise<IModelStatus> | ||
| transformPlacement(ids: string, transProps: TransformProps): Promise<IModelStatus> | ||
| updateEcefLocation(ecefLocation: EcefLocationProps): Promise<void> | Update the position of the iModel on the earth. | |
| updateGeometricElement(propsOrId: string | GeometricElementProps, data?: ElementGeometryBuilderParams): Promise<void> | Update an existing geometric element. | |
| updateProjectExtents(extents: Range3dProps): Promise<void> | Update the project extents for the iModel. |
Inherited methods
| Name | Inherited from | Description |
|---|---|---|
| abandonChanges(): Promise<void> Inherited | EditCommand | Abandon any pending changes on this command's EditTxn. |
| abandonEdits(): Promise<void> Inherited | EditCommand | Abandon any pending changes and end this command's EditTxn |
| beginEditing(): void Protected Inherited | EditCommand | Start this command's transaction if it has not already started. |
| endEdits(description?: string): Promise<void> Inherited | EditCommand | Save all pending edits and end this command's EditTxn |
| ping(): Promise<[propName: string]: any> Inherited | EditCommand | Identify the current EditCommand's name and version, optionally returning additional properties that describe its state. |
| requestFinish(): Promise<string> Inherited | EditCommand | Called when another EditCommand wishes to become the active EditCommand. |
| saveChanges(description?: string): Promise<void> Inherited | EditCommand | Save any pending changes on this command's EditTxn. |
Properties
| Name | Type | Description | |
|---|---|---|---|
| _str Protected | string | ||
| commandId Static | string | The unique string that identifies this EditCommand class. |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| appData Protected Inherited | [key: string]: any | undefined | EditCommand | Application-specific data included when this command commits its EditTxn. |
| ctor Accessor Inherited ReadOnly | EditCommand | EditCommand | |
| iModel Readonly Inherited | IModelDb | EditCommand | The iModel this EditCommand may modify. |
| isTxnActive Accessor Inherited ReadOnly | boolean | EditCommand | Returns true if this command's transaction is currently active. |
| txn Protected Readonly Inherited | EditTxn | EditCommand | The explicit editing transaction for this command. |
| version Static Inherited | string | EditCommand |
Defined in
Last Updated: 20 April, 2026
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.