@i2analyze/notebook-sdk 1.8.0-dev.9 → 1.9.0-dev.0

package/README.md

@@ -8,6 +8,7 @@ This npm package provides the JavaScript library for developing plug-ins and a t
 
 | `@i2analyze/notebook-sdk` version | i2 Analyze version |
 | --------------------------------- | ------------------ |
+| 1.8.\*                            | 4.4.6.\* and later |
 | 1.7.\*                            | 4.4.5.\* and later |
 | 1.6.\*                            | 4.4.4.5 and later  |
 | 1.5.\*                            | 4.4.4.0 to 4.4.4.4 |

package/lib/gen/notebook-sdk-public.d.ts

@@ -364,12 +364,12 @@ export declare namespace app {
      * A common specifier for a note, for use in mutation APIs.
      * @i2since 1.1
      */
-    export type NoteSpecifier = records.NoteId | records.INote;
+    export type NoteSpecifier = data.NoteId | data.INote;
     /**
      * A common specifier for a source reference, for use in mutation APIs.
      * @i2since 1.1
      */
-    export type SourceReferenceSpecifier = records.SourceReferenceId | records.ISourceReference;
+    export type SourceReferenceSpecifier = data.SourceReferenceId | data.ISourceReference;
     /**
      * A common specifier for a node, for use in mutation APIs.
      * @i2since 1.2
@@ -408,44 +408,62 @@ export declare namespace app {
     export type SelectionOption = 'addRecordsToSelection' | 'setSelectionToRecords' | 'setSelectionToNewRecords';
     /**
      * A common specifier for the properties of new records, for use in mutation APIs.
-     * @i2since 1.1
+     * @i2since 1.9
      */
-    export type RecordPropertiesSpecifier = Record<schema.ChartPropertyTypeId, data.PropertyValue> | Iterable<[schema.PropertyTypeSpecifier, data.PropertyValue]>;
+    export type PropertiesSpecifier = Record<schema.PropertyTypeIdentifier, data.PropertyValue> | Iterable<[schema.PropertyTypeSpecifier, data.PropertyValue]>;
     /**
-     * A common specifier for record properties that are to be edited, for use in mutation APIs.
+     * A common specifier for the properties of new records, for use in mutation APIs.
+     * @deprecated Use {@link app.PropertiesSpecifier | PropertiesSpecifier} instead.
      * @i2since 1.1
      */
-    export type EditRecordPropertiesSpecifier = Record<schema.ChartPropertyTypeId, data.PropertyValue | null> | Iterable<[schema.PropertyTypeSpecifier, data.PropertyValue | null]>;
+    export type RecordPropertiesSpecifier = PropertiesSpecifier;
     /**
-     * A set of data that is common to creating records of all types.
+     * A common specifier for properties that are to be edited, for use in mutation APIs.
+     * @i2since 1.9
+     */
+    export type EditPropertiesSpecifier = Record<schema.PropertyTypeIdentifier, data.PropertyValue | null> | Iterable<[schema.PropertyTypeSpecifier, data.PropertyValue | null]>;
+    /**
+     * A common specifier for records properties that are to be edited, for use in mutation APIs.
+     * @deprecated Use {@link app.EditPropertiesSpecifier | EditPropertiesSpecifier} instead.
      * @i2since 1.1
      */
-    export interface IChartRecordBaseData {
-        /**
-         * Gets or sets the item type of the new record.
-         * @i2since 1.1
-         */
-        itemType: schema.ChartItemTypeId | schema.IChartItemType;
+    export type EditRecordPropertiesSpecifier = EditPropertiesSpecifier;
+    /**
+     * A set of common chart data that for creating records.
+     * @i2since 1.9
+     */
+    export interface IChartBaseData {
         /**
          * Gets or sets the properties of the new record.
          * @i2since 1.1
          */
-        properties?: RecordPropertiesSpecifier;
+        properties?: PropertiesSpecifier;
         /**
          * Gets or sets the security settings of the new record.
          * @i2since 1.1
          */
-        security?: readonly records.ISecuritySetting[] | data.IKeyedReadOnlyCollection<schema.SecurityDimensionId, records.ISecuritySetting>;
+        security?: readonly data.ISecuritySetting[] | data.IKeyedReadOnlyCollection<schema.SecurityDimensionId, data.ISecuritySetting>;
         /**
          * Gets or sets the notes for the new record.
          * @i2since 1.1
          */
-        notes?: readonly records.INoteData[];
+        notes?: readonly data.INoteData[];
         /**
          * Gets or sets the source references of the new record.
          * @i2since 1.1
          */
         sourceReferences?: readonly records.ISourceReferenceData[];
+    }
+    /**
+     * A set of data that is common to creating records of all types.
+     * @i2since 1.1
+     */
+    export interface IChartRecordBaseData extends IChartBaseData {
+        /**
+         * Gets or sets the item type of the new record.
+         * @i2since 1.1
+         */
+        itemType: schema.ChartItemTypeId | schema.IChartItemType;
         /**
          * Gets or sets the source identifiers of the new record.
          * @i2since 1.1
@@ -531,10 +549,10 @@ export declare namespace app {
         setLabel(label: string | undefined): this;
     }
     /**
-     * A set of methods for modifying the contents of a record.
-     * @i2since 1.1
+     * A set of methods for modifying common record data.
+     *  @i2since 1.9
      */
-    export interface IRecordEditor {
+    export interface IEditorBase {
         /**
          * Sets or clears the values of properties on the record.
          *
@@ -542,7 +560,7 @@ export declare namespace app {
          * @returns This record, with the edited properties in place.
          * @i2since 1.1
          */
-        setProperties(properties: EditRecordPropertiesSpecifier): this;
+        setProperties(properties: EditPropertiesSpecifier): this;
         /**
          * Adds a new note to the record.
          *
@@ -550,7 +568,7 @@ export declare namespace app {
          * @returns This record, with the new note in place.
          * @i2since 1.1
          */
-        addNote(noteData: records.INoteData): this;
+        addNote(noteData: data.INoteData): this;
         /**
          * Replaces an existing note on the record with a new one.
          *
@@ -559,7 +577,7 @@ export declare namespace app {
          * @returns This record, with the new note in place.
          * @i2since 1.1
          */
-        replaceNote(note: NoteSpecifier, noteData: records.INoteData): this;
+        replaceNote(note: NoteSpecifier, noteData: data.INoteData): this;
         /**
          * Removes a note from the record.
          *
@@ -575,7 +593,7 @@ export declare namespace app {
          * @returns This record, with the new source reference in place.
          * @i2since 1.1
          */
-        addSourceReference(refData: records.ISourceReferenceData): this;
+        addSourceReference(refData: data.ISourceReferenceData): this;
         /**
          * Replaces an existing source reference on the record with a new one.
          *
@@ -584,7 +602,7 @@ export declare namespace app {
          * @returns This record, with the new source reference in place.
          * @i2since 1.1
          */
-        replaceSourceReference(ref: SourceReferenceSpecifier, refData: records.ISourceReferenceData): this;
+        replaceSourceReference(ref: SourceReferenceSpecifier, refData: data.ISourceReferenceData): this;
         /**
          * Removes a source reference from the record.
          *
@@ -594,21 +612,27 @@ export declare namespace app {
          */
         removeSourceReference(ref: SourceReferenceSpecifier): this;
         /**
-         * Adds a new source identifier to the record.
+         * Replaces the record's security settings with a new set.
          *
-         * @param identifierData - The data for the new source identifier.
-         * @returns This record, with the new source identifier in place.
+         * @param security - The new security settings.
+         * @returns This record, with the new security settings in place.
          * @i2since 1.1
          */
-        addSourceIdentifier(identifierData: records.ISourceIdentifierData): this;
+        replaceSecurity(security: readonly data.ISecuritySetting[] | data.IKeyedReadOnlyCollection<schema.SecurityDimensionId, records.ISecuritySetting>): this;
+    }
+    /**
+     * A set of methods for modifying the contents of a record.
+     * @i2since 1.1
+     */
+    export interface IRecordEditor extends IEditorBase {
         /**
-         * Replaces the record's security settings with a new set.
+         * Adds a new source identifier to the record.
          *
-         * @param security - The new security settings.
-         * @returns This record, with the new security settings in place.
+         * @param identifierData - The data for the new source identifier.
+         * @returns This record, with the new source identifier in place.
          * @i2since 1.1
          */
-        replaceSecurity(security: readonly records.ISecuritySetting[] | data.IKeyedReadOnlyCollection<schema.SecurityDimensionId, records.ISecuritySetting>): this;
+        addSourceIdentifier(identifierData: records.ISourceIdentifierData): this;
         /**
          * Sets the direction of a link record.
          *
@@ -697,6 +721,14 @@ export declare namespace app {
      * @i2since 1.2
      */
     export interface IEdgeEditor extends IElementEditorBase {
+        /**
+         * Sets or resets the width of the edge.
+         *
+         * @param width - The width to set, or undefined to reset the width to 1.
+         * @returns The edge, with its width set to the specified value.
+         * @i2since 1.8
+         */
+        setWidth(width: number | undefined): this;
     }
     /**
      * A set of methods for modifying the contents and position of a node group.
@@ -749,6 +781,14 @@ export declare namespace app {
          * @i2since 1.8
          */
         setImage(href: string | undefined, description?: string): this;
+        /**
+         * Sets whether the node group is minimized, so nodes within the group are hidden, or maximized where they are shown.
+         *
+         * @param isMinimized - `true` to minimize the group, `false` to maximize it.
+         * @returns The node group, with its minimized state set to the specified value.
+         * @i2since 1.8
+         */
+        setIsMinimized(isMinimized: boolean): this;
         /**
          * Adds nodes to the group.
          * @param nodes - The nodes to add to the group.
@@ -803,7 +843,7 @@ export declare namespace app {
          * @throws `Error` if the security dimension or dimension values in the data do not exist in the security schema.
          * @i2since 1.1
          */
-        createSecuritySetting(data: records.ISecuritySettingData): records.ISecuritySetting;
+        createSecuritySetting(data: data.ISecuritySettingData): data.ISecuritySetting;
         /**
          * Creates a decimal value from a number or a string.
          *
@@ -1126,7 +1166,7 @@ export declare namespace app {
          * @returns The type-editing object.
          * @i2since 1.6
          */
-        editItemType(itemType: schema.ItemTypeSpecifier): schema.IItemTypeEditor | schema.IPropertyTypesEditor;
+        editItemType(itemType: schema.ChartItemTypeSpecifier | schema.IPendingItemType): schema.IItemTypeEditor | schema.IPropertyTypesEditor;
     }
     /**
      * A collection of elements and records that together represent a selection on the chart surface.
@@ -1558,17 +1598,17 @@ export declare namespace chart {
          * Gets all the entity types in use on the chart.
          * @i2since 1.3
          */
-        readonly entityTypes: data.IKeyedReadOnlyCollection<schema.ChartItemTypeId, schema.IChartEntityType>;
+        readonly entityTypes: data.IKeyedReadOnlyCollection<schema.ChartItemTypeIdentifier, schema.IChartEntityType>;
         /**
          * Gets all the link types in use on the chart.
          * @i2since 1.3
          */
-        readonly linkTypes: data.IKeyedReadOnlyCollection<schema.ChartItemTypeId, schema.IChartLinkType>;
+        readonly linkTypes: data.IKeyedReadOnlyCollection<schema.ChartItemTypeIdentifier, schema.IChartLinkType>;
         /**
          * Gets all the entity types and link types in use on the chart.
          * @i2since 1.3
          */
-        readonly itemTypes: data.IKeyedReadOnlyCollection<schema.ChartItemTypeId, schema.IChartItemType>;
+        readonly itemTypes: data.IKeyedReadOnlyCollection<schema.ChartItemTypeIdentifier, schema.IChartItemType>;
         /**
          * Fetches property values from the server of the specified types for the specified records, if they have not previously been fetched.
          *
@@ -2468,13 +2508,31 @@ export declare namespace commands {
      * A common specifier for a tab in the application ribbon.
      * @i2since 1.7
      */
-    export type TabSpecifier = RibbonTabId | IRibbonTabActionArea | IHomeTabActionArea;
+    export type TabSpecifier = RibbonTabId | IRibbonTabActionArea | IHomeTabActionArea | ICollectTabActionArea | IAnalyzeTabActionArea | IDisseminateTabActionArea;
     /**
      * An area that represents the **Home** tab in the application ribbon, which contains system groups.
      * @i2since 1.6
      */
     export interface IHomeTabActionArea extends IActionArea<IHomeTabSystemGroups> {
     }
+    /**
+     * An area that represents the **Collect** tab in the application ribbon, which contains system groups.
+     * @i2since 1.8
+     */
+    export interface ICollectTabActionArea extends IActionArea<ICollectTabSystemGroups> {
+    }
+    /**
+     * An area that represents the **Analyze** tab in the application ribbon, which contains system groups.
+     * @i2since 1.8
+     */
+    export interface IAnalyzeTabActionArea extends IActionArea<IAnalyzeTabSystemGroups> {
+    }
+    /**
+     * An area that represents the **Disseminate** tab in the application ribbon, which contains system groups.
+     * @i2since 1.8
+     */
+    export interface IDisseminateTabActionArea extends IActionArea<IDisseminateTabSystemGroups> {
+    }
     /**
      * An area that represents a custom tab in the application ribbon.
      * @i2since 1.6
@@ -2491,6 +2549,21 @@ export declare namespace commands {
          * @i2since 1.0
          */
         readonly homeTab: IHomeTabActionArea;
+        /**
+         * Gets the area that represents the **Collect** tab in the application ribbon.
+         * @i2since 1.8
+         */
+        readonly collectTab: ICollectTabActionArea;
+        /**
+         * Gets the area that represents the **Analyze** tab in the application ribbon.
+         * @i2since 1.8
+         */
+        readonly analyzeTab: IAnalyzeTabActionArea;
+        /**
+         * Gets the area that represents the **Disseminate** tab in the application ribbon.
+         * @i2since 1.8
+         */
+        readonly disseminateTab: IDisseminateTabActionArea;
         /**
          * Adds a new tab to the application ribbon.
          * @param config - The information necessary for creating the tab.
@@ -2581,6 +2654,16 @@ export declare namespace commands {
          * @i2since 1.6
          */
         readonly downloadRecords: CommandId;
+        /**
+         * Gets the identifier of the system command that enables inline editing for the selected element's label.
+         * @i2since 1.8
+         */
+        readonly editElementLabel: CommandId;
+        /**
+         * Gets the identifier of the system command that enables inline editing for the selected group's label.
+         * @i2since 1.8
+         */
+        readonly editGroupLabel: CommandId;
         /**
          * Gets the identifier of the system command that performs a one-level expand operation on the current selection.
          * @i2since 1.1
@@ -2616,6 +2699,33 @@ export declare namespace commands {
          * @i2since 1.0
          */
         readonly layoutPeacock: CommandId;
+        /**
+         * Gets the identifier of the system command that performs a circular layout.
+         * @i2since 1.8
+         */
+        readonly layoutCircular: CommandId;
+        /**
+         * Gets the identifier of the system command that performs an organization layout.
+         * @i2since 1.8
+         */
+        readonly layoutOrganization: CommandId;
+        /**
+         * Gets the identifier of the system command that performs a minimize crossed links layout.
+         * @i2since 1.8
+         */
+        readonly layoutMinimizeCrossedLinks: CommandId;
+        /**
+         * Gets the identifier of the system command that maximizes selected groups in the chart.
+         *
+         * @i2since 1.8
+         */
+        readonly maximizeGroups: CommandId;
+        /**
+         * Gets the identifier of the system command that minimizes selected groups in the chart.
+         *
+         * @i2since 1.8
+         */
+        readonly minimizeGroups: CommandId;
         /**
          * Gets the identifier of the system command that opens the i2 Notebook importer.
          * @i2since 1.5
@@ -2636,6 +2746,16 @@ export declare namespace commands {
          * @i2since 1.0
          */
         readonly redo: CommandId;
+        /**
+         * Gets the identifier of the system command that resets the selected elements' labels to their default values.
+         * @i2since 1.8
+         */
+        readonly resetElementLabel: CommandId;
+        /**
+         * Gets the identifier of the system command that resets the selected groups' labels to their default values.
+         * @i2since 1.8
+         */
+        readonly resetGroupLabel: CommandId;
         /**
          * Gets the identifier of the system command that saves the current chart.
          * @i2since 1.1
@@ -2656,6 +2776,13 @@ export declare namespace commands {
          * @i2since 1.2
          */
         readonly selectInvert: CommandId;
+        /**
+         * Gets the identifier of the system command that selects united items.
+         *
+         * @remarks A united item is a entity or link that contains multiple records.
+         * @i2since 1.8
+         */
+        readonly selectUnitedItems: CommandId;
         /**
          * Gets the identifier of the system command that allows users to share records with each other.
          * @i2since 1.3
@@ -2686,6 +2813,11 @@ export declare namespace commands {
          * @i2since 1.3
          */
         readonly toggleLists: CommandId;
+        /**
+         * Gets the identifier of the system command that toggles the list most connected UI.
+         * @i2since 1.8
+         */
+        readonly toggleListMostConnected: CommandId;
         /**
          * Gets the identifier of the system command that toggles the map UI.
          * @i2since 1.1
@@ -2726,6 +2858,11 @@ export declare namespace commands {
          * @i2since 1.8
          */
         readonly ungroupNodes: CommandId;
+        /**
+         * Gets the identifier of the system command that toggles the Time Wheel UI.
+         * @i2since 1.8
+         */
+        readonly toggleTimeWheel: CommandId;
     }
     /**
      * A lookup table for the identifiers of the system action groups in the Home tab.
@@ -2735,8 +2872,14 @@ export declare namespace commands {
         /**
          * Gets the identifier of the system action group named "Arrange".
          * @i2since 1.0
+         * @deprecated The "arrange" property has been renamed to "layouts". Use {@link commands.IHomeTabSystemGroups.layouts} instead.
          */
         readonly arrange: GroupId;
+        /**
+         * Gets the identifier of the system action group named "Layouts".
+         * @i2since 1.8
+         */
+        readonly layouts: GroupId;
         /**
          * Gets the identifier of the system action group named "Manage".
          * @i2since 1.1
@@ -2752,9 +2895,15 @@ export declare namespace commands {
          * @i2since 1.0
          */
         readonly history: GroupId;
+        /**
+         * Gets the identifier of the system action group named "Groups".
+         * @i2since 1.8
+         */
+        readonly groups: GroupId;
         /**
          * Gets the identifier of the system action group named "Search Information Store".
          * @i2since 1.0
+         * @deprecated The Search Information Store group has moved to the Collect tab {@link commands.ICollectTabSystemGroups.searchInfoStore}.
          */
         readonly searchInfoStore: GroupId;
         /**
@@ -2763,6 +2912,64 @@ export declare namespace commands {
          */
         readonly select: GroupId;
     }
+    /**
+     * A lookup table for the identifiers of the system action groups in the Collect tab.
+     * @i2since 1.8
+     */
+    export interface ICollectTabSystemGroups {
+        /**
+         * Gets the identifier of the system action group named "Search Information Store".
+         * @i2since 1.8
+         */
+        readonly searchInfoStore: GroupId;
+        /**
+         * Gets the identifier of the system action group named "Groups".
+         * @i2since 1.8
+         */
+        readonly groups: GroupId;
+        /**
+         * Gets the identifier of the system action group named "Select".
+         * @i2since 1.8
+         */
+        readonly select: GroupId;
+    }
+    /**
+     * A lookup table for the identifiers of the system action groups in the Analyze tab.
+     * @i2since 1.8
+     */
+    export interface IAnalyzeTabSystemGroups {
+        /**
+         * Gets the identifier of the system action group named "Discover".
+         * @i2since 1.8
+         */
+        readonly discover: GroupId;
+        /**
+         * Gets the identifier of the system action group named "Layouts".
+         * @i2since 1.8
+         */
+        readonly layouts: GroupId;
+        /**
+         * Gets the identifier of the system action group named "Groups".
+         * @i2since 1.8
+         */
+        readonly groups: GroupId;
+        /**
+         * Gets the identifier of the system action group named "Select".
+         * @i2since 1.8
+         */
+        readonly select: GroupId;
+    }
+    /**
+     * A lookup table for the identifiers of the system action groups in the Disseminate tab.
+     * @i2since 1.8
+     */
+    export interface IDisseminateTabSystemGroups {
+        /**
+         * Gets the identifier of the system action group named "Export".
+         * @i2since 1.8
+         */
+        readonly export: GroupId;
+    }
     /**
      * A lookup table for the identifiers of the system action groups in the chart item pop-up menu.
      * @i2since 1.4
@@ -2778,6 +2985,11 @@ export declare namespace commands {
          * @i2since 1.0
          */
         readonly discover: GroupId;
+        /**
+         * Gets the identifier of the system action group related to element label operations.
+         * @i2since 1.8
+         */
+        readonly label: GroupId;
         /**
          * Gets the identifier of the system action group related to link direction.
          * @i2since 1.5
@@ -3295,6 +3507,14 @@ export declare namespace data {
          * @i2since 1.0
          */
         readonly size: number;
+        /**
+         * Executes firstOrDefault to see if the collection has any elements. If the collection has elements, returns false.
+         * Otherwise, returns true.
+         *
+         * @returns A boolean indicating whether the collection is empty.
+         * @i2since 1.8
+         */
+        isEmpty(): boolean;
     }
     /**
      * A non-modifiable collection of objects, with efficient lookup by key.
@@ -3478,76 +3698,280 @@ export declare namespace data {
          */
         readonly hasLabel: boolean;
     }
