iModels

Types for working with iModels in both the frontend and backend.

Classes

Name Description  
BackendError  
EcefLocation The position and orientation of an iModel on the earth in ECEF (Earth Centered Earth Fixed) coordinates  
IModel Represents an iModel in JavaScript.  
IModelError The error type thrown by this module.  
IModelVersion Option to specify the version of the iModel to be acquired and used  
ServerError  
ServerTimeoutError  

Enumerations

Name Description  
GeoCoordStatus  

Global Functions

Name Description  
mapToGeoServiceStatus Maps a GeoCoordStatus to the equivalent GeoServiceStatus.  

Interfaces

Name Description  
CreateIModelProps The properties that can be supplied when creating a new iModel.  
CreateSnapshotIModelProps Options that can be supplied when creating snapshot iModels.  
EcefLocationProps Properties that position an iModel on the earth via ECEF (Earth Centered Earth Fixed) coordinates  
FilePropertyProps  
GeoCoordinatesRequestProps Information required to request conversion of an array of iModel coordinates to Geographic Coordinates (longitude and latitude) Beta
GeoCoordinatesResponseProps Information returned from a request to convert an array of iModel coordinates to Geographic Coordinates (longitude and latitude) Beta
IModelCoordinatesRequestProps Information required to request conversion of an array of Geographic coordinates (Longitude/Latitude) to iModel coordinates Beta
IModelCoordinatesResponseProps Beta
IModelEncryptionProps Encryption-related properties that can be supplied when creating or opening snapshot iModels.  
IModelProps Properties that are about an iModel.  
IModelRpcProps The properties that identify a specific instance of an iModel for RPC operations.  
PointWithStatus Information returned from a request to convert an array of Geographic coordinates (Longitude/Latitude) to iModel coordinates Beta
RootSubjectProps Properties of the Root Subject.  

Type Aliases

Name Description  
CreateEmptySnapshotIModelProps The options that can be specified when creating an empty snapshot iModel.  

Last Updated: 08 June, 2020