Home > @i2analyze/notebook-sdk

notebook-sdk package

The i2 Notebook Web SDK package, which contains all the functionality you need to create plug-ins for the i2 Notebook web client.

Functions

Function	Description
getDialogApi()	Retrieves the plug-in dialog API.
getEntryPointApi(pluginId)	Retrieves the plug-in entry point API.
getToolViewApi()	Retrieves the plug-in tool view API.

Interfaces

Interface	Description
IEntryPointApi	The core API that the i2 Notebook application makes available to plug-in entry points.
ILogger	A diagnostic logger that i2 Notebook plug-ins can use.
NotebookStatic	A global notebook object that plug-in code can use to access the entry point API.

Namespaces

Namespace	Description
app	The members of the app namespace enable handling for events that take place during the lifetime of the i2 Notebook application, and provide access to top-level data such as user and locale information.
chart	The members of the chart namespace provide access to the contents of charts in the i2 Notebook web client, and enable handling of the events that arise as a result of changes to those contents.
commands	The members of the commands namespace allow you to integrate the commands that you create in your plug-ins with the i2 Notebook user interface.
data	The members of the data namespace determine how property and metadata values are stored and represented.
dialog	The members of the dialog namespace enable you to create and display dialog windows from your plug-ins that are modal with respect to the whole i2 Notebook application.
records	The members of the records namespace provide access to the contents of records in the i2 Notebook web client.
schema	The members of the schema namespace provide access to the specifications that govern the structure of records in the i2 Notebook web client. Schemas determine what properties records can contain; place constraints on notes, source identifiers, and source references; and describe the security model that controls access to records.
toolview	The members of the toolview namespace enable you to integrate the tool views that you write for your plug-ins with the i2 Notebook application.
visual	The members of the visual namespace provide control over the visible representations of the records that i2 Notebook charts contain.

Type Aliases

Type Alias	Description
LogLevel	The logging level, or severity, of log messages.