@nebula.js/stardust 3.1.0-alpha.2 → 3.1.0-alpha.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nebula.js/stardust",
-  "version": "3.1.0-alpha.2",
+  "version": "3.1.0-alpha.4",
   "description": "Product and framework agnostic integration API for Qlik's Associative Engine",
   "license": "MIT",
   "author": "QlikTech International AB",
@@ -44,16 +44,16 @@
   "devDependencies": {
     "@emotion/react": "^11.10.5",
     "@emotion/styled": "^11.10.5",
-    "@mui/icons-material": "^5.10.16",
-    "@mui/material": "^5.10.16",
-    "@nebula.js/conversion": "^3.1.0-alpha.2",
-    "@nebula.js/enigma-mocker": "^3.1.0-alpha.2",
-    "@nebula.js/locale": "^3.1.0-alpha.2",
-    "@nebula.js/nucleus": "^3.1.0-alpha.2",
-    "@nebula.js/supernova": "^3.1.0-alpha.2",
-    "@nebula.js/theme": "^3.1.0-alpha.2",
-    "@nebula.js/ui": "^3.1.0-alpha.2",
-    "@scriptappy/cli": "0.1.0",
+    "@mui/icons-material": "^5.11.0",
+    "@mui/material": "^5.11.4",
+    "@nebula.js/conversion": "^3.1.0-alpha.4",
+    "@nebula.js/enigma-mocker": "^3.1.0-alpha.4",
+    "@nebula.js/locale": "^3.1.0-alpha.4",
+    "@nebula.js/nucleus": "^3.1.0-alpha.4",
+    "@nebula.js/supernova": "^3.1.0-alpha.4",
+    "@nebula.js/theme": "^3.1.0-alpha.4",
+    "@nebula.js/ui": "^3.1.0-alpha.4",
+    "@scriptappy/cli": "0.5.0",
     "@scriptappy/to-dts": "1.0.0-beta.4",
     "extend": "3.0.2",
     "node-event-emitter": "0.0.1",
@@ -66,5 +66,5 @@
     "regenerator-runtime": "0.13.11",
     "semver": "6.3.0"
   },
-  "gitHead": "363faf5d8b9fd925fad73e9fe36da3d9d57d5b4b"
+  "gitHead": "99152950d6e1ffd73c944673c90931958dc86c03"
 }

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.
          */
@@ -324,39 +344,6 @@ declare namespace stardust {
         isEnabled(flag: string): boolean;
     }
 
-    type Field = string | EngineAPI.INxDimension | EngineAPI.INxMeasure | stardust.LibraryField;
-
-    /**
-     * Rendering configuration for creating and rendering a new object
-     */
-    interface CreateConfig extends stardust.BaseConfig{
-        type: string;
-        version?: string;
-        fields?: stardust.Field[];
-        properties?: EngineAPI.IGenericObjectProperties;
-    }
-
-    /**
-     * Basic rendering configuration for rendering an object
-     */
-    interface BaseConfig {
-        element: HTMLElement;
-        options?: object;
-        plugins?: stardust.Plugin[];
-    }
-
-    /**
-     * Rendering configuration for rendering an existing object
-     */
-    interface GetConfig extends stardust.BaseConfig{
-        id: string;
-    }
-
-    interface LibraryField {
-        qLibraryId: string;
-        type: "dimension" | "measure";
-    }
-
     class AppSelections {
         constructor();
 
@@ -417,18 +404,37 @@ declare namespace stardust {
 
     }
 
-    interface LoadType {
-        (type: {
-            name: string;
-            version: string;
-        }): Promise<stardust.Visualization>;
-    }
+    type Field = string | EngineAPI.INxDimension | EngineAPI.INxMeasure | stardust.LibraryField;
 
-    interface TypeInfo {
-        name: string;
+    /**
+     * Rendering configuration for creating and rendering a new object
+     */
+    interface CreateConfig extends stardust.BaseConfig{
+        type: string;
         version?: string;
-        load: stardust.LoadType;
-        meta?: object;
+        fields?: stardust.Field[];
+        properties?: EngineAPI.IGenericObjectProperties;
+    }
+
+    /**
+     * Basic rendering configuration for rendering an object
+     */
+    interface BaseConfig {
+        element: HTMLElement;
+        options?: object;
+        plugins?: stardust.Plugin[];
+    }
+
+    /**
+     * Rendering configuration for rendering an existing object
+     */
+    interface GetConfig extends stardust.BaseConfig{
+        id: string;
+    }
+
+    interface LibraryField {
+        qLibraryId: string;
+        type: "dimension" | "measure";
     }
 
     /**
@@ -441,6 +447,20 @@ declare namespace stardust {
         fn: ()=>void;
     }
 
+    interface LoadType {
+        (type: {
+            name: string;
+            version: string;
+        }): Promise<stardust.Visualization>;
+    }
+
+    interface TypeInfo {
+        name: string;
+        version?: string;
+        load: stardust.LoadType;
+        meta?: object;
+    }
+
     interface ActionToolbarElement extends HTMLElement{
         className: "njs-action-toolbar-popover";
     }
@@ -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`.