IModelConnection Class

A connection to a IModelDb hosted on the backend.

Extends

Extended by

Implements

Methods

Name Description
cartographicToSpatial(cartographic: Cartographic, result?: Point3d): Promise<Point3d> Convert a Cartographic to a point in this iModel's Spatial coordinates using the Geographic location services for this IModelConnection or ecefLocation.  
cartographicToSpatialFromGcs(cartographic: Cartographic, result?: Point3d): Promise<Point3d> Convert a Cartographic to a point in this iModel's Spatial coordinates using the Geographic location services for this IModelConnection.  
close(): Promise<void> Abstract Close this IModelConnection.  
findClassFor<T extends undefined>(className: string, defaultClass: T extends undefined | undefined): Promise<T extends undefined | undefined> Find the first registered base class of the given EntityState className.  
getGeometryContainment(requestProps: GeometryContainmentRequestProps): Promise<GeometryContainmentResponseProps> Request element clip containment status from the backend. Beta  
getMassProperties(requestProps: MassPropertiesRequestProps): Promise<MassPropertiesResponseProps> Request element mass properties from the backend. Beta  
getToolTipMessage(id: Id64String): Promise<string[]> Request a tooltip from the backend.  
isBlankConnection(): this Type guard for instanceof BlankConnection Beta  
isBriefcaseConnection(): this Type guard for instanceof BriefcaseConnection  
isRemoteBriefcaseConnection(): this Type guard for instanceof RemoteBriefcaseConnection  
isSnapshotConnection(): this Type guard for instanceof SnapshotConnection  
loadFontMap(): Promise<FontMap> Load the FontMap for this IModelConnection.  
query(ecsql: string, bindings?: any[] | object, limitRows?: number, quota?: QueryQuota, priority?: QueryPriority): AsyncIterableIterator<any> Execute a query and stream its results  
queryEntityIds(params: EntityQueryParams): Promise<Id64Set> Query for a set of element ids that satisfy the supplied query params  
queryRowCount(ecsql: string, bindings?: any[] | object): Promise<number> Compute number of rows that would be returned by the ECSQL.  
requestSnap(props: SnapRequestProps): Promise<SnapResponseProps> Request a snap from the backend.  
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): Promise<void> Commit pending changes to this iModel  
spatialToCartographic(spatial: XYAndZ, result?: Cartographic): Promise<Cartographic> Convert a point in this iModel's Spatial coordinates to a Cartographic using the Geographic location services for this IModelConnection or ecefLocation.  
spatialToCartographicFromGcs(spatial: XYAndZ, result?: Cartographic): Promise<Cartographic> Convert a point in this iModel's Spatial coordinates to a Cartographic using the Geographic location services for this IModelConnection.  
updateProjectExtents(newExtents: AxisAlignedBox3d): Promise<void> Update the project extents of this iModel.  

Inherited methods

Name Inherited from Description
cartographicToSpatialFromEcef(cartographic: Cartographic, result?: Point3d): Point3d IModel Convert a Cartographic to a point in this iModel's Spatial coordinates using its ecefLocation.
ecefToSpatial(ecef: XYAndZ, result?: Point3d): Point3d IModel Convert a point in ECEF coordinates to a point in this iModel's Spatial coordinates using its ecefLocation.
getEcefTransform(): Transform IModel Get the Transform from this iModel's Spatial coordinates to ECEF coordinates using its ecefLocation.
getRpcProps(): IModelRpcProps IModel Return a token that can be used to identify this iModel for RPC operations.
spatialToCartographicFromEcef(spatial: XYAndZ, result?: Cartographic): Cartographic IModel Convert a point in this iModel's Spatial coordinates to a Cartographic using its ecefLocation.
spatialToEcef(spatial: XYAndZ, result?: Point3d): Point3d IModel Convert a point in this iModel's Spatial coordinates to an ECEF point using its ecefLocation.
getDefaultSubCategoryId(categoryId: Id64String): Id64String Static IModel Get the default subCategoryId for the supplied categoryId

Properties

Name Type Description
codeSpecs BriefcaseConnection.CodeSpecs The CodeSpecs in this IModelConnection.  
connectionTimeout Static number The maximum time (in milliseconds) to wait before timing out the request to open a connection to a new iModel  
elements BriefcaseConnection.Elements The ElementStates in this IModelConnection.  
eventSource Accessor ReadOnly EventSource Supplies access to push events originating on the backend. Beta   
fontMap undefined | FontMap The font map for this IModelConnection.  
hilited HiliteSet The set of currently hilited elements for this IModelConnection. Beta   
isBlank Accessor ReadOnly boolean True if this is a Blank Connection. Beta   
isBriefcase Accessor ReadOnly boolean Returns true if this is a briefcase copy of an iModel that is synchronized with iModelHub.  
isClosed Accessor ReadOnly boolean Check if the IModelConnection is closed (i.e.  
isOpen Accessor ReadOnly boolean Check if the IModelConnection is open (i.e.  
isReadonly Accessor ReadOnly boolean Check the IModelConnection.openMode of this IModelConnection to see if it was opened read-only.  
isSnapshot Accessor ReadOnly boolean Returns true if this is a snapshot iModel.  
models BriefcaseConnection.Models The ModelStates in this IModelConnection.  
onClose Static BeEvent<(_imodel: IModelConnection) => void> Event called immediately before any IModelConnection is closed.  
onClose BeEvent<(_imodel: IModelConnection) => void> Event called immediately before this IModelConnection is closed.  
onOpen Static BeEvent<(_imodel: IModelConnection) => void> Event called immediately after any IModelConnection is opened.  
routingContext IModelRoutingContext.default The RPC routing for this connection.  
selectionSet SelectionSet The set of currently selected elements for this IModelConnection.  
tiles Tiles The set of Tiles for this IModelConnection. Beta   
transientIds TransientIdSequence Generator for unique Ids of transient graphics for this IModelConnection.  
views BriefcaseConnection.Views The ViewStates in this IModelConnection.  

Inherited properties

Name Type Inherited from Description
changeSetId Accessor ReadOnly string | undefined IModel The Id of the last changeset that was applied to this iModel.
contextId Accessor ReadOnly GuidString | undefined IModel The Guid that identifies the context that owns this iModel.
dictionaryId Static Id64String IModel The Id of the dictionary model.
ecefLocation Accessor ReadOnly EcefLocation | undefined IModel The EcefLocation of the iModel in Earth Centered Earth Fixed coordinates.
globalOrigin Accessor Point3d IModel An offset to be applied to all spatial coordinates.
iModelId Accessor ReadOnly GuidString | undefined IModel The Guid that identifies this iModel.
isGeoLocated Accessor ReadOnly boolean IModel True if this iModel has an EcefLocation.
name string IModel Name of the iModel
openMode OpenMode IModel The OpenMode used for this IModel.
projectExtents Accessor AxisAlignedBox3d IModel The volume, in spatial coordinates, inside which the entire project is contained.
repositoryModelId Static Id64String IModel The Id of the repository model.
rootSubject RootSubjectProps IModel The name and description of the root subject of this iModel
rootSubjectId Static Id64String IModel The Id of the root subject element.

Defined in

Last Updated: 05 November, 2020