Home > @i2analyze/notebook-sdk > toolview > IToolViewApi
toolview.IToolViewApi interface
A collection of methods and properties that allow plug-in tool views to interact with i2 Notebook.
Signature:
interface IToolViewApi extends IToolView, app.IApplication, app.IApplicationContents
Extends: IToolView, app.IApplication, app.IApplicationContents
Introduced: version 1.0
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| allTimeZones |
readonly
| data.IKeyedReadOnlyCollection<data.TimeZoneId, data.ITimeZone> | Gets a list of all the valid time zones, in the same order as they appear in the application. (Inherited from IApplication) |
| brushSets |
readonly
| visual.IBrushSetsManager | Gets the brush sets manager for controlling chart brushing. (Inherited from IApplication) |
| chart |
readonly
| chart.IChart | Gets the currently open chart. (Inherited from IApplicationContents) |
| formatter |
readonly
| data.IFormatter | Gets an object that can be used to perform locale-sensitive string-formatting operations. |
| isMinimized |
readonly
| boolean | Indicates whether the tool view is open and docked but not visible in the user interface. (Inherited from IToolView) |
| isOpen |
readonly
| boolean | Indicates whether the tool view is open in the user interface. (Inherited from IToolView) |
| locale |
readonly
| ILocale | Gets the locale in which the application is operating. (Inherited from IApplication) |
| logger |
readonly
| ILogger | Gets an object that can be used to perform plug-in logging operations. |
| metadataTimeZone |
readonly
| data.ITimeZone | Gets the time zone that the application assumes date and time values in metadata to have. (Inherited from IApplication) |
| serverComponents |
readonly
| IServerComponents | Gets information about the i2 Analyze components that are deployed on the application server. (Inherited from IApplication) |
| systemActions |
readonly
| dialog.ISystemDialogActions | Gets the identifiers of the system dialog actions. (Inherited from IApplication) |
| theme |
readonly
| ITheme | Gets the current theme of the application. (Inherited from IApplication) |
| user |
readonly
| IUserAndPermissions | Gets the logged-in user of the application. (Inherited from IApplication) |
| valueFactory |
readonly
| IValueFactory | Gets a library of functions for creating objects to use in mutations. (Inherited from IApplication) |
| view |
readonly
| chart.IChartView | Gets the view of the currently open chart. (Inherited from IApplicationContents) |
| volatileStore |
readonly
| IVolatileStore | Gets the volatile store for the tool view. (Inherited from IToolView) |
Methods
| Method | Description |
|---|---|
| addEventListener(type, listener, options) | Adds a listener for events that might affect the tool view. |
| close() | Closes and unloads the tool view window. (Inherited from IToolView) |
| open(openState) | Opens the tool view in either a docked pane or an undocked window. (Inherited from IToolView) |
| removeEventListener(type, listener) | Removes a listener for events that might affect the tool view. |
| runTrackedMutations(mutationHandler, responseHandler, options) | Queues a function that performs tracked mutations on the application contents. (Inherited from IApplication) |
| runTrackedMutations(mutationHandler, options) | Queues a function that performs tracked mutations on the application contents at the next available opportunity. (Inherited from IApplication) |
| runTransaction(handler, options) | Queues a function that performs read-only work on the application contents at the next available opportunity. (Inherited from IApplication) |
| runUntrackedMutations(mutationHandler, responseHandler, options) | Queues a function that performs untracked mutations on the application contents. (Inherited from IApplication) |
| runUntrackedMutations(mutationHandler, options) | Queues a function that performs untracked mutations on the application contents at the next available opportunity. (Inherited from IApplication) |
| showDialog(config) | Creates and displays a modal dialog with the specified configuration. |