jspreadsheet 10.2.0 → 10.2.2

package/dist/index.d.ts

@@ -27,6 +27,8 @@ declare namespace jspreadsheet {
     let history: History;
     /** Clipboard controller */
     let clipboard: ClipBoard;
+    /** Pause calculations */
+    function calculations(state: boolean) : void;
 
     /** Define the translations from english to any other language. Ex.{ 'hello': 'Ola', 'Successfully Saved': 'Salvo com sucesso' } */
     function setDictionary(dictionary: object) : void;
@@ -37,8 +39,8 @@ declare namespace jspreadsheet {
     /** Set extensions to the JSS spreadsheet. Example { formula, parser, render } */
     function setExtensions(extensions: object) : void;
 
-    /** Destroy the spreadsheet. Full destroy will clear all JSS controllers and it is not possible to re-create a new spreadsheet if true is used, until refresh the page. */
-    function destroy(element: HTMLElement, fullDestroy?: boolean) : void;
+    /** Destroy the spreadsheet. Full destroy will clear all JSS controllers and is not possible to re-create a new spreadsheet if true is used, until refresh the page. */
+    function destroy(element: HTMLElement | spreadsheetInstance, fullDestroy?: boolean) : void;
 
     /** Jspreadsheet parser extension. More info at: https://jspreadsheet.com/products */
     function parser(options: any) : void;
@@ -76,12 +78,15 @@ declare namespace jspreadsheet {
     }
 
     /** Images */
-    interface Image {
-        src: string,
+    interface Media {
+        type: 'image' | 'chart',
+        src?: string,
         top?: number,
         left?: number,
         width?: number,
         height?: number,
+        zIndex?: number,
+        options?: object,
     }
 
     /** New column object */
@@ -547,8 +552,6 @@ declare namespace jspreadsheet {
       title?: string;
       /** Determines whether the row is visible or not. */
       visible?: boolean;
-      /** Inline style for the row element (tr tag). */
-      style?: string;
       /** ID number that identifies the row. */
       id?: number;
       /** Number of rows that this row is grouped with. */
@@ -722,6 +725,8 @@ declare namespace jspreadsheet {
         onresizerow?: (worksheet: worksheetInstance, row: number | Array<number>, height: number | Array<number>, oldHeight: number | Array<number>) => void;
         /** After a column width change for one or more columns. */
         onresizecolumn?: (worksheet: worksheetInstance, column: number | Array<number>, width: number | Array<number>, oldWidth: number | Array<number>) => void;
+        /** Before the selection happens */
+        onbeforeselection?: (worksheet: worksheetInstance, px: number, py: number, ux: number, uy: number, origin?: object) => void | boolean;
         /** When the selection is changed. */
         onselection?: (worksheet: worksheetInstance, px: number, py: number, ux: number, uy: number, origin?: object) => void;
         /** Before the comments is added or updated. Return false to cancel the event, void to accept the action or a object. */
@@ -826,6 +831,10 @@ declare namespace jspreadsheet {
         onopencolumngroup?: (worksheet: object, column: number) => void
         /** When close a column group */
         onclosecolumngroup?: (worksheet: object, column: number) => void
+        /** Onchangemedia brings the new values and the affected objects */
+        onchangemedia?: (worksheet: object, newValue: object[], oldValue: object, affectedRecords: object[]) => void
+        /** Update references. When a table structure changes */
+        onchangereferences?: (worksheet: object, affected: object, deletedTokens: string[], deletedColumns: string[]) => void;
         /** General event handler */
         onevent?: (worksheet: worksheetInstance, method: string, a?: any, b?: any, c?: any, d?: any, e?: any, f?: any) => any
         /** Return false to cancel the contextMenu event, or return custom elements for the contextmenu. */
@@ -995,8 +1004,8 @@ declare namespace jspreadsheet {
         wrap?: boolean;
         /** Show the worksheet gridlines. Default: true */
         gridline?: boolean;
-        /** Floating images */
-        images?: Image[];
+        /** Floating images or charts. */
+        media?: Media[];
         /** Cached values. This can be used to skip calculations during onload */
         cache?: Record<string, string|number>;
     }
@@ -1122,7 +1131,7 @@ declare namespace jspreadsheet {
         /** Navigation down */
         down: (shiftKey?: boolean, ctrlKey?: boolean, jump?: boolean) => void;
         /** If extension render exists, execute render extension else download CSV */
-        download: (includeHeaders?: boolean, processed?: boolean) => void;
+        download: (includeHeaders?: boolean, processed?: boolean, csv?: boolean) => void;
         /** Download CSV */
         downloadCSV: (includeHeaders?: boolean, processed?: boolean) => void;
         /** Edition controllers */
@@ -1571,7 +1580,9 @@ declare namespace jspreadsheet {
         /** Refresh the toolbar based on the current worksheet */
         refreshToolbar: () => void;
         /** Add, update or delete a new worksheet floating image */
-        setImage: (index: number, info: Image) => void;
+        setMedia: (items: Media[]) => void;
+        /** List of all guids to delete. Can be charts and images */
+        deleteMedia: (items: object[]|string[]) => void;
         /** Add a global formula to the tracking system. Use from formula pro. Only use if necessary. */
         setTracking: () => void;
     }