@nebula.js/stardust 3.1.0-alpha.1 → 3.1.0-alpha.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nebula.js/stardust",
-  "version": "3.1.0-alpha.1",
+  "version": "3.1.0-alpha.3",
   "description": "Product and framework agnostic integration API for Qlik's Associative Engine",
   "license": "MIT",
   "author": "QlikTech International AB",
@@ -44,15 +44,15 @@
   "devDependencies": {
     "@emotion/react": "^11.10.5",
     "@emotion/styled": "^11.10.5",
-    "@mui/icons-material": "^5.10.9",
-    "@mui/material": "^5.10.12",
-    "@nebula.js/conversion": "^3.1.0-alpha.1",
-    "@nebula.js/enigma-mocker": "^3.1.0-alpha.1",
-    "@nebula.js/locale": "^3.1.0-alpha.1",
-    "@nebula.js/nucleus": "^3.1.0-alpha.1",
-    "@nebula.js/supernova": "^3.1.0-alpha.1",
-    "@nebula.js/theme": "^3.1.0-alpha.1",
-    "@nebula.js/ui": "^3.1.0-alpha.1",
+    "@mui/icons-material": "^5.10.16",
+    "@mui/material": "^5.10.16",
+    "@nebula.js/conversion": "^3.1.0-alpha.3",
+    "@nebula.js/enigma-mocker": "^3.1.0-alpha.3",
+    "@nebula.js/locale": "^3.1.0-alpha.3",
+    "@nebula.js/nucleus": "^3.1.0-alpha.3",
+    "@nebula.js/supernova": "^3.1.0-alpha.3",
+    "@nebula.js/theme": "^3.1.0-alpha.3",
+    "@nebula.js/ui": "^3.1.0-alpha.3",
     "@scriptappy/cli": "0.1.0",
     "@scriptappy/to-dts": "1.0.0-beta.4",
     "extend": "3.0.2",
@@ -63,8 +63,8 @@
     "react-virtualized-auto-sizer": "^1.0.7",
     "react-window": "1.8.8",
     "react-window-infinite-loader": "1.0.8",
-    "regenerator-runtime": "0.13.10",
+    "regenerator-runtime": "0.13.11",
     "semver": "6.3.0"
   },
-  "gitHead": "62d1862cc80fca13ab2753702ce2c396fed4b9d8"
+  "gitHead": "7697cb029246354e9f2255410c389b6996c89ced"
 }

package/types/index.d.ts

@@ -213,10 +213,11 @@ declare namespace stardust {
         constructor();
 
         /**
-         * Renders a visualization into an HTMLElement.
+         * Renders a visualization or sheet into an HTMLElement.
+         * Support for sense sheets is experimental.
          * @param cfg The render configuration.
          */
-        render(cfg: stardust.CreateConfig | stardust.GetConfig): Promise<stardust.Viz>;
+        render(cfg: stardust.CreateConfig | stardust.GetConfig): Promise<stardust.Viz | stardust.Sheet>;
 
         /**
          * Updates the current context of this embed instance.
@@ -294,6 +295,23 @@ declare namespace stardust {
         qId: string;
     }
 
+    /**
+     * A controller to further modify a visualization after it has been rendered.
+     */
+    class Sheet {
+        constructor();
+
+        id: string;
+
+        model: string;
+
+        /**
+         * Destroys the sheet and removes it from the the DOM.
+         */
+        destroy(): void;
+
+    }
+
     /**
      * A controller to further modify a visualization after it has been rendered.
      */
@@ -302,6 +320,8 @@ declare namespace stardust {
 
         id: string;
 
+        model: string;
+
         /**
          * Destroys the visualization and removes it from the the DOM.
          */
@@ -465,6 +485,10 @@ declare namespace stardust {
         className: "njs-cell-sub-title";
     }
 
+    interface SheetElement extends HTMLElement{
+        className: "njs-sheet";
+    }
+
     interface VizElementAttributes extends NamedNodeMap{
         "data-render-count": string;
     }
@@ -618,11 +642,12 @@ declare namespace stardust {
         /**
          * Resolve a color object using the color picker palette from the provided JSON theme.
          * @param c
+         * @param supportNone Shifts the palette index by one to account for the "none" color
          */
         getColorPickerColor(c: {
             index?: number;
             color?: string;
-        }): string;
+        }, supportNone?: boolean): string;
 
         /**
          * Get the best contrasting color against the specified `color`.