jspreadsheet 11.12.1 → 11.13.1

package/dist/index.d.ts

@@ -54,7 +54,7 @@ declare namespace jspreadsheet {
     function destroyAll() : void;
 
     /** Jspreadsheet parser extension. More info at: https://jspreadsheet.com/products */
-    let parser: ((options: any) => void) | undefined;
+    let parser: ((options?: parseOptions) => void) | undefined;
 
     /** Jspreadsheet formula extension. More info at: https://jspreadsheet.com/products */
     let formula: ((expression: string, variables: object, x: number, y: number, instance: worksheetInstance) => void) | undefined;
@@ -243,12 +243,7 @@ declare namespace jspreadsheet {
         /** Ignore blank cells */
         allowBlank?: boolean;
         /** For type: format you can apply some CSS when condition is matched */
-        format?: {
-            color: string;
-            'background-color': string;
-            'font-weight': number;
-            'font-style': string;
-        }
+        format?: Record<string, string>;
         /** For type: format you can add a class when condition is matched */
         className?: string;
         /** Array with two positions, the second position used when criteria is between or not between. */
@@ -550,6 +545,18 @@ declare namespace jspreadsheet {
         value?: string;
     }
 
+    /**
+     * Cell value
+     */
+    interface Record {
+        /** Cached value of the cell */
+        value: string | number | boolean | undefined;
+        /** Coordinate X */
+        x: number;
+        /** Coordinate Y */
+        y: number;
+    }
+
     /**
      * Cell object
      */
@@ -657,6 +664,8 @@ declare namespace jspreadsheet {
         group?: number;
         /** State of the column group. */
         state?: boolean;
+        /** Style index */
+        s?: number;
     }
 
     interface Cell extends ColumnPrimitiveProperties { }
@@ -709,6 +718,8 @@ declare namespace jspreadsheet {
       state?: boolean;
       /** Determines whether the row is read-only or not. */
       readOnly?: boolean;
+      /** Style index */
+      s?: number;
     }
 
     interface RowInstance extends Row {
@@ -957,6 +968,8 @@ declare namespace jspreadsheet {
         onbeforesend?: (worksheet: worksheetInstance, xhr: object) => void
         /** When defined names is affected */
         onchangedefinednames?: (worksheet: worksheetInstance, data: Record<string, any>[]) => void
+        /** Keyboard event */
+        onkeydown?: (worksheet: object, event: object) => void
         /** New char is entered on editor. */
         oninput?: (worksheet: object, event: object, text: string) => void
         /** When change the row visibility */
@@ -1580,9 +1593,10 @@ declare namespace jspreadsheet {
         setHeader: (x: number, title?: string) => false | undefined;
         /** Set the height of one row by its position. currentHeight is for internal use only */
         setHeight: (row: number|number[], height: number|number[], currentHeight?: number|number[]) => void;
-        /** Get the merged cells. Cell name: A1, A2, etc */
+        /** Create a merge cells based on a given cell, colspan and rowspan or an object multiple entries A1: [1,1], or null for the current selected cells */
         setMerge(cellName: Record<string, [number, number]>): false | undefined;
         setMerge(cellName: string, colspan: number, rowspan: number): false | undefined;
+        setMerge(): false | undefined;
         /** Get one or various meta information for one cell. */
         setMeta: (cell: string | Record<string, any>, property?: string, value?: string) => false | undefined;
         /** Set the nested headers */
@@ -1792,6 +1806,10 @@ declare namespace jspreadsheet {
         getZoom: () => number;
         /** Get the coordinates as a number from a range string. Adjust helps to define the height dynamically when you have A:A ranges for example. Works in the same way for 1:1 ranges. Default: true */
         getCoordsFromRange: (range: string, adjust?: boolean) => [number | null, number | null, number | null, number | null];
+        /** Edition handler */
+        edition: HTMLElement;
+        /** Get the cell object by its coords */
+        getCellObject: (x: number, y: number) => Records;
     }
 
     interface International {
@@ -1800,6 +1818,23 @@ declare namespace jspreadsheet {
         /** General number format */
         NumberFormat?: Intl.NumberFormat;
     }
+
+    interface parseOptions {
+        /** Load the XLSX from a remote URL. Bear in mind any potential CORS restrictions using this property. */
+        url?: string;
+        /** Define the decimal and a thousand separator based on a locale. */
+        locale?: string;
+        /** Try to import embed cell style as HTML */
+        parseHTML?: boolean;
+        /** Enable or disable the loading spin. Default: true */
+        loadingSpin?: boolean;
+        /** load from a local file. This property is used along input type='file' */
+        file?: object;
+        /** When the file is loaded. */
+        onload?: (config: jspreadsheet.Spreadsheet) => void;
+        /** Method to be called when something is wrong. */
+        onerror?: (error: object) => void;
+    }
 }
 
 export default jspreadsheet;