jspreadsheet 8.7.13 → 9.1.0

package/dist/index.d.ts

@@ -1,7 +1,6 @@
 /**
- * Official Type definitions for Jspreadsheet Pro v8
- * https://jspreadsheet.com
- * Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+ * Official Type definitions for Jspreadsheet Pro v9
+ * https://jspreadsheet.com/v9
  */
 
 declare function jspreadsheet(element: HTMLElement, options: jspreadsheet.Spreadsheet) : Array<jspreadsheet.worksheetInstance>;
@@ -15,13 +14,13 @@ declare namespace jspreadsheet {
     function formula(expression: string, variables: object, x: number, y: number, instance: jspreadsheet.worksheetInstance) : void;
 
     /** Jspreadsheet parser extension. More info at: https://jspreadsheet.com/products */
-    function render(options: any) : void;
+    function render(element: HTMLElement, options: any) : void;
 
     /** Jspreadsheet forms extension. More info at: https://jspreadsheet.com/products */
     function forms(options: any) : void;
 
     /** Set extensions to the JSS spreadsheet. Example { formula, parser, render } */
-    function setExtensions(extensions: object) : void
+    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;
@@ -65,7 +64,7 @@ declare namespace jspreadsheet {
         onclick?: Function;
         /** For the type select when a new item is selected */
         onchange?: Function;
-        /** To update the state of this item **/
+        /** To update the state of this item */
         updateState?: Function;
     }
 
@@ -150,7 +149,7 @@ declare namespace jspreadsheet {
 
     interface Column {
         /** Define the column type. Can be a string to define a native editor, or a method to define the custom editor plugin. */
-        type?: Editor | 'autocomplete' | 'calendar' | 'checkbox' | 'color' | 'dropdown' | 'hidden' | 'html' | 'image' | 'numeric' | 'radio' | 'text';
+        type?: Editor | 'autocomplete' | 'calendar' | 'checkbox' | 'color' | 'dropdown' | 'hidden' | 'html' | 'image' | 'numeric' | 'radio' | 'text' | 'notes';
         /** Column title */
         title?: string;
         /** Name or a path of a property when the data is a JSON object. */
@@ -201,6 +200,10 @@ declare namespace jspreadsheet {
         shiftFormula?: boolean;
         /** Wrap the text in the column */
         wrap?: boolean;
+        /** Rotate text value between -90 and 90. Default: null */
+        rotate?: number;
+        /** CSS odd even background color. Default: false */
+        zebra?: boolean;
     }
 
     interface Row {
@@ -249,6 +252,8 @@ declare namespace jspreadsheet {
         tooltip?: string;
         /** Nested header colspan */
         colspan?: number;
+        /** Alignment */
+        align?: 'left' | 'center' | 'right';
     }
 
     interface Spreadsheet {
@@ -258,14 +263,14 @@ declare namespace jspreadsheet {
         cloud?: string;
         /** DOM element for binding the javascript events. This property is normally used when JSS is running as a web component. */
         root?: HTMLElement;
-        /** Global defined names. It defines global range variables. **/
+        /** Global defined names. It defines global range variables. */
         definedNames?: Record<string, string>,
-        /** Global sorting handler. **/
+        /** Global sorting handler. */
         sorting?: (direction: boolean, column: number) => number;
-        /** Remote URL for the persistence server **/
+        /** Remote URL for the persistence server */
         server?: string;
-        /** Toolbar */
-        toolbar?: boolean | Toolbar | Function;
+        /** Enable the toolbars */
+        toolbar?: boolean | 'extended' | Toolbar | Function;
         /**  Allow table edition */
         editable?: boolean;
         /** Allow data export */
@@ -280,11 +285,11 @@ declare namespace jspreadsheet {
         fullscreen?: boolean;
         /** Make sure the formulas are capital letter. Default: true */
         secureFormulas?: boolean;
-        /** Enable formula debug. Default: false **/
+        /** Enable formula debug. Default: false */
         debugFormulas?: boolean,
         /** Execute formulas. Default: true */
         parseFormulas?: boolean;
-        /** Disable the formula editor. Default: true **/
+        /** Disable the formula editor. Default: true */
         editorFormulas?: boolean;
         /** Auto increment cell data when using the corner copy, including formulas, numbers and dates. Default: true */
         autoIncrement?: boolean;
@@ -304,7 +309,7 @@ declare namespace jspreadsheet {
         moveDownOnEnter?: boolean;
         /** This method is called when the data in the spreadsheet is ready. */
         onload?: (spreadsheet: spreadsheetInstance) => void;
-        /** Spreadsheet is clicked **/
+        /** Spreadsheet is clicked */
         onclick?: (worksheet: worksheetInstance, section: string, x: number, y: number) => void;
         /** When undo is applied */
         onundo?: (worksheet: worksheetInstance, historyRecord: object) => void;
@@ -313,7 +318,7 @@ declare namespace jspreadsheet {
         /** Before any data is sent to the backend. Can be used to overwrite the data or to cancel the action when return false. */
         onbeforesave?: (spreadsheet: spreadsheetInstance, worksheet: worksheetInstance, data: object) => boolean | object;
         /** After something is saved */
-        onsave?: (spreadsheet: spreadsheetInstance, worksheet: worksheetInstance, data: Array<any>) => void;
+        onsave?: (spreadsheet: spreadsheetInstance, worksheet: worksheetInstance, data: Array<any>, result: Object) => void;
         /** Before a column value is changed. NOTE: It is possible to overwrite the original value, by return a new value on this method. */
         onbeforechange?: (worksheet: worksheetInstance, cell: HTMLElement, x: number, y: number, value: any) => boolean | any;
         /** After a column value is changed. */
@@ -378,9 +383,9 @@ declare namespace jspreadsheet {
         onchangenestedcell?: (worksheet: worksheetInstance, x: number, y: number, properties: object) => void;
         /** When an editor is created. */
         oncreateeditor?: (worksheet: worksheetInstance, cell: HTMLElement, x: number, y: number, element: HTMLElement, options: object) => void;
-        /** When the editor is opened. **/
+        /** When the editor is opened. */
         oneditionstart?: (worksheet: worksheetInstance, cell: HTMLElement, x: number, y: number) => void;
-        /** When the editor is closed. **/
+        /** When the editor is closed. */
         oneditionend?: (worksheet: worksheetInstance, cell: HTMLElement, x: number, y: number, newValue: any, save: boolean) => void;
         /** When the style of a cell is changed. */
         onchangestyle?: (worksheet: worksheetInstance, newValue: object, oldValue: object) => void;
@@ -430,8 +435,18 @@ declare namespace jspreadsheet {
         onformulachain?: (worksheet: worksheetInstance, expressions: Array<object>) => void;
         /** Customize the items available when filter editor is open. */
         onopenfilter?: (worksheet: worksheetInstance, column: number, options: Array<object>) => void | Array<object>;
+        /** When the viewport dimension is updated. */
+        onresize?: (worksheet: worksheetInstance, w: number, h: number) => void
+        /** Before the references are changed. */
+        onbeforechangereferences?: (worksheet: worksheetInstance, affectedTokens: [], deletedTokens: []) => void
+        /** When the references are changed. Sorting, Add/Delete/Move Rows and Columns. */
+        onchangereferences?: (worksheet: worksheetInstance, affectedTokens: [], deletedTokens: []) => void
         /** Intercept the ajax call before save. XHR ajax object */
         onbeforesend?: (worksheet: worksheetInstance, xhr: object) => void
+        /** When defined names is affected */
+        onchangedefinednames?: (worksheet: object, data: []) => void
+        /** New char is entered on editor. */
+        oninput?: (worksheet: object, event: object) => 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. */
@@ -453,17 +468,17 @@ declare namespace jspreadsheet {
     }
 
     interface Worksheet {
-        /** Logo URL **/
+        /** Logo URL */
         logo?: string
         /** Load the data from an external server URL */
         url?: string;
-        /** Persitence URL or true when the URL is the same of the URL of the data source */
+        /** Persistence URL or true when the URL is the same of the URL of the data source */
         persistence?: string | boolean;
         /** Allow internal sequence for new rows */
         sequence?: boolean;
         /** Load the data into a new spreadsheet from an array of rows or objects */
         data?: Array<Array<any>> | Array<Record<string, any>>;
-        /** Deprected. Please use the data property. */
+        /** Deprecated. Please use the data property. */
         json?: Array<Record<string, any>>;
         /** Array with the rows properties definitions such as title, height. */
         rows?: Row[];
@@ -471,7 +486,7 @@ declare namespace jspreadsheet {
         columns?: Array<Column>;
         /** Define the properties of a cell. This property overwrite the column definitions */
         cells?: Record<string, Column>;
-        /** Role of this worksheet **/
+        /** Role of this worksheet */
         role?: string,
         /** Nested headers definition */
         nestedHeaders?: Array<Array<Nested>> | Array<Nested>;
@@ -551,13 +566,19 @@ declare namespace jspreadsheet {
         style?: Record<string, string>;
         /** Freeze columns. Default: 0 */
         freezeColumns?: number;
+        /** Freeze rows. Default: 0 */
+        freezeRows?: number;
+        /** Enable freeze column manual control. Default: false */
+        freezeColumnControl: boolean,
+        /** Enable freeze row manual control. Default: false */
+        freezeRowControl: boolean,
         /** Initial sorting [colNumber, direction]. Default: null */
         orderBy?: [number, boolean];
-        /** Worksheet Unique Id. **/
+        /** Worksheet Unique Id. */
         worksheetId?: string;
-        /** Worksheet Name. **/
+        /** Worksheet Name. */
         worksheetName?: string;
-        /** Worksheet state: hidden | null. Hide a worksheet **/
+        /** Worksheet state: hidden | null. Hide a worksheet */
         worksheetState?: 'hidden' | undefined;
         /** Enable the column filters */
         filters?: boolean;
@@ -573,6 +594,12 @@ declare namespace jspreadsheet {
         selectUnLockedCells?: boolean;
         /** Allow the selection of locked cells. Default: true. */
         selectLockedCells?: boolean;
+        /** Enable resizable worksheet in on or both direction (horizontal | vertical | both). Default: none */
+        resize?: 'horizontal' | 'vertical' | 'both' | 'none' | undefined;
+        /** Wrap. Default: false */
+        wrap?: boolean,
+        /** Show the worksheet gridlines. Default: true */
+        gridline?: boolean,
     }
 
     interface spreadsheetInstance {
@@ -618,9 +645,9 @@ declare namespace jspreadsheet {
         ignoreHistory: Boolean;
         /** Ignore persistence events */
         ignorePersistence: Boolean;
-        /** HTMLElement editor container **/
+        /** HTMLElement editor container */
         input: HTMLElement;
-        /** HTMLElement loading element **/
+        /** HTMLElement loading element */
         loading: HTMLElement;
         /** Rename an existing worksheet by its position */
         renameWorksheet: (position: Number, title: String) => void;
@@ -704,8 +731,8 @@ declare namespace jspreadsheet {
         edition: [];
         /** DOM Worksheet. Alias for worksheet */
         element: HTMLElement;
-        /** Internal method: Execute a formula */
-        executeFormula: (expression: string, x?: number, y?: number, caching?: boolean) => void;
+        /** Internal method: Execute a formula. */
+        executeFormula: (expression: string, x?: number, y?: number, caching?: boolean, basic?: boolean) => void;
         /** Navigation first */
         first: (shiftKey?: boolean, ctrlKey?: boolean) => void;
         /** Footers */
@@ -760,7 +787,7 @@ declare namespace jspreadsheet {
         getHeaders: (asArray: boolean) => Array<any>;
         /** Get the height of one row by its position when height is defined. */
         getHeight: (row?: number) => Array<number> | number;
-        /** Get the highlighted coordinates **/
+        /** Get the highlighted coordinates */
         getHighlighted: () => Array<any>;
         /** Get json */
         getJson: (h?: boolean, processed?: boolean) => any;
@@ -810,7 +837,7 @@ declare namespace jspreadsheet {
         getValueFromCoords: (x: number, y: number, processed: boolean) => any;
         /** Get the width of one column by index or all column width as an array when index is null. */
         getWidth: (x?: number) => Array<number> | number;
-        /** Go to the row number, [col number] **/
+        /** Go to the row number, [col number] */
         goto: (y: number, x?: number) => void;
         /** Hold the header container */
         headerContainer: HTMLElement;
@@ -867,7 +894,7 @@ declare namespace jspreadsheet {
         /** Spreadsheet object */
         parent: spreadsheetInstance;
         /** Paste */
-        paste: (x: number, y: number, data: string) => void;
+        paste: (x: number, y: number, data: string | any[]) => void;
         /** Get the quantity of pages when pagination is active */
         quantityOfPages?: () => number;
         /** Array with the cell DOM elements */
@@ -902,6 +929,8 @@ declare namespace jspreadsheet {
         results: Array<number>;
         /** Navigation right */
         right: () => void;
+        /** Rotate the spreadsheet cell text. cell = A1, B1... etc */
+        rotate: (cell: string|string[], value:number) => void;
         /** DOM array of rows */
         rows: Array<HTMLElement>;
         /** Persistence helper method. The callback is executed with a JSON from the server */
@@ -944,7 +973,7 @@ declare namespace jspreadsheet {
         setFooterValue: (col: number, row: number, value: any) => void;
         /** Freeze x number of columns */
         setFreezeColumns: (num: number) => void;
-        /** Set the header title. Empty to reset to the default header value. */
+        /** Set the header title. Empty or null to reset to the default header value. */
         setHeader: (x: number, title?: String) => void;
         /** Set the height of one row by its position */
         setHeight: (row: number, width: number) => void;