Getting Started With iModel.js

1. Get the 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.

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:

2. Register Yourself

To be able to view/read iModel data, you will need access to the iModelHub, which requires a Bentley user account.

Register here

Note: Skip to step 3, if you already have a Bentley User Account.

3. Register your Application

Once you have a Bentley User account, you will need to register the application you are about to create so it can access iModelHub.

Register Here

There are two types of apps you can register:

Browser Application
Our sample is called "Simple Viewer App" which can:

  • Embed an iModel.js viewport into your application to display graphical data.
  • Browse iModel catalog and view element properties.

Agent Application
Our sample is called "iModel Query Agent" which can:

  • Listen to changes made to an iModel on the iModelHub.
  • Construct a 'Change Summary' of useful information.

4. Create a Sample Project

Once you have a registered application, you will need content to work with. To get you started, Bentley can supply some example content using our “iModel Testdrive” organization. From the registration page you can create a new project and give access to other developers.

Register Here

Note: The “iModel Testdrive” organization is intended for developer testing only. See this page for information about administering a CONNECT project in your own organization.

5. Get the Sample Code

The Github repositories for the applications described in step 3.

Simple Viewer App
iModel Query Agent





  • 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.

Support

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

Last Updated: 10 April, 2019