jspreadsheet 8.1.14 → 8.2.2

package/dist/index.d.ts

@@ -224,7 +224,7 @@ declare namespace jspreadsheet {
         /** When the spreadsheet needs to save something in the server. */
         persistence?: (method: String, args: Object) => void;
         /** When the user opens the context menu. */
-        contextMenu?: (instance: Object, x: Number, y: Number, e: MouseEvent, items:Array<ContextmenuItem> , section: String, a: any, b?: any) => void;
+        contextMenu?: (instance: Object, x: number, y: number, e: MouseEvent, items:Array<ContextmenuItem> , section: String, a: any, b?: any) => void;
         /** When the toolbar is create and clicked. */
         toolbar?: (instance: Object, toolbar: Toolbar) => void;
     }
@@ -397,8 +397,18 @@ declare namespace jspreadsheet {
         onbeforefilter?: (worksheet: worksheetInstance, filters: [], data: []) => void;
         /** After the filter has been applied to the rows. */
         onfilter?: (worksheet: worksheetInstance, filters: [], data: []) => void;
-        /** When a new cell is created **/
+        /** When a new cell is created */
         oncreatecell?: (worksheet: worksheetInstance, cell: HTMLElement, x: number, y: number, value: any) => void;
+        /** When a new row is created */
+        oncreaterow?: (worksheet: worksheetInstance, j: number, HTMLElement: tr) => void;
+        /**
+         * Before execute a formula.
+         * @param {string} expression - formula to be executed.
+         * @param {number} coordinate x - cell coordinates
+         * @param {number} coordinate y
+         * @return {any} Return false to cancel parsing. Return new parsed formula. Return void to continue with original formula
+         */
+        onbeforeformula?: (worksheet: worksheetInstance, expression: string, x: number, y: number) => string | false | void;
         /** Run every single table update action. Can bring performance issues if perform too much changes. */
         updateTable?: (worksheet: worksheetInstance, cell: Object, x: number, y: number, value: String) => void;
         /** Return false to cancel the contextMenu event, or return custom elements for the contextmenu. */
@@ -444,7 +454,7 @@ declare namespace jspreadsheet {
         defaultColWidth?: number | string;
         /** Default row height. Default: null */
         defaultRowHeight?: number | string;
-        /** Default alignment for a new column: [center, left, right] */
+        /** Deprecated. The default alignment of a cell is defined by a CSS class from 8.2.0+ */
         defaultColAlign?: 'center' | 'left' | 'right' | 'justify';
         /** Minimum number of spare rows. Default: 0 */
         minSpareRows?: number;
@@ -546,7 +556,7 @@ declare namespace jspreadsheet {
         /** Contextmenu HTMLElement */
         contextmenu: HTMLElement;
         /** Create a new worksheet from the given settings */
-        createWorksheet: (options: Worksheet) => void;
+        createWorksheet: (options: Worksheet) => worksheetInstance;
         /** Delete an existing worksheet by its position */
         deleteWorksheet: (position: Number) => void;
         /** DOM Element */
@@ -568,7 +578,7 @@ declare namespace jspreadsheet {
         /** Get the worksheet by its id */
         getWorksheet: (id: String) => Number;
         /** Get the active worksheet when applicable */
-        getWorksheetActive: () => worksheetInstance;
+        getWorksheetActive: () => number;
         /** Get the worksheet instance by its position */
         getWorksheetInstance: (position: Number) => worksheetInstance;
         /** HTMLElement Helper */
@@ -637,7 +647,7 @@ declare namespace jspreadsheet {
         /** DOM Corner square */
         corner: HTMLElement;
         /** Create a new worksheet */
-        createWorksheet: (worksheetOptions: Worksheet) => void;
+        createWorksheet: (worksheetOptions: Worksheet) => worksheetInstance;
         /** Internal selected cell */
         cursor: object;
         /** Cut */
@@ -704,9 +714,11 @@ declare namespace jspreadsheet {
          *
          * @param {boolean} only the selected cells
          * @param {boolean} get the raw or processed data
-         * @return {array} array of data
+         * @param {string} delimiter to get the data as a string with columns separate by the char delimiter.
+         * @param {boolean} get the data as a JSON object.
+         * @return {array|object} array or object with the data
          */
-        getData: (highlighted?: boolean, processed?: boolean, delimiter?: string) => Array<any>;
+        getData: (highlighted?: boolean, processed?: boolean, delimiter?: string, asJson?: boolean) => Array<any> | String;
         /** Get the defined name or defined names when key is null */
         getDefinedNames: (key?: string) => object;
         /** Internal method: Get the editor for one cell */