Welcome to the i2 Notebook SDK

The i2 Notebook SDK enables you to write plug-ins that enhance and extend the functionality of the i2 Notebook web client. For example, you might use a plug-in to add a new command to the application ribbon, or to provide a new tool for analyzing or displaying data in a way that's integrated with the rest of the i2 Notebook user interface.

The i2 Notebook web client exposes a JavaScript API that i2 Notebook plug-ins can target with JavaScript or TypeScript code.

For a plug-in that has a visual representation, you can write user interface code in HTML/CSS, or by using a framework such as Angular, React, or Vue.

Note: During development, if you want to use a third-party framework or our plug-in proxy, Node.js is required. When development is complete, plug-ins do not require Node.js in order to run.

The table of contents on the left includes conceptual and tutorial documentation for the i2 Notebook SDK:

• The topics that follow this introduction describe the structure of plug-ins for the i2 Notebook web client, and introduce some features of the SDK.

• The Tutorials section contains worked examples of using the SDK to create i2 Notebook plug-ins.

You don't need to read the conceptual documentation before you follow the tutorials. The conceptual documentation provides more information about subjects that the tutorials mention in passing. You can return to those topics when you create plug-ins of your own.

For an overview of what i2 Notebook plug-ins can do, see the Capabilities overview. For a more detailed account, use the Notebook API tab at the top of the page to read the i2 Notebook API documentation.