-}
-
-/**
- * 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.
- *
- * @public
- * @i2since 1.4
- */
-export declare namespace dialog {
-    /**
-     * A size for a dialog window.
-     * @i2since 1.4
-     */
-    export type DialogSize = 'small' | 'medium' | 'large';
-    /**
-     * An identifier of a dialog action.
-     * @i2since 1.4
-     */
-    export type DialogActionId = string;
     /**
-     * A set of information for creating or modifying a dialog action.
-     * @i2since 1.4
+     * A set of common chart data properties.
+     * @i2since 1.9
      */
-    export interface IDialogActionConfig {
+    export interface IBaseChartData {
         /**
-         * Indicates whether the action is enabled.
-         * @i2since 1.4
+         * Gets the property value for the specified property type.
+         *
+         * @param propertyType - The property type or property type identifier of the value to retrieve.
+         * @returns The property value or, if not present, `undefined`.
+         * @i2since 1.0
          */
-        readonly enabled?: boolean;
+        getProperty(propertyType: schema.PropertyTypeSpecifier): PropertyValue | IValueNotFetched | undefined;
         /**
-         * Gets the label for the action.
-         * @i2since 1.4
+         * Gets the notes of the record.
+         * @i2since 1.0
          */
-        readonly label?: string;
+        readonly notes: IKeyedReadOnlyCollection<NoteId, INote>;
+        /**
+         * Gets the source references of the record.
+         * @i2since 1.0
+         */
+        readonly sourceReferences: IKeyedReadOnlyCollection<SourceReferenceId, ISourceReference>;
+        /**
+         * Gets the security settings of the record.
+         * @i2since 1.0
+         */
+        readonly security: IKeyedReadOnlyCollection<schema.SecurityDimensionId, ISecuritySetting>;
     }
     /**
-     * An action for a dialog window.
-     * @i2since 1.4
+     * The identifier of a note.
+     * @i2since 1.0
      */
-    export interface IDialogAction extends IDialogActionConfig {
+    export type NoteId = string;
+    /**
+     * A set of data for creating a note.
+     * @i2since 1.1
+     */
+    export interface INoteData {
         /**
-         * Gets the identifier of the action.
-         * @i2since 1.4
+         * Gets the contents of the new note.
+         * @i2since 1.1
          */
-        readonly id: DialogActionId;
+        readonly contents: string;
     }
     /**
-     * A set of information for creating a dialog.
-     *
-     * @typeParam TInitialize - The type of the data that's used for populating the dialog when it's displayed.
-     * @i2since 1.4
+     * A note for a record.
+     * @i2since 1.0
      */
-    export interface IDialogConfig<TInitialize> {
+    export interface INote {
         /**
-         * Gets the title of the dialog, which appears as a heading in the user interface.
-         * @i2since 1.4
+         * Gets the identifier of the note.
+         * @i2since 1.0
          */
-        readonly name: string;
+        readonly id: NoteId;
         /**
-         * Gets the path to the content to host in the dialog, relative to the plug-in entry point.
-         *
-         * @remarks
-         * For example, if `path` is '`./`', then the server uses the folder that contains the entry point.
-         * @i2since 1.4
+         * Gets the creator of the note.
+         * @i2since 1.0
          */
-        readonly path: string;
+        readonly creator: IUser;
         /**
-         * Gets the size of the dialog.
-         * @i2since 1.4
+         * Gets information about when and by whom the note was first uploaded.
+         *
+         * @returns The user who first uploaded the note and when it happened, or `undefined` if the note has not been uploaded.
+         * @i2since 1.0
+         */
+        readonly firstUploaded: IUserAndDateAndTime | undefined;
+        /**
+         * Gets information about when and by whom the note was last uploaded.
+         *
+         * @returns The user who last uploaded the note and when it happened, or `undefined` if the note has not been uploaded.
+         * @i2since 1.0
+         */
+        readonly lastUploaded: IUserAndDateAndTime | undefined;
+        /**
+         * Gets the contents of the note.
+         *
+         * @remarks
+         * See {@link schema.INotesSchema} for constraints on the contents of notes.
+         * @i2since 1.0
+         */
+        readonly contents: string;
+    }
+    /**
+     * The identifier of a source reference.
+     * @i2since 1.0
+     */
+    export type SourceReferenceId = string;
+    /**
+     * A source reference for a record.
+     *
+     * @remarks
+     * A source reference contains information about a source from which data in the record was derived.
+     * @i2since 1.0
+     */
+    export interface ISourceReference {
+        /**
+         * Gets the identifier of the source reference.
+         * @i2since 1.0
+         */
+        readonly id: SourceReferenceId;
+        /**
+         * Indicates whether the source reference is read-only.
+         * @i2since 1.8
+         */
+        readonly isReadOnly: boolean;
+        /**
+         * Gets the name of the source that the source reference describes.
+         * @i2since 1.0
+         */
+        readonly name: string;
+        /**
+         * Gets the type of the source that the source reference describes.
+         * @i2since 1.0
+         */
+        readonly type?: string;
+        /**
+         * Gets the location of the source that the source reference describes.
+         * @i2since 1.0
+         */
+        readonly location?: string;
+        /**
+         * Indicates whether it makes sense to show `location` as a hyperlink.
+         *
+         * @remarks
+         * This property is `true` if `location` is a valid URL that a plug-in can make available to users,
+         * in the same way that the i2 Notebook Record Inspector presents source reference locations.
+         * @i2since 1.0
+         */
+        readonly locationIsUrl: boolean;
+        /**
+         * Gets the description of the source that the source reference describes.
+         * @i2since 1.0
+         */
+        readonly description?: string;
+        /**
+         * Gets the URL of an image of the source that the source reference describes.
+         * @i2since 1.0
+         */
+        readonly imageUrl?: string;
+    }
+    /**
+     * A set of data for creating a source reference.
+     * @i2since 1.1
+     */
+    export interface ISourceReferenceData {
+        /**
+         * Gets the name of the source that the new source reference describes.
+         * @i2since 1.1
+         */
+        readonly name: string;
+        /**
+         * Gets the type of the source that the new source reference describes.
+         * @i2since 1.1
+         */
+        readonly type?: string;
+        /**
+         * Gets the location of the source that the new source reference describes.
+         * @i2since 1.1
+         */
+        readonly location?: string;
+        /**
+         * Gets the description of the source that the new source reference describes.
+         * @i2since 1.1
+         */
+        readonly description?: string;
+        /**
+         * Gets the URL of an image of the source that the new source reference describes.
+         * @i2since 1.1
+         */
+        readonly imageUrl?: string;
+    }
+    /**
+     * A set of dimension values for a record, from a particular security dimension.
+     * @i2since 1.0
+     */
+    export interface ISecuritySetting {
+        /**
+         * Gets the security dimension that the dimension values come from.
+         * @i2since 1.0
+         */
+        readonly dimension: schema.ISecurityDimension;
+        /**
+         * Gets the security dimension values.
+         * @i2since 1.0
+         */
+        readonly values: IReadOnlyCollection<schema.ISecurityDimensionValue>;
+    }
+    /**
+     * A set of data for creating a security setting.
+     * @i2since 1.1
+     */
+    export interface ISecuritySettingData {
+        /**
+         * Gets or sets the security dimension for the new security setting.
+         * @i2since 1.1
+         */
+        dimension: schema.SecurityDimensionId | schema.ISecurityDimension;
+        /**
+         * Gets or sets the dimension values for the new security setting.
+         * @i2since 1.1
+         */
+        values: readonly (schema.SecurityDimensionValueId | schema.ISecurityDimensionValue)[];
+    }
+}
+
+/**
+ * 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.
+ *
+ * @public
+ * @i2since 1.4
+ */
+export declare namespace dialog {
+    /**
+     * A size for a dialog window.
+     * @i2since 1.4
+     */
+    export type DialogSize = 'small' | 'medium' | 'large';
+    /**
+     * An identifier of a dialog action.
+     * @i2since 1.4
+     */
+    export type DialogActionId = string;
+    /**
+     * A set of information for creating or modifying a dialog action.
+     * @i2since 1.4
+     */
+    export interface IDialogActionConfig {
+        /**
+         * Indicates whether the action is enabled.
+         * @i2since 1.4
+         */
+        readonly enabled?: boolean;
+        /**
+         * Gets the label for the action.
+         * @i2since 1.4
+         */
+        readonly label?: string;
+    }
+    /**
+     * An action for a dialog window.
+     * @i2since 1.4
+     */
+    export interface IDialogAction extends IDialogActionConfig {
+        /**
+         * Gets the identifier of the action.
+         * @i2since 1.4
+         */
+        readonly id: DialogActionId;
+    }
+    /**
+     * A set of information for creating a dialog.
+     *
+     * @typeParam TInitialize - The type of the data that's used for populating the dialog when it's displayed.
+     * @i2since 1.4
+     */
+    export interface IDialogConfig<TInitialize> {
+        /**
+         * Gets the title of the dialog, which appears as a heading in the user interface.
+         * @i2since 1.4
+         */
+        readonly name: string;
+        /**
+         * Gets the path to the content to host in the dialog, relative to the plug-in entry point.
+         *
+         * @remarks
+         * For example, if `path` is '`./`', then the server uses the folder that contains the entry point.
+         * @i2since 1.4
+         */
+        readonly path: string;
+        /**
+         * Gets the size of the dialog.
+         * @i2since 1.4
          */
         readonly size: DialogSize;
         /**
@@ -3888,7 +4312,7 @@ export declare interface NotebookStatic {
      * @public
      * @i2since 1.0
      */
-    getEntryPointApi(pluginId: string, apiVersion: '1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '1.5' | '1.6' | '1.7'): Promise<IEntryPointApi>;
+    getEntryPointApi(pluginId: string, apiVersion: '1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '1.5' | '1.6' | '1.7' | '1.8'): Promise<IEntryPointApi>;
 }
 
 /**
@@ -3918,7 +4342,7 @@ export declare namespace records {
      * A set of information and functionality that is common to all records in i2 Notebook.
      * @i2since 1.0
      */
-    export interface IChartRecordBase {
+    export interface IChartRecordBase extends data.IBaseChartData {
         /**
          * Gets the identifier of the record.
          * @i2since 1.0
@@ -3967,14 +4391,6 @@ export declare namespace records {
          * @i2since 1.0
          */
         getUnfetchedPropertyTypes(): data.IReadOnlyCollection<schema.IChartPropertyType>;
-        /**
-         * Gets the property value for the specified property type.
-         *
-         * @param propertyType - The property type or property type identifier of the value to retrieve.
-         * @returns The property value or, if not present, `undefined`.
-         * @i2since 1.0
-         */
-        getProperty(propertyType: schema.PropertyTypeSpecifier): data.PropertyValue | data.IValueNotFetched | undefined;
         /**
          * Tests whether the record is an entity record; functions as a TypeScript typeguard.
          *
@@ -3994,21 +4410,6 @@ export declare namespace records {
          * @i2since 1.0
          */
         readonly itemType: schema.IChartItemType;
-        /**
-         * Gets the notes of the record.
-         * @i2since 1.0
-         */
-        readonly notes: data.IKeyedReadOnlyCollection<NoteId, INote>;
-        /**
-         * Gets the source references of the record.
-         * @i2since 1.0
-         */
-        readonly sourceReferences: data.IKeyedReadOnlyCollection<SourceReferenceId, ISourceReference>;
-        /**
-         * Gets the security settings of the record.
-         * @i2since 1.0
-         */
-        readonly security: data.IKeyedReadOnlyCollection<schema.SecurityDimensionId, ISecuritySetting>;
         /**
          * Gets information about when and by whom the record was first uploaded.
          *
@@ -4102,178 +4503,54 @@ export declare namespace records {
     /**
      * The identifier of a note.
      * @i2since 1.0
+     * @deprecated Use {@link data.NoteId} instead.
      */
-    export type NoteId = string;
+    export type NoteId = data.NoteId;
     /**
      * A set of data for creating a note.
      * @i2since 1.1
+     * @deprecated Use {@link data.INoteData} instead.
      */
-    export interface INoteData {
-        /**
-         * Gets the contents of the new note.
-         * @i2since 1.1
-         */
-        readonly contents: string;
-    }
+    export type INoteData = data.INoteData;
     /**
      * A note for a record.
      * @i2since 1.0
+     * @deprecated Use {@link data.INote} instead.
      */
-    export interface INote {
-        /**
-         * Gets the identifier of the note.
-         * @i2since 1.0
-         */
-        readonly id: NoteId;
-        /**
-         * Gets the creator of the note.
-         * @i2since 1.0
-         */
-        readonly creator: data.IUser;
-        /**
-         * Gets information about when and by whom the note was first uploaded.
-         *
-         * @returns The user who first uploaded the note and when it happened, or `undefined` if the note has not been uploaded.
-         * @i2since 1.0
-         */
-        readonly firstUploaded: data.IUserAndDateAndTime | undefined;
-        /**
-         * Gets information about when and by whom the note was last uploaded.
-         *
-         * @returns The user who last uploaded the note and when it happened, or `undefined` if the note has not been uploaded.
-         * @i2since 1.0
-         */
-        readonly lastUploaded: data.IUserAndDateAndTime | undefined;
-        /**
-         * Gets the contents of the note.
-         *
-         * @remarks
-         * See {@link schema.INotesSchema} for constraints on the contents of notes.
-         * @i2since 1.0
-         */
-        readonly contents: string;
-    }
+    export type INote = data.INote;
     /**
      * The identifier of a source reference.
      * @i2since 1.0
+     * @deprecated Use {@link data.SourceReferenceId} instead.
      */
-    export type SourceReferenceId = string;
+    export type SourceReferenceId = data.SourceReferenceId;
     /**
      * A source reference for a record.
      *
      * @remarks
      * A source reference contains information about a source from which data in the record was derived.
      * @i2since 1.0
+     * @deprecated Use {@link data.ISourceReference} instead.
      */
-    export interface ISourceReference {
-        /**
-         * Gets the identifier of the source reference.
-         * @i2since 1.0
-         */
-        readonly id: SourceReferenceId;
-        /**
-         * Indicates whether the source reference is read-only.
-         * @i2since 1.8
-         */
-        readonly isReadOnly: boolean;
-        /**
-         * Gets the name of the source that the source reference describes.
-         * @i2since 1.0
-         */
-        readonly name: string;
-        /**
-         * Gets the type of the source that the source reference describes.
-         * @i2since 1.0
-         */
-        readonly type?: string;
-        /**
-         * Gets the location of the source that the source reference describes.
-         * @i2since 1.0
-         */
-        readonly location?: string;
-        /**
-         * Indicates whether it makes sense to show `location` as a hyperlink.
-         *
-         * @remarks
-         * This property is `true` if `location` is a valid URL that a plug-in can make available to users,
-         * in the same way that the i2 Notebook Record Inspector presents source reference locations.
-         * @i2since 1.0
-         */
-        readonly locationIsUrl: boolean;
-        /**
-         * Gets the description of the source that the source reference describes.
-         * @i2since 1.0
-         */
-        readonly description?: string;
-        /**
-         * Gets the URL of an image of the source that the source reference describes.
-         * @i2since 1.0
-         */
-        readonly imageUrl?: string;
-    }
+    export type ISourceReference = data.ISourceReference;
     /**
      * A set of data for creating a source reference.
      * @i2since 1.1
+     * @deprecated Use {@link data.ISourceReferenceData} instead.
      */
-    export interface ISourceReferenceData {
-        /**
-         * Gets the name of the source that the new source reference describes.
-         * @i2since 1.1
-         */
-        readonly name: string;
-        /**
-         * Gets the type of the source that the new source reference describes.
-         * @i2since 1.1
-         */
-        readonly type?: string;
-        /**
-         * Gets the location of the source that the new source reference describes.
-         * @i2since 1.1
-         */
-        readonly location?: string;
-        /**
-         * Gets the description of the source that the new source reference describes.
-         * @i2since 1.1
-         */
-        readonly description?: string;
-        /**
-         * Gets the URL of an image of the source that the new source reference describes.
-         * @i2since 1.1
-         */
-        readonly imageUrl?: string;
-    }
+    export type ISourceReferenceData = data.ISourceReferenceData;
     /**
      * A set of dimension values for a record, from a particular security dimension.
      * @i2since 1.0
+     * @deprecated Use {@link data.ISecuritySetting} instead.
      */
-    export interface ISecuritySetting {
-        /**
-         * Gets the security dimension that the dimension values come from.
-         * @i2since 1.0
-         */
-        readonly dimension: schema.ISecurityDimension;
-        /**
-         * Gets the security dimension values.
-         * @i2since 1.0
-         */
-        readonly values: data.IReadOnlyCollection<schema.ISecurityDimensionValue>;
-    }
+    export type ISecuritySetting = data.ISecuritySetting;
     /**
      * A set of data for creating a security setting.
      * @i2since 1.1
+     * @deprecated Use {@link data.ISecuritySettingData} instead.
      */
-    export interface ISecuritySettingData {
-        /**
-         * Gets or sets the security dimension for the new security setting.
-         * @i2since 1.1
-         */
-        dimension: schema.SecurityDimensionId | schema.ISecurityDimension;
-        /**
-         * Gets or sets the dimension values for the new security setting.
-         * @i2since 1.1
-         */
-        values: readonly (schema.SecurityDimensionValueId | schema.ISecurityDimensionValue)[];
-    }
+    export type ISecuritySettingData = data.ISecuritySettingData;
     /**
      * A source identifier for a record.
      *
@@ -4329,17 +4606,17 @@ export declare namespace schema {
          * Gets all the entity types in the chart schema.
          * @i2since 1.0
          */
-        readonly entityTypes: data.IKeyedReadOnlyCollection<ChartItemTypeId, IChartEntityType>;
+        readonly entityTypes: data.IKeyedReadOnlyCollection<ChartItemTypeIdentifier, IChartEntityType>;
         /**
          * Gets all the link types in the chart schema.
          * @i2since 1.0
          */
-        readonly linkTypes: data.IKeyedReadOnlyCollection<ChartItemTypeId, IChartLinkType>;
+        readonly linkTypes: data.IKeyedReadOnlyCollection<ChartItemTypeIdentifier, IChartLinkType>;
         /**
          * Gets all the item types (that is, entity types _and_ link types) in the chart schema.
          * @i2since 1.0
          */
-        readonly itemTypes: data.IKeyedReadOnlyCollection<ChartItemTypeId, IChartItemType>;
+        readonly itemTypes: data.IKeyedReadOnlyCollection<ChartItemTypeIdentifier, IChartItemType>;
         /**
          * Gets the item type in the chart schema that has the specified i2 Analyze type identifier.
          * @param analyzeItemTypeId - An i2 Analyze item type identifier.
@@ -4355,7 +4632,7 @@ export declare namespace schema {
          * @returns The requested source reference schema.
          * @i2since 1.0
          */
-        getSourceReferenceSchema(itemTypeOrId: IChartItemType | ChartItemTypeId): ISourceReferenceSchema;
+        getSourceReferenceSchema(itemTypeOrId: ChartItemTypeSpecifier): ISourceReferenceSchema;
         /**
          * Gets the schema for notes.
          * @i2since 1.0
@@ -4417,7 +4694,7 @@ export declare namespace schema {
          * Gets the security dimension values to apply to new records by default.
          * @i2since 1.1
          */
-        readonly defaultSecurity: data.IKeyedReadOnlyCollection<SecurityDimensionId, records.ISecuritySetting>;
+        readonly defaultSecurity: data.IKeyedReadOnlyCollection<SecurityDimensionId, data.ISecuritySetting>;
     }
     /**
      * An identifier of a security dimension.
@@ -4534,11 +4811,16 @@ export declare namespace schema {
      * @i2since 1.0
      */
     export type AnalyzeItemTypeId = string;
+    /**
+     * A common identifier for a chart item type.
+     * @i2since 1.9
+     */
+    export type ChartItemTypeIdentifier = ChartItemTypeId | AnalyzeItemTypeId;
     /**
      * A common specifier for a chart item type.
      * @i2since 1.3
      */
-    export type ChartItemTypeSpecifier = ChartItemTypeId | IChartItemType;
+    export type ChartItemTypeSpecifier = ChartItemTypeIdentifier | IChartItemType;
     /**
      * A set of information that is common to all item types in i2 Notebook.
      * @i2since 1.0
@@ -4587,7 +4869,7 @@ export declare namespace schema {
          * Gets all the property types of the item type.
          * @i2since 1.0
          */
-        readonly propertyTypes: data.IKeyedReadOnlyCollection<ChartPropertyTypeId, IChartPropertyType>;
+        readonly propertyTypes: data.IKeyedReadOnlyCollection<PropertyTypeIdentifier, IChartPropertyType>;
         /**
          * Gets the property type that has the specified i2 Analyze type identifier.
          * @param analyzePropertyTypeId - An i2 Analyze property type identifier.
@@ -4755,21 +5037,22 @@ export declare namespace schema {
          * @returns The new, pending property type.
          * @i2since 1.6
          */
-        addPropertyType(propertyTypeData: IPropertyTypeData, insertAfter?: IChartPropertyType | IPendingPropertyType | null): IPendingPropertyType;
+        addPropertyType(propertyTypeData: IPropertyTypeData, insertAfter?: PropertyTypeSpecifier | IPendingPropertyType | null): IPendingPropertyType;
         /**
          * Gets an object with methods for editing a custom property type.
          *
-         * @param propertyType - The custom property type to be edited.
+         * @param propertyTypeSpecifier - The custom property type to be edited.
          * @returns The type-editing object.
          * @i2since 1.6
          */
-        editPropertyType(propertyType: IChartPropertyType | IPendingPropertyType): IPropertyTypeEditor;
+        editPropertyType(propertyTypeSpecifier: AnalyzePropertyTypeId | IPendingPropertyType): IPropertyTypeEditor;
         /**
          * Gets an object with methods for editing a custom property type.
          *
          * @param typeId - The identifier of the property type to be edited.
          * @param logicalType - The logical type of the property type to be edited.
          * @returns The type-editing object.
+         * @deprecated Use {@link schema.IPropertyTypesEditor.(editPropertyType:1) | editPropertyType(propertyType)} instead.
          * @i2since 1.6
          */
         editPropertyType(typeId: AnalyzePropertyTypeId, logicalType: CustomLogicalType): IPropertyTypeEditor;
@@ -4818,7 +5101,7 @@ export declare namespace schema {
          * @returns This property type, in its new position.
          * @i2since 1.6
          */
-        moveAfter(propertyType: IChartPropertyType | IPendingPropertyType | null): this;
+        moveAfter(propertyType: PropertyTypeSpecifier | IPendingPropertyType | null): this;
         /**
          * Sets whether the property type forms part of the item type's label definition.
          *
@@ -4845,7 +5128,7 @@ export declare namespace schema {
      * A common specifier for an item type.
      * @i2since 1.6
      */
-    export type ItemTypeSpecifier = AnalyzeItemTypeId | IChartItemType | IPendingItemType;
+    export type ItemTypeSpecifier = ChartItemTypeIdentifier | IChartItemType | IPendingItemType;
     /**
      * An identifier of a property type in a chart schema.
      * @i2since 1.0
@@ -4856,11 +5139,16 @@ export declare namespace schema {
      * @i2since 1.0
      */
     export type AnalyzePropertyTypeId = string;
+    /**
+     * A common identifier for a chart property type.
+     * @i2since 1.9
+     */
+    export type PropertyTypeIdentifier = ChartPropertyTypeId | AnalyzePropertyTypeId;
     /**
      * A common specifier for a chart property type.
      * @i2since 1.1
      */
-    export type PropertyTypeSpecifier = ChartPropertyTypeId | IChartPropertyType;
+    export type PropertyTypeSpecifier = PropertyTypeIdentifier | IChartPropertyType;
     /**
      * A property type.
      * @i2since 1.0
@@ -5165,7 +5453,7 @@ export declare namespace toolview {
      * The size of the tool view.
      * @i2since 1.3
      */
-    export type ToolViewSize = 'small' | 'medium' | 'large';
+    export type ToolViewSize = 'small' | 'medium' | 'large' | 'x-large';
     /**
      * A set of information for creating a tool view.
      * @i2since 1.3
@@ -5688,6 +5976,11 @@ export declare namespace visual {
      * @i2since 1.2
      */
     export interface IEdgeStyle extends IElementStyleBase {
+        /**
+         * Gets the width of the edge.
+         * @i2since 1.8
+         */
+        readonly width: IElementSetting<number>;
     }
     /**
      * A rectangular area, such as the boundary of the chart view.
@@ -5761,6 +6054,15 @@ export declare namespace visual {
          * @i2since 1.8
          */
         readonly style: INodeGroupStyle;
+        /**
+         * Indicates the minimized state of the node group.
+         * @remarks
+         * A minimized node group is represented by a single node that contains the label and
+         * image of the group, and can be maximized to show the individual nodes in the group.
+         * @returns `true` if the node group is minimized; `false` if it is maximized.
+         * @i2since 1.8
+         */
+        readonly isMinimized: boolean;
         /**
          * Gets the nodes in the node group.
          * @i2since 1.8

package/lib/index.js

@@ -2,7 +2,7 @@
  * i2, i2 Group, the i2 Group logo, and i2group.com are trademarks of N.Harris Computer Corporation.
  * © N.Harris Computer Corporation (2022)
  */
-const apiVersion = '1.7';
+const apiVersion = '1.8';
 /**
  * Retrieves the plug-in entry point API.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@i2analyze/notebook-sdk",
-  "version": "1.8.0-dev.9",
+  "version": "1.9.0-dev.0",
   "description": "i2 Notebook SDK",
   "license": "MIT",
   "publishConfig": {