Home > @i2analyze/notebook-sdk > dialog > IDialogApi
dialog.IDialogApi interface
A collection of methods and properties that allow plug-in dialogs to interact with i2 Notebook.
Signature:
interface IDialogApi extends app.IApplication
Extends: app.IApplication
Introduced: version 1.4
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) |
| locale | readonly |
ILocale | Gets the locale in which the application is operating. (Inherited from IApplication) |
| 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) |
Methods
| Method | Description |
|---|---|
| addEventListener(type, listener, options) | Adds a listener for events that might affect the dialog. |
| close() | Closes the dialog without submitting it. |
| getInitialValue() | Gets the data for populating the dialog when it's displayed. |
| removeEventListener(type, listener) | Removes a listener for events that might affect the dialog. |
| runTrackedMutations(mutationHandler, responseHandler, options) | Queues a function that performs tracked mutations on the application contents at the next available opportunity, and can respond to the changes that the mutations cause. (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 at the next available opportunity, and can respond to the changes that the mutations cause. (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) |
| submitAndClose(value) | Submits and closes the dialog. |
| updateAction(id, config) | Updates the label or the enabled state of the specified dialog action. |