jspreadsheet 11.26.0 → 12.0.0-beta.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * Official Type definitions for Jspreadsheet Pro v11
+ * Official Type definitions for Jspreadsheet Pro v12
  * https://jspreadsheet.com/docs
  */
 
@@ -29,6 +29,11 @@ declare namespace jspreadsheet {
     let clipboard: ClipBoardMethods;
     /** Shortcuts */
     let shortcuts: Shortcuts;
+    /** Paste with style max size. Default 10Mb */
+    let pasteWithStyleMaxSize: number;
+
+    // Register a validation
+    let setValidationHandler: (name: string, handler: (value: any, options: object) => boolean) => void;
     /** Get the worksheet instance by its name */
     let getWorksheetInstanceByName: GetWorksheetInstanceByNameFunction;
 
@@ -59,10 +64,10 @@ declare namespace jspreadsheet {
     /** Jspreadsheet formula extension. More info at: https://jspreadsheet.com/products */
     let formula: ((expression: string, variables: object, x: number, y: number, instance: worksheetInstance) => void) | undefined;
 
-    /** Jspreadsheet render extension. More info at: https://jspreadsheet.com/products */
-    let render: ((element: HTMLElement | spreadsheetInstance, options: any) => void) | undefined;
+    /** Jspreadsheet parser extension. More info at: https://jspreadsheet.com/products */
+    let render: ((element: HTMLElement, options: any) => void) | undefined;
 
-    /** Jspreadsheet forms an extension. More info at: https://jspreadsheet.com/products */
+    /** Jspreadsheet forms extension. More info at: https://jspreadsheet.com/products */
     let forms: ((options: any) => void) | undefined;
 
     /** Jspreadsheet search extension. More info at: https://jspreadsheet.com/products */
@@ -94,6 +99,31 @@ declare namespace jspreadsheet {
 
     type GetWorksheetInstanceByNameFunction = (worksheetName?: string | null | undefined, namespace?: string) => worksheetInstance | Record<string, worksheetInstance>;
 
+    interface Table {
+        // Type
+        type?: 'table',
+        // Table name
+        name?: string,
+        // Range
+        range?: string,
+        // Table style
+        theme?: string,
+        // The first line is a header
+        headerRow?: boolean,
+        // Total row
+        totalRow?: string,
+        // Alternate row colors
+        bandedRows?: true,
+        // Alternate row colors
+        bandedColumns?: true,
+        // First column as bold
+        firstColumn?: boolean
+        // First row as bold
+        lastColumn?: boolean
+        // Filters
+        filters?: boolean
+    }
+
     interface Picker {
         (el: HTMLElement, options: PickerOptions) : void;
         cancel: () => void;
@@ -150,7 +180,7 @@ declare namespace jspreadsheet {
     /** Common properties for all media types */
     interface MediaBase {
         // GUID string
-        id: string;
+        id?: string;
         type: 'image' | 'chart' | 'shape';
         top?: number;
         left?: number;
@@ -311,11 +341,11 @@ declare namespace jspreadsheet {
         /** Excel-like range format Sheet1!A1:A6 */
         range: string;
         /** Validation type */
-        type: 'number' | 'text' | 'date' | 'list' | 'textLength' | 'empty' | 'notEmpty';
+        type: 'number' | 'text' | 'date' | 'list' | 'textLength' | 'empty' | 'notEmpty' | Function;
         /** Validation action can be a warning or reject when the condition are not match or a format when the condition matches */
         action: 'warning' | 'reject' | 'format';
         /** Criteria to be match */
-        criteria:
+        criteria?:
             | '='
             | '!='
             | '>='
@@ -342,7 +372,7 @@ declare namespace jspreadsheet {
         /** Array with two positions, the second position used when criteria is between or not between. */
         value?: number[] | string[],
         /** Make sure run that as a dropdown */
-        dropdown: true,
+        dropdown?: true,
     }
 
     /** Validations update format */
@@ -571,9 +601,9 @@ declare namespace jspreadsheet {
 
     interface DropdownItem {
         /** Value of the selected item. */
-        id?: string | number;
+        value?: string | number;
         /** Label for the selected item. */
-        name?: string;
+        text?: string;
         /** Description of the item */
         title?: string;
         /** Icon of the item */
@@ -586,6 +616,10 @@ declare namespace jspreadsheet {
         disabled?: boolean;
         /** Color for the item */
         color?: string;
+        /** Deprecated */
+        id?: string | number;
+        /** Deprecated */
+        name?: string;
     }
 
     interface ContextmenuItem {
@@ -755,8 +789,6 @@ declare namespace jspreadsheet {
         visible?: boolean,
         /** A method to overwrite the column definitions in real-time just before the column is edited. */
         filterOptions?: (worksheet: worksheetInstance, cell: HTMLElement, x: number, y: number, value: number|string, options: Column) => Column;
-        /** Whether the column is a primary key. */
-        primaryKey?: boolean;
         /** Whether to shift the formula when copying and pasting. This option is only valid for custom column types. Default: false. */
         shiftFormula?: boolean;
         /** Whether to apply CSS odd-even background color to the column. Default: false. */
@@ -884,8 +916,6 @@ declare namespace jspreadsheet {
         definedNames?: Record<string, string>,
         /** Global sorting handler. */
         sorting?: (direction: boolean, column: number) => (a: any, b: any) => number;
-        /** Remote URL for the persistence server */
-        server?: string;
         /** Enable the toolbars */
         toolbar?: boolean | Toolbar | ToolbarItem[] | ((toolbarOptions: Toolbar) => Toolbar);
         /**  Allow table edition */
@@ -898,8 +928,6 @@ declare namespace jspreadsheet {
         forceUpdateOnPaste?: boolean;
         /** Render jspreadsheet spreadsheet on full screen mode. Default: false */
         fullscreen?: boolean;
-        /** Make sure the formulas are capital letter. Default: true */
-        secureFormulas?: boolean;
         /** Enable formula debug. Default: false */
         debugFormulas?: boolean,
         /** Execute formulas. Default: true */
@@ -912,6 +940,8 @@ declare namespace jspreadsheet {
         autoIncrement?: boolean;
         /** Try to cast numbers from cell values when executing formulas. Default: true */
         autoCasting?: boolean;
+        /** Try to find a format when the input is a string. Default: true */
+        autoFormat?: boolean;
         /** Parse HTML. Default: false (Use this with caution) */
         parseHTML?: boolean;
         /** Allow bar when extension bar is enabled. Default: true */
@@ -934,10 +964,6 @@ declare namespace jspreadsheet {
         onundo?: (worksheet: worksheetInstance, historyRecord: object) => void;
         /** When redo is applied */
         onredo?: (worksheet: worksheetInstance, historyRecord: object) => void;
-        /** 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 | undefined;
-        /** After something is saved */
-        onsave?: (spreadsheet: spreadsheetInstance, worksheet: worksheetInstance, data: object, result: object) => void;
         /** When something goes wrong during a persistence operation */
         onerror?: (spreadsheet: spreadsheetInstance, 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. */
@@ -946,7 +972,7 @@ declare namespace jspreadsheet {
         onchange?: (worksheet: worksheetInstance, cell: HTMLElement, x: number | string, y: number | string, newValue: any, oldValue: any) => void;
         /** After a cell value is rendered */
         onrender?: (worksheet: worksheetInstance, cell: HTMLElement, x: number | string, y: number | string, newValue: any, options: Column) => void;
-        /** Before changes have been applied. Origin: 'paste', 'handle-fill' or undefined */
+        /** Before all data have been updated. Origin: 'paste', 'handle-fill' or undefined */
         onbeforechanges?: (worksheet: worksheetInstance, records: Record<string, any>[], origin: string | undefined) => void | boolean | Record<string, any>[];
         /** When all data have been updated. Origin: 'paste', 'handle-fill' or undefined */
         onafterchanges?: (worksheet: worksheetInstance, records: Record<string, any>[], origin: string | undefined) => void;
@@ -979,12 +1005,8 @@ declare namespace jspreadsheet {
         onbeforedeletecolumn?: (worksheet: worksheetInstance, cols: number[]) => false | number[] | undefined;
         /** After a column is excluded. */
         ondeletecolumn?: (worksheet: worksheetInstance, cols: number[]) => void;
-        /** Before a row is moved to a new position. */
-        onbeforemoverow?: (worksheet: worksheetInstance, origin: number, destination: number, quantityOfRows: number) => void | false;
         /** After a row is moved to a new position. */
         onmoverow?: (worksheet: worksheetInstance, origin: number, destination: number, quantityOfRows: number) => void;
-        /** Before a column is moved to a new position. */
-        onbeforemovecolumn?: (worksheet: worksheetInstance, origin: number, destination: number, quantityOfColumns: number) => void | false;
         /** After a column is moved to a new position. */
         onmovecolumn?: (worksheet: worksheetInstance, origin: number, destination: number, quantityOfColumns: number) => void;
         /** After a height change for one or more rows. */
@@ -1016,7 +1038,7 @@ declare namespace jspreadsheet {
         /** When the value in a cell footer is changed. */
         onchangefootervalue?: (worksheet: worksheetInstance, x: number, y: number, value: string) => void;
         /** When the footer cell is rendered */
-        onrenderfootercell?: (worksheet: worksheetInstance, x: number, y: number, value: string, td: HTMLElement) => void;
+        onrenderfootercell?: (worksheet: worksheetInstance, record: object) => void;
         /** On change nested headers */
         onchangenested?: (worksheet: worksheetInstance, options: object) => void;
         /** On change nested cell properties */
@@ -1077,8 +1099,6 @@ declare namespace jspreadsheet {
         onopenfilter?: (worksheet: worksheetInstance, column: number, options: Record<string, any>[]) => Record<string, any>[] | Promise<Record<string, any>[]> | undefined;
         /** When the viewport dimension is updated. */
         onresize?: (w: number, h: number) => void
-        /** Intercept the ajax call before save. XHR ajax object */
-        onbeforesend?: (worksheet: worksheetInstance, xhr: object) => void
         /** When defined names is affected */
         onchangedefinednames?: (worksheet: worksheetInstance, data: Record<string, any>[]) => void
         /** Keyboard event */
@@ -1160,10 +1180,6 @@ declare namespace jspreadsheet {
     interface Worksheet {
         /** Load the data from an external server URL */
         url?: string;
-        /** 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>>;
         /** Array with the rows properties definitions such as title, height. */
@@ -1290,8 +1306,8 @@ declare namespace jspreadsheet {
         zoom?: number;
         /** Detect column names from the data object given when the column names are not declared. Default: true */
         autoNames?: boolean;
-        /** Ignore Undefined Columns. Default: false */
-        ignoreUndefinedColumns?: boolean;
+        /** Tables */
+        tables?: Table[]
     }
 
     interface SpreadsheetHTMLElement extends HTMLDivElement {
@@ -1315,8 +1331,6 @@ declare namespace jspreadsheet {
         helper: HTMLElement,
         /** Ignore events */
         ignoreEvents: boolean;
-        /** Ignore persistence events */
-        ignorePersistence: boolean;
         /** HTMLElement editor container */
         input: HTMLElement;
         /** HTMLElement loading element */
@@ -1491,8 +1505,8 @@ declare namespace jspreadsheet {
         /** Internal method: Get the editor for one cell */
         getEditor: (x: number, y: number) => [Editor, Cell | Column];
         /** Internal method: Get the filter */
-        getFilter: (column: number, getAsSets?: boolean) => string[] | string[][] | Set<string> | Set<string>[] | undefined;
-        /** Get the footers configuration */
+        getFilter: (col: number, row: number, getAsSets?: boolean) => string[] | string[][] | Set<string> | Set<string>[] | undefined;
+        /** Get the footer configuration */
         getFooter: () => Array<any> | undefined;
         /** Get the footer value */
         getFooterValue: (x: number, y: number) => any;
@@ -1518,12 +1532,8 @@ declare namespace jspreadsheet {
         getNestedCell: (x: number, y: number) => HTMLTableCellElement;
         /** Get the nested headers */
         getNestedHeaders: () => Nested[][] | undefined;
-        /** Get the next available number in the sequence */
-        getNextSequence: () => number | null;
         /** Alias to getProperty */
         getOptions: (x: number, y?: number) => Cell | ColumnInstance | undefined;
-        /** Get the primaryKey column when applicable. */
-        getPrimaryKey: () => number | false;
         /** Get processed data by the coordinates of the cell. Extended process a color, progressbar and rating as raw. */
         getProcessed: (x: number, y: number, extended?: boolean) => any;
         /** Get the properties for one column when only x is present or the cell when x and y is defined. */
@@ -1537,7 +1547,7 @@ declare namespace jspreadsheet {
         /** Get the data from one row */
         getRowData: (row: number, processed?: boolean) => any[] | Record<string, any> | undefined;
         /** Get the row id from its position */
-        getRowId: (row: number, primaryKey?: boolean) => any;
+        getRowId: (row: number) => any;
         /**
          * Get the selected cells
          * @param {boolean?} columnNameOnly - Return an array of cell names or cell DOM elements
@@ -1566,8 +1576,8 @@ declare namespace jspreadsheet {
         /** Find a style ID from a style string. Null when no styleId is found */
         getStyleId: (styleString?: string) => number | null;
         /** Get value by the cell name or object. The value can be the raw or processed value. */
-        getValue(cell: string, processed?: boolean): Array<Array<any>> | Array<Record<string, any>> | string;
-        getValue(cell: { x: number, y: number }, processed?: boolean): any;
+        getValue(cell: string, processed?: boolean, raw?: boolean): Array<Array<any>> | Array<Record<string, any>> | string;
+        getValue(cell: { x: number, y: number }, processed?: boolean, raw?: boolean): any;
         /** Get value by the coordinates. The value can be the source or processed value, including not formatted proceed data. */
         getValueFromCoords: (x: number, y: number, processed?: boolean, raw?: boolean) => any;
         /** Get the width of one column by index or all column width as an array when index is null. */
@@ -1578,7 +1588,7 @@ declare namespace jspreadsheet {
         headerContainer: HTMLElement;
         /** Hide column */
         hideColumn: (column: number|number[]) => void;
-        /** Hide the filters for column, columns or cell range. */
+        /** Hide the filters for the column or a cell range. */
         hideFilter: (colNumber?: number | string) => void;
         /** Hide index column */
         hideIndex: () => void;
@@ -1638,7 +1648,7 @@ declare namespace jspreadsheet {
         /** Start the edition for one cell */
         openEditor: (cell: HTMLElement, empty?: boolean, mouseEvent?: object) => false | undefined;
         /** Open the filters */
-        openFilter: (column: number) => void;
+        openFilter: (column: number, row?: number) => void;
         /** Worksheet configuration */
         options: Worksheet;
         /** Sort one column by its position. ASC (0) or DESC (1) */
@@ -1665,8 +1675,6 @@ declare namespace jspreadsheet {
         records: Records[][];
         /** Refresh the borders by the border name */
         refreshBorders: (border?: string) => void;
-        /** Refresh footers */
-        refreshFooter: () => void;
         /** Remove the merged cells by the cell name or a object with all cells to be removed. */
         removeMerge: (cellName: string | Record<string, any>) => false | undefined;
         /**
@@ -1677,8 +1685,8 @@ declare namespace jspreadsheet {
          * @returns {boolean | undefined} - True if successful, false if no border found.
          */
         resetBorders: (border?: string, permanent?: boolean) => void;
-        /** Reset the filter of one or all columns */
-        resetFilters: (colNumber?: number, destroy?: boolean) => void;
+        /** Reset the filter */
+        resetFilters: (column?: number, row?: number) => void;
         /** Destroy the footers */
         resetFooter: () => void;
         /** Destroy freeze columns */
@@ -1701,8 +1709,6 @@ declare namespace jspreadsheet {
         rotate: (cell: string|string[], value:number) => void;
         /** Array of row objects */
         rows: RowInstance[] | Record<number, RowInstance>;
-        /** Persistence helper method. The callback is executed with a JSON from the server */
-        save: (url: string, data: object, token?: string, callback?: (result: object) => void) => void;
         /** Search for something */
         search: (str: string) => false | undefined;
         /** Search HTML container */
@@ -1714,8 +1720,6 @@ declare namespace jspreadsheet {
         /** Selected cells */
         selectedCell: RangeCoords | null;
         currentSelection: RangeCoords | null;
-        /** Internal record id sequence */
-        sequence: number;
         /**
          * Adds a colored border to a cell range with a unique identifier.
          * @intent highlight-cells, create-border
@@ -1758,11 +1762,11 @@ declare namespace jspreadsheet {
         /** Reset names by indexes */
         resetDefinedNames: (names: DefinedNames[]) => void;
         /** Set filter */
-        setFilter: (colNumber: number, keywords?: string[]) => void;
+        setFilter: (colNumber: number, rowNumber: number | null, keywords?: string[]) => void;
         /** Set the footers */
         setFooter: (data: any[][]) => void;
         /** Set the footer value */
-        setFooterValue: (col: number, row: number, value: any) => void;
+        setFooterValue: (values: CellRecord[]) => void;
         /** List of columns to freeze. Should be a number or an array of consecutive numbers. Example: [4,5,6] */
         setFreezeColumns: (num?: number | number[] | null) => void;
         /**
@@ -1791,13 +1795,13 @@ declare namespace jspreadsheet {
          */
         setMerge(cellName: string, colspan: number, rowspan: number): false | undefined;
         setMerge(cells: MergeConfig): false | undefined;
-        /** Get one or various meta information for one cell. */
+        /** 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 */
         setNestedHeaders: (config: Nested[][]) => void;
         /** Deprecated. Alias for parent.setPlugins */
         setPlugins: (plugins: Record<string, Plugin>) => void;
-        /** Add a new configuration settings for a column or cell */
+        /** Add a new configuration setting for a column or cell */
         setProperty(columnNumber: number, rowNumber: number, cellSettings?: Cell): boolean;
         setProperty(columnNumber: number, columnSettings: Column): boolean;
         setProperty(changes: ({ x: number, value: Column } | { x: number, y: number, value: Cell })[]): boolean;
@@ -1919,8 +1923,6 @@ declare namespace jspreadsheet {
         resetColumnGroup: (column: number) => void;
         /** Aliases for jspreadsheet.helpers. Tools to handle spreadsheet data */
         helpers: Helpers;
-        /** Internal persistence handler */
-        persistence: Function;
         /** Deprecated. Alias for parent.undo */
         undo: () => void;
         /** Deprecated. Alias for parent.redo */
@@ -1960,12 +1962,13 @@ declare namespace jspreadsheet {
         setValidations: (validations: Validations | Validations[]) => false | undefined;
         /** Reset validations by validation indexes. Undefined will remove all validations */
         resetValidations: (validationIndex?: number | number[]) => false | undefined;
-        /** Load all validations rules from a cell based on its coordinates. */
-        loadValidations(xOrCell: Records, y?: undefined, includeIndexes?: boolean): Validation[] | { index: number, rules: Validation }[] | undefined;
-        loadValidations(xOrCell: number, y: number, includeIndexes?: boolean): Validation[] | { index: number, rules: Validation }[] | undefined;
+        /** Load all validation rules from a cell based on its coordinates. */
+        loadValidations(x: number, y: number): Validation[] | undefined;
         /** This method returns true if a cell fails to meet all the defined validation criteria. If invoked without arguments, this method will scan the entire worksheet and return true if it detects validation errors. */
-        hasErrors(): boolean;
+        hasErrors(): boolean | number[];
+        /** Check for errors from a cell by its name hasError('A1') */
         hasErrors(col: string): boolean;
+        /** Check the errors from a cell by its coordinates */
         hasErrors(col: number, row: number): boolean;
         /** Resize columns to match the visible content */
         autoWidth: (columns: number[]) => void;
@@ -1973,8 +1976,6 @@ declare namespace jspreadsheet {
         showHeaders: () => void;
         /** Hide the column headers */
         hideHeaders: () => void;
-        /** Refresh the search on the viewport */
-        updateSearch: () => void;
         /** Get the worksheet index by instance or worksheetId */
         getWorksheet(worksheetIdent: worksheetInstance): number | false;
         getWorksheet(worksheetIdent: string, instance?: boolean): worksheetInstance | number | false;