@i2analyze/notebook-sdk 1.8.0-dev.2 → 1.8.0-dev.21

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,12 +697,74 @@ 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.
      * @i2since 1.8
      */
     export interface INodeGroupEditor {
+        /**
+         * Sets or resets the label of the node group.
+         *
+         * @param label - The label to set, or `undefined` to indicate there is no label.
+         * @returns The node group, with its label set to the specified value.
+         * @i2since 1.8
+         */
+        setLabel(label: string | undefined): this;
+        /**
+         * Sets or resets the color of the node group.
+         *
+         * @param color - The color to set, or `null` to remove the border, or `undefined` to reset the border color to the theme default.
+         * @returns The node group, with its border 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, or `null` or `undefined`.
+         * @i2since 1.8
+         */
+        setBorderColor(color: string | undefined | null): this;
+        /**
+         * Sets or resets the border width of the node group.
+         *
+         * @param width - The width to set, or `undefined` to reset the width to the theme default.
+         * @returns The node group, with its border width set to the specified value.
+         * @throws `Error` if the specified value is not either a positive number or `undefined`.
+         * @remarks A size of 0 is valid, and indicates that the node group has no border - equivalent to `setBorderColor(null)`.
+         * @i2since 1.8
+         */
+        setBorderWidth(width: number | undefined): this;
+        /**
+         * Sets or resets the background color of the node group.
+         *
+         * @param color - The color to set, or `null` to remove the background, or `undefined` to reset the background color to the theme default.
+         * @returns The node group, with its background 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, or `null` or `undefined`.
+         * @i2since 1.8
+         */
+        setColor(color: string | undefined | null): this;
+        /**
+         * Sets or resets the image for the node group.
+         *
+         * @param href - The URL of the image to use, or 'undefined' to indicate there is no image.
+         * @param description - A description of the image.
+         * @returns The node group, with its image set to the specified URL and description.
+         * @remarks If an image is not set, then a default image will be used when a label is also set.
+         * @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.
@@ -2413,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
@@ -2436,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.
@@ -2502,7 +2606,7 @@ export declare namespace commands {
          */
         readonly addToMap: CommandId;
         /**
-         * Gets the identifier of the system command opens the chart settings dialog.
+         * Gets the identifier of the system command that opens the chart settings dialog.
          * @i2since 1.5
          */
         readonly chartSettings: CommandId;
@@ -2521,6 +2625,21 @@ export declare namespace commands {
          * @i2since 1.0
          */
         readonly deleteSelected: CommandId;
+        /**
+         * Gets the identifier of the system command that allows users to download records in Excel format.
+         * @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
@@ -2536,6 +2655,11 @@ export declare namespace commands {
          * @i2since 1.0
          */
         readonly getPaths: CommandId;
+        /**
+         * Gets the identifier of the system command that adds selected nodes to a group.
+         * @i2since 1.8
+         */
+        readonly groupNodes: CommandId;
         /**
          * Gets the identifier of the system command that performs a grouped layout.
          * @i2since 1.0
@@ -2551,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
@@ -2571,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
@@ -2591,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
@@ -2621,6 +2789,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
@@ -2657,10 +2830,15 @@ export declare namespace commands {
          */
         readonly undo: CommandId;
         /**
-         * Gets the identifier of the system command that allows users to download records in Excel format.
-         * @i2since 1.6
+         * Gets the identifier of the system command that removes selected nodes from their group.
+         * @i2since 1.8
          */
-        readonly downloadRecords: CommandId;
+        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.
@@ -2670,8 +2848,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
@@ -2687,9 +2871,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;
         /**
@@ -2698,6 +2888,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
@@ -2713,6 +2961,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
@@ -3230,6 +3483,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.
@@ -5100,7 +5361,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
@@ -5601,7 +5862,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
@@ -5618,6 +5884,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.
@@ -5681,12 +5952,57 @@ export declare namespace visual {
          * @i2since 1.8
          */
         readonly id: ElementId;
+        /**
+         * Gets the label of the node group, or undefined if there is no explicit label.
+         * @i2since 1.8
+         */
+        readonly label: string | undefined;
+        /**
+         * Gets the style of the node group.
+         * @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
          */
         readonly nodes: data.IKeyedReadOnlyCollection<ElementId, INode>;
     }
+    /**
+     * A style for a node group, which affects its appearance.
+     * @i2since 1.8
+     */
+    export interface INodeGroupStyle {
+        /**
+         * Gets the image to display for the node group.
+         * @i2since 1.8
+         */
+        readonly image: IImageSetting;
+        /**
+         * Gets the color of the node group, or null if there is no background.
+         * @i2since 1.8
+         */
+        readonly color: IElementSetting<string | null>;
+        /**
+         * Gets the border color of the node group, or null if there is no border.
+         * @i2since 1.8
+         */
+        readonly borderColor: IElementSetting<string | null>;
+        /**
+         * Gets the border width of the node group.
+         * @i2since 1.8
+         */
+        readonly borderWidth: IElementSetting<number>;
+    }
 }
 
 export { }

package/package.json

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