Name |
Description |
|
abandonChanges(): void |
Abandon pending changes in this iModel. |
|
cancelSnap(sessionId: string): void |
Cancel a previously requested snap. |
|
clearCaches(): void |
Clear all in-memory caches held in this IModelDb. |
|
clearSqliteStatementCache(): void |
Empty the SqliteStatementCache for this iModel. |
Deprecated |
clearStatementCache(): void |
Empty the ECSqlStatementCache for this iModel. |
Deprecated |
close(): void |
Close this IModel, if it is currently open. |
|
computeProjectExtents(options?: ComputeProjectExtentsOptions): ComputedProjectExtents |
Compute an appropriate project extents for this iModel based on the ranges of all spatial elements. |
|
constructEntity<T extends Entity>(props: EntityProps): T extends Entity |
Construct an entity (Element or Model) from an iModel. |
|
containsClass(classFullName: string): boolean |
Query if this iModel contains the definition of the specified class. |
|
deleteFileProperty(prop: FilePropertyProps): DbResult |
delete a "file property" from this iModel |
|
embedFont(prop: FontProps): FontProps |
|
|
exportGraphics(exportProps: ExportGraphicsOptions): DbResult |
Export meshes suitable for graphics APIs from arbitrary geometry in elements in this IModelDb. |
|
exportPartGraphics(exportProps: ExportPartGraphicsOptions): DbResult |
Exports meshes suitable for graphics APIs from a specified GeometryPart |
|
getBriefcaseId(): BriefcaseId |
Get the briefcase Id of this iModel |
|
getGeoCoordinatesFromIModelCoordinates(requestContext: ClientRequestContext, props: string): Promise<GeoCoordinatesResponseProps> |
Get the GeoCoordinate (longitude, latitude, elevation) corresponding to each IModel Coordinate point in the input |
|
getGeometryContainment(requestContext: ClientRequestContext, props: GeometryContainmentRequestProps): Promise<GeometryContainmentResponseProps> |
Get the clip containment status for the supplied elements |
Beta |
getGuid(): GuidString |
Get the GUID of this iModel. |
|
getIModelCoordinatesFromGeoCoordinates(requestContext: ClientRequestContext, props: string): Promise<IModelCoordinatesResponseProps> |
Get the IModel coordinate corresponding to each GeoCoordinate point in the input |
|
getJsClass<T extends undefined>(classFullName: string): T extends undefined |
Get the JavaScript class that handles a given entity class. |
|
getMassProperties(requestContext: ClientRequestContext, props: MassPropertiesRequestProps): Promise<MassPropertiesResponseProps> |
Get the mass properties for the supplied elements |
Beta |
getMetaData(classFullName: string): EntityMetaData |
Get metadata for a class. |
|
importSchemas(requestContext: ClientRequestContext, schemaFileNames: string[]): Promise<void> |
Import an ECSchema. |
|
isBriefcaseDb(): this |
Type guard for instanceof BriefcaseDb |
|
isSnapshotDb(): this |
Type guard for instanceof SnapshotDb |
|
prepareStatement(sql: string): ECSqlStatement |
Prepare an ECSQL statement. |
|
query(ecsql: string, bindings?: any[] | object, limitRows?: number, quota?: QueryQuota, priority?: QueryPriority, abbreviateBlobs?: false | true): AsyncIterableIterator<any> |
Execute a query and stream its results |
|
queryEntityIds(params: EntityQueryParams): Id64Set |
Query for a set of entity ids, given an EntityQueryParams |
|
queryFilePropertyBlob(prop: FilePropertyProps): Uint8Array | undefined |
Query a "file property" from this iModel, as a blob. |
|
queryFilePropertyString(prop: FilePropertyProps): string | undefined |
Query a "file property" from this iModel, as a string. |
|
queryNextAvailableFileProperty(prop: FilePropertyProps): number |
Query for the next available major id for a "file property" from this iModel. |
|
queryRowCount(ecsql: string, bindings?: any[] | object): Promise<number> |
Compute number of rows that would be returned by the ECSQL. |
|
querySchemaVersion(schemaName: string): string | undefined |
Query for a schema of the specified name in this iModel. |
|
readFontJson(): string |
|
|
requestSnap(requestContext: ClientRequestContext, sessionId: string, props: SnapRequestProps): Promise<SnapResponseProps> |
|
|
restartQuery(token: string, ecsql: string, bindings?: any[] | object, limitRows?: number, quota?: QueryQuota, priority?: QueryPriority): AsyncIterableIterator<any> |
Execute a query and stream its results |
|
saveChanges(description?: string): void |
Commit pending changes to this iModel. |
|
saveFileProperty(prop: FilePropertyProps, strValue: string | undefined, blobVal?: Uint8Array): DbResult |
Save a "file property" to this iModel |
|
tryPrepareStatement(sql: string): ECSqlStatement | undefined |
Prepare an ECSQL statement. |
|
updateEcefLocation(ecef: EcefLocation): void |
Update the EcefLocation of this iModel. |
|
updateIModelProps(): void |
Update the IModelProps of this iModel in the database. |
|
updateProjectExtents(newExtents: AxisAlignedBox3d): void |
Update the project extents for this iModel. |
|
withPreparedStatement<T>(ecsql: string, callback: (stmt: ECSqlStatement) => T): T |
Use a prepared ECSQL statement. |
|
findByFilename(fileName: string): IModelDb | undefined Static |
Find an opened instance of any subclass of IModelDb, by filename |
|
findByKey(key: string): IModelDb Static |
Find an open IModelDb by its key. |
|
forEachMetaData(iModel: IModelDb, classFullName: string, wantSuper: boolean, func: PropertyCallback, includeCustom: boolean = true): void Static |
Invoke a callback on each property of the specified class, optionally including superclass properties. |
|
tryFindByKey(key: string): IModelDb | undefined Static |
Attempt to find an open IModelDb by key. |
|
validateSchemas(filePath: string, forReadWrite: boolean): SchemaState Static |
Determines if the schemas in the Db must or can be upgraded by comparing them with those included in the |
|