Getting Started With iModel.js

Required Tools

Writing an iModel.js application requires the following software:

  • Node.js (latest 10.x LTS version)
    • This provides the backend JavaScript runtime.
    • The installation also includes the npm command line tool.
  • Google Chrome
    • This is the preferred tool for developing and debugging frontend JavaScript.
  • Git
    • This is the source code control system for the iModel.js repositories.

Code Samples

Note: Samples must be registered, and require a sample Project/iModel. See Developer Registration

The following samples showcase the iModel.js API in action:

  • Simple Viewer App
    • Embed an iModel.js viewport into your application to display graphical data.
    • Browse iModel catalog and view element properties.
  • iModel Query Agent
    • Listen to changes made to an iModel on the iModelHub.
    • Construct a 'Change Summary' of useful information.

Developer Registration

Register a New Application

Update an Existing Application

Create Sample Project and iModel

Suggested Tools

The following tools are very helpful and highly suggested for working with iModel.js:

  • Visual Studio Code
    • This is the recommended editor and debugger for iModel.js applications.
    • VS Code also supplies a graphical user interface for working with Git.
    • The following VS Code extensions can also be quite helpful:
  • TypeScript
    • iModel.js applications are written in TypeScript and then compiled to plain JavaScript.
  • Node Package Manager (npm)
    • npm is used to install and manage dependencies of an iModel.js application.
    • The npm command line and npm scripts are used to build and test iModel.js applications.


Please see the Community Resources page for the best places to get more help.

Last Updated: 19 February, 2019