There's quite a bit to explore. The sections to the left and the helpful articles at the bottom of this page can help guide your iTwin.js application development.
In addition, iTwin.js is open source. We love suggestions and feedback on the library, but we love contributions to our codebase even more. If you think you have something to offer, submit a pull request and let's get it merged.
- 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
This website is organized into sections by tabs at the top of each page.
- 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.
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: 30 August, 2023