This website is organized into sections by tabs at the top of each page.
- Please read the Getting Started page to install prerequisites for developers and for suggestions for background reading.
- The BIS tab explains the Base Infrastructure Schemas. Understanding BIS is essential to making sense of the iModel.js apis. Depending on your familiarity with database design, this is often the best starting point for understanding iModels and iModel.js.
- The Learning tab (this page) introduces the building blocks of iModel.js and provides step-by-step instructions for creating applications.
- The API Reference tab explains the API in more detail with package/class/function level documentation.
- Agents and Services that process iModels and respond to events from iModelHub
- Web Apps that run in web browsers and communicate with backends
- Desktop Apps that run on personal computers
- Mobile Apps that run on tablets and phones
iModel.js vs. iModelHub
It is important to understand that iModel.js applications do not run on iModelHub. Instead, they can run anywhere else. iModel.js applications always work on a copy of an iModel in a briefcase, obtained from iModelHub, and process it locally, making them infinitely scalable.
iModel.js applications can be:
- hosted on any cloud service
- deployed using any cloud deployment model
- packaged with any container tool (e.g. Docker)
- managed with any orchestration system (e.g. Kubernetes)
- installed on desktops and mobile devices
- Snapshot iModels
- App frontend development
- App backend development
- Classes packages by both frontends and backends
- GeoLocation in IModels
- Change Summaries
- Remote Procedure Call (RPC) Interfaces
Step by step instructions to:
- Write a Web service
- Write a Web agent
- Write an interactive app
- Write a bridge