API Reference › core-backend› IModels

iModels

Classes for working with iModels. See the learning article.

Classes

Name Description  
BriefcaseDb A local copy of an iModel from iModelHub that can pull and potentially push changesets.  
BriefcaseManager Manages downloading Briefcases and downloading and uploading changesets.  
Category A Category element is the target of the category member of GeometricElement.  
ChangeSummaryManager Class to extract Change Summaries for a briefcase.  
DrawingCategory Categorizes 2d GeometricElements.  
EditTxn Represents an explicit editing transaction for an iModel.  
IModelDb An iModel database file.  
IModelElementCloneContext The context for transforming a source Element to a target Element and remapping internal identifiers to the target iModel.  
IModelIncrementalSchemaLocater A ECSqlSchemaLocaterecschema-metadata implementation that uses the IModelDb to load schemas incrementally.  
RebaseManager Manages the process of merging and rebasing local changes (transactions) in a BriefcaseDb.  
SnapshotDb A snapshot iModel database file that is used for archival and data transfer purposes.  
SpatialCategory Categorizes SpatialElements.  
StandaloneDb Standalone iModels are read/write files that are not associated with an iTwin or managed by iModelHub.  
SubCategory Defines the appearance for graphics in Geometric elements  
TxnManager Manages local changes to a BriefcaseDb via Txns  

Enumerations

Name Description  
BulkDeleteElementsStatus Status of a bulk element delete operation, mirroring the C++ BulkDeleteStatus enum.  
BulkDeleteFailureReason Why an element could not be deleted by deleteElements.  
DataTransformationStrategy Strategy for transforming data during schema import.  
ProgressStatus Return value from ProgressFunction.  

Global Functions

Name Description  
getAvailableCoordinateReferenceSystems Get a list of Geographic Coordinate Reference Systems.  
getAvailableCRSUnits Get a list of units used by horizontal and vertical coordinate reference systems in iTwin.js.  
getAvailableVerticalCoordinateReferenceSystems Get a list of Vertical Coordinate Reference Systems.  
withEditTxn Execute an async callback within an explicit editing transaction, supplying commit arguments.  

Interfaces

Name Description  
AvailableCoordinateReferenceSystemProps Describes a coordinate reference system produced by getAvailableCoordinateReferenceSystems.  
AvailableVerticalCoordinateReferenceSystemProps Describes a vertical coordinate reference system produced by getAvailableVerticalCoordinateReferenceSystems.  
BulkDeleteElementsArgs Options for bulk deleting elements from an iModelDb. Deprecated
BulkDeleteElementsResult Result of a bulk element delete operation.  
BulkDeleteFailure One element that could not be deleted by deleteElements, and why.  
CatalogDb A StandaloneDb that provides read-only access to the contents of a CatalogIModel.  
ChangeElementModelProps Options for changeElementModel.  
ChangeElementParentProps Options for changeElementParent.  
ChangeInstanceKey Represents a change (insertion, deletion, or modification) to a single EC instance made in a local BriefcaseDb.  
ChangeSummary Represents an instance of the ChangeSummary ECClass from the ECDbChange ECSchema  
CheckpointProps Properties of a checkpoint  
ClearCachesOptions Options supplied to clearCaches.  
CloseIModelArgs Options for closing an iModelDb.  
CloudContainerArgs Augments a SnapshotDbOpenArgs or OpenBriefcaseArgs with a CloudContainer.  
ComputedProjectExtents The result of computeProjectExtents.  
ComputeProjectExtentsOptions Options supplied to computeProjectExtents.  
CreateChangeSummaryArgs Options for ChangeSummaryManager.createChangeSummaries.  
DataTransformationResources Resources available for after schema import data transformation.  
EditableCatalogDb A writable CatalogDb.  
EmbedFontFileArgs Arguments supplied to embedFontFile.  
ExportSchemaArgs Arguments supplied to exportSchema specifying which ECSchema to write to what location on the local file system.  
GetAvailableCoordinateReferenceSystemsArgs Arguments supplied to getAvailableCoordinateReferenceSystems.  
GetAvailableVerticalCoordinateReferenceSystemsArgs Arguments supplied to getAvailableVerticalCoordinateReferenceSystems.  
IModelDbFonts Provides read-write access to the font-related information stored in an IModelDb.  
InlineGeometryPartsResult The output of inlineGeometryParts.  
InsertElementOptions Options supposed to IModelDb.Elements.insertElement.  
InstanceChange Represents an instance of the InstanceChange ECClass from the ECDbChange ECSchema  
IntegrityCheckOptions Options for performing integrity checks on an iModel.  
LockControl Interface for acquiring element locks to coordinate simultaneous edits from multiple briefcases.  
PostImportContext Context provided to the afterImport callback.  
PreImportCallbackResult Result of the pre-import callback.  
PreImportContext Context provided to the beforeImport callback.  
PushChangesArgs Parameters for pushing changesets to iModelHub  
QueryAspectOptions Options for streaming the aspects owned by a set of elements.  
QueryLocalChangesArgs Arguments supplied to queryLocalChanges.  
QueryMappedFamiliesArgs Arguments supplied to queryMappedFamilies.  
RebaseHandler Customizes how each local transaction is rebased during a pull/merge.  
RequestNewBriefcaseArg The argument for downloadBriefcase  
SchemaImportCallbacks Callbacks for schema import operations.  
SchemaImportOptions Options for the importing of schemas  
SimplifyElementGeometryArgs Arguments supplied to simplifyElementGeometry.  
ToChangesetArgs Specifies a specific index for pulling changes.  
TokenArg Argument to a function that can accept a valid access token.  
TxnChangedEntities Describes the entities that changed as part of a transaction by their Ids and ECClass Ids.  
TxnChangedEntitiesWithMetadata Describes a set of Elements or Models that changed as part of a transaction, including ECClass metadata for each changed entity.  
TxnChangedEntity Describes an entity changed by a transaction, including its ECClass metadata.  
UpdateModelOptions Options for IModelDb.Models.updateModel  
ValidationError An error generated during dependency validation.  

Namespaces

Name Description  
CatalogDb  
IModelDb  
SynchronousChannel Types used by the synchronous coordination channels that help multiple briefcases avoid conflicts  

Type Aliases

Name Description  
OpenBriefcaseArgs Arguments to open a BriefcaseDb  
ProgressFunction Called to show progress during a download.  
PullChangesArgs Arguments for pullAndApplyChangesets  
RevertChangesArgs Arguments for revertTimelineChanges  
SnapshotDbOpenArgs Options to open a SnapshotDb.  
TxnChangedEntityIterable An iterable collection of TxnChangedEntitys.  
TxnIdString A string that identifies a Txn.  
TxnMode The mode in which changes are recorded by the TxnManager.  

Last Updated: 05 November, 2026