iTwin.js API Reference Documentation

This section gives detailed documentation on the packages and classes in iTwin.js. Each package is organized in to a series of topics that form a logical outline of its concepts.

Generally, it is not expected that the API Reference documentation will be read sequentially or entirely. Rather, it is consulted to explain details of the APIs. It elaborates on topics introduced in the Learning sections. Start there to get a better understanding of the big picture concepts upon which the API is based.

The iTwin.js packages contain some APIs which are intentionally excluded from the API Reference documentation. These APIs should be considered internal implementation details subject to change at any time.

The iTwin.js library is organized into the following separately downloadable npm packages under the @itwin scope:

iTwin.js Core Packages

• Frontend
  • core-frontend
  • frontend-devtools
  • webgl-compatibility
  • hypermodeling-frontend
  • core-markup
• Backend
  • core-backend
  • core-transformer
• core-common
• ecschema-metadata
• ecschema-editing
• core-i18n
• core-bentley
• core-geometry

iTwin.js UI Packages

• appui-abstract
• core-react
• components-react
• imodel-components-react
• appui-layout-react
• appui-react

iTwin.js Presentation Packages

• presentation-common
• presentation-backend
• presentation-frontend
• presentation-components

iTwin.js Domain Packages

• analytical-backend
• linear-referencing-backend
• linear-referencing-common
• physical-material-backend

Last Updated: 02 February, 2022