@i2analyze/notebook-sdk 1.8.0-dev.7 → 1.8.0-dev.9

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.
          *
@@ -705,35 +714,38 @@ export declare namespace app {
         /**
          * 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.
+         * @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): this;
+        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 fill color of the node group.
+         * Sets or resets the background 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.
+         * @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
          */
-        setFillColor(color: string | undefined): this;
+        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;
@@ -5654,7 +5666,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
@@ -5754,22 +5771,27 @@ export declare namespace visual {
      * A style for a node group, which affects its appearance.
      * @i2since 1.8
      */
-    export interface INodeGroupStyle extends IElementStyleBase {
+    export interface INodeGroupStyle {
         /**
-         * Gets the image to display for the node group, or undefined if there is no image.
+         * Gets the image to display for the node group.
          * @i2since 1.8
          */
         readonly image: IImageSetting;
         /**
-         * Gets the border color of the node group.
+         * 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 | undefined>;
+        readonly borderColor: IElementSetting<string | null>;
         /**
          * Gets the border width of the node group.
          * @i2since 1.8
          */
-        readonly borderWidth: IElementSetting<number | undefined>;
+        readonly borderWidth: IElementSetting<number>;
     }
 }
 

package/package.json

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