@i2analyze/notebook-sdk 1.8.0-dev.8 → 1.8.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

@@ -648,7 +648,16 @@ export declare namespace app {
      * A set of methods for modifying the appearance of a node.
      * @i2since 1.2
      */
-    export interface INodeEditor extends IElementEditorBase {
+    export interface INodeEditor extends Omit<IElementEditorBase, 'setColor'> {
+        /**
+         * Sets or resets the color of the element.
+         *
+         * @param color - The color to set, or `undefined` to reset the color to the theme default, or 'null' to remove the color.
+         * @returns The element, with its color set to the specified value.
+         * @throws `Error` if the specified value is not in a form that CSS supports, such as a hexadecimal number, an `rgb()` value, or a color name.
+         * @i2since 1.2
+         */
+        setColor(color: string | undefined | null): this;
         /**
          * Sets or resets the size of the node.
          *
@@ -688,6 +697,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.
@@ -740,6 +757,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.
@@ -2459,13 +2484,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
@@ -2482,6 +2525,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.
@@ -2572,6 +2630,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
@@ -2607,6 +2675,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
@@ -2627,6 +2722,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
@@ -2647,6 +2752,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
@@ -2726,8 +2838,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
@@ -2743,9 +2861,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;
         /**
@@ -2754,6 +2878,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
@@ -2769,6 +2951,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
@@ -3286,6 +3473,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.
@@ -3879,7 +4074,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>;
 }
 
 /**
@@ -5156,7 +5351,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
@@ -5657,7 +5852,12 @@ export declare namespace visual {
      * A style for a node, which affects its appearance.
      * @i2since 1.0
      */
-    export interface INodeStyle extends IElementStyleBase {
+    export interface INodeStyle extends Omit<IElementStyleBase, 'color'> {
+        /**
+         * Gets the color of the node, or null if there is no color and the node background is transparent.
+         * @i2since 1.2
+         */
+        readonly color: IElementSetting<string | null>;
         /**
          * Gets the image to display for the node.
          * @i2since 1.0
@@ -5674,6 +5874,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.
@@ -5747,6 +5952,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.8",
+  "version": "1.8.0",
   "description": "i2 Notebook SDK",
   "license": "MIT",
   "publishConfig": {