@i2analyze/notebook-sdk 1.7.2-dev.0 → 1.8.0-dev.10

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

@@ -385,6 +385,11 @@ export declare namespace app {
      * @i2since 1.6
      */
     export type EdgeSummarySpecifier = visual.ElementId | visual.IEdgeSummary;
+    /**
+     * A common specifier for a node group, for use in mutation APIs.
+     * @i2since 1.8
+     */
+    export type NodeGroupSpecifier = visual.ElementId | visual.INodeGroup;
     /**
      * The identifier of a record group.
      * @i2since 1.1
@@ -643,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.
          *
@@ -683,17 +697,103 @@ 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;
+        /**
+         * Adds nodes to the group.
+         * @param nodes - The nodes to add to the group.
+         * @throws `Error` if any of the nodes are not on the chart.
+         * @returns The node group, with the specified nodes added.
+         * @i2since 1.8
+         */
+        addNodes(nodes: NodeSpecifier | Iterable<NodeSpecifier>): this;
+        /**
+         * Removes nodes from the group. If the group is empty after the mutation is committed, the group itself is removed.
+         * @param nodes - The nodes to remove from the group.
+         * @returns The node group, with the specified nodes removed.
+         * @i2since 1.8
+         */
+        removeNodes(nodes: NodeSpecifier | Iterable<NodeSpecifier>): this;
     }
     /**
-     * A record that has been created in a transaction handler, but has not yet been added to a chart.
+     * A record that has been created in a mutation handler, but has not yet been added to a chart.
      * @i2since 1.1
      */
     export interface IPendingRecord extends IRecordEditor {
         /**
-         * Gets or sets the identifier of the record.
+         * Gets the identifier of the record.
          * @i2since 1.1
          */
-        recordId: records.AnalyzeRecordId;
+        readonly recordId: records.AnalyzeRecordId;
+    }
+    /**
+     * A node group that has been created in a mutation handler, but has not yet been added to a chart.
+     * @i2since 1.8
+     */
+    export interface IPendingNodeGroup extends INodeGroupEditor {
+        /**
+         * Gets the identifier of the node group.
+         * @i2since 1.8
+         */
+        readonly id: visual.ElementId;
     }
     /**
      * A set of utility functions for creating property and other values that can be reused across records.
@@ -913,6 +1013,15 @@ export declare namespace app {
          * @i2since 1.1
          */
         addRecordGroup(recordGroupId: AnalyzeRecordGroupId, selectionOption: SelectionOption): void;
+        /**
+         * Creates a node group from the specified nodes.
+         *
+         * @param nodes - The nodes to add to the group.
+         * @throws `Error` if any of the nodes are not on the chart.
+         * @returns The node group, with the specified nodes added.
+         * @i2since 1.8
+         */
+        addNodeGroup(nodes: Iterable<NodeSpecifier>): IPendingNodeGroup;
         /**
          * Gets an object with methods for editing a record.
          *
@@ -937,6 +1046,14 @@ export declare namespace app {
          * @i2since 1.2
          */
         editEdge(edge: EdgeSpecifier): IEdgeEditor;
+        /**
+         * Gets an object with methods for editing a node group.
+         *
+         * @param nodeGroup - The node group to be edited.
+         * @returns The node-group-editing object.
+         * @i2since 1.8
+         */
+        editNodeGroup(nodeGroup: NodeGroupSpecifier): INodeGroupEditor;
         /**
          * Moves a node to a particular location on the chart.
          *
@@ -973,6 +1090,22 @@ export declare namespace app {
          * @i2since 1.1
          */
         removeElements(elements: ElementSpecifier | Iterable<ElementSpecifier>): boolean;
+        /**
+         * Removes node groups from the chart. Removing a node group does not remove the nodes that were part of it.
+         *
+         * @param nodeGroups - The node group or groups to be removed.
+         * @returns `true` if one or more node groups were successfully removed from the chart; `false` if none of the node groups existed.
+         * @i2since 1.8
+         */
+        removeNodeGroups(nodeGroups: NodeGroupSpecifier | Iterable<NodeGroupSpecifier>): boolean;
+        /**
+         * Removes nodes from their node group. If the group is empty after the mutation is committed, the group itself is removed.
+         *
+         * @param nodes - The node or nodes to be removed.
+         * @returns `true` if one or more nodes were successfully removed from the group; `false` if none of the nodes existed.
+         * @i2since 1.8
+         */
+        removeFromNodeGroup(nodes: NodeSpecifier | Iterable<NodeSpecifier>): boolean;
         /**
          * Removes the currently selected records from the chart.
          * @i2since 1.1
@@ -1404,6 +1537,11 @@ export declare namespace chart {
          * @i2since 1.6
          */
         readonly edgeSummaries: data.IKeyedReadOnlyCollection<visual.ElementId, visual.IEdgeSummary>;
+        /**
+         * Gets all the node groups in the chart.
+         * @i2since 1.8
+         */
+        readonly nodeGroups: data.IKeyedReadOnlyCollection<visual.ElementId, visual.INodeGroup>;
         /**
          * Gets all the records in the chart.
          * @i2since 1.0
@@ -1564,6 +1702,27 @@ export declare namespace chart {
              */
             readonly removed: data.IReadOnlyCollection<visual.ElementId>;
         };
+        /**
+         * Gets the {@link visual.INodeGroup | node groups} that changed.
+         * @i2since 1.8
+         */
+        readonly nodeGroups: {
+            /**
+             * Gets the node groups that were added.
+             * @i2since 1.8
+             */
+            readonly added: data.IKeyedReadOnlyCollection<visual.ElementId, visual.INodeGroup>;
+            /**
+             * Gets the node groups that were changed.
+             * @i2since 1.8
+             */
+            readonly changed: data.IKeyedReadOnlyCollection<visual.ElementId, visual.INodeGroup>;
+            /**
+             * Gets the identifiers of the node groups that were removed.
+             * @i2since 1.8
+             */
+            readonly removed: data.IReadOnlyCollection<visual.ElementId>;
+        };
     }
     /**
      * A change to the data in a chart in i2 Notebook.
@@ -2406,7 +2565,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;
@@ -2425,6 +2584,11 @@ 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 performs a one-level expand operation on the current selection.
          * @i2since 1.1
@@ -2440,6 +2604,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
@@ -2561,10 +2730,10 @@ 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;
     }
     /**
      * A lookup table for the identifiers of the system action groups in the Home tab.
@@ -5505,7 +5674,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
@@ -5522,6 +5696,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.
@@ -5575,6 +5754,58 @@ export declare namespace visual {
          */
         readonly edges: data.IKeyedReadOnlyCollection<ElementId, IEdge>;
     }
+    /**
+     * A node group, which is a collection of nodes that can be moved and selected together.
+     * @i2since 1.8
+     */
+    export interface INodeGroup {
+        /**
+         * Gets the identifier of the node group.
+         * @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;
+        /**
+         * 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.7.2-dev.0",
+  "version": "1.8.0-dev.10",
   "description": "i2 Notebook SDK",
   "license": "MIT",
   "publishConfig": {