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 section explains the Base Infrastructure Schemas. Understanding BIS is essential to making sense of the iTwin.js APIs. Depending on your familiarity with database design, this is often the best starting point for understanding iModels and iTwin.js.
- The Learning tab (this page) introduces the building blocks of iTwin.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
iTwin.js vs. iModelHub
It is important to understand that iTwin.js applications do not run on iModelHub. Instead, they can run anywhere else. iTwin.js applications always work on a copy of an iModel, either a briefcase or checkpoint obtained from iModelHub, or a snapshot iModel created by an iTwin.js application, and process it locally. This makes them infinitely scalable.
iTwin.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
- App frontend development
- App backend development
- Classes packaged by both frontends and backends
- API support policies
- Display system
- Snapshot iModels
- 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 connector
Last Updated: 10 January, 2023