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

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

@@ -694,6 +694,41 @@ export declare namespace app {
      * @i2since 1.8
      */
     export interface INodeGroupEditor {
+        /**
+         * Sets or resets the label of the node group.
+         *
+         * @param label - The label to set, or `undefined` to reset the label to the default.
+         * @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 `undefined` to reset the color to the theme default.
+         * @returns The node group, 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.8
+         */
+        setBorderColor(color: string | undefined): this;
+        /**
+         * Sets or resets the fill color of the node group.
+         *
+         * @param color - The color to set, or `undefined` to reset the fill color to the theme default.
+         * @returns The node group, with its fill 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.8
+         */
+        setFillColor(color: string | undefined): this;
+        /**
+         * Sets or resets the image for the node group.
+         *
+         * @param href - The URL of the image to use.
+         * @param description - A description of the image.
+         * @returns The node group, with its image set to the specified URL and description.
+         * @i2since 1.8
+         */
+        setImage(href: string, description?: string): this;
         /**
          * Adds nodes to the group.
          * @param nodes - The nodes to add to the group.
@@ -2502,7 +2537,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 +2556,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
@@ -2536,6 +2576,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
@@ -2657,10 +2702,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.
@@ -5681,12 +5726,43 @@ 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;
         /**
          * 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 extends IElementStyleBase {
+        /**
+         * Gets the image to display for the node group.
+         * @i2since 1.8
+         */
+        readonly image: IImageSetting;
+        /**
+         * Gets the border color of the node group, or undefined if there is no explicit border color.
+         * @i2since 1.8
+         */
+        readonly borderColor: IElementSetting<string | undefined>;
+        /**
+         * Gets the fill color of the node group, or undefined if there is no explicit fill color.
+         * @i2since 1.8
+         */
+        readonly fillColor: IElementSetting<string | undefined>;
+    }
 }
 
 export { }

package/package.json

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