jspreadsheet 9.2.1 → 9.2.3

package/dist/index.d.ts

@@ -11,7 +11,7 @@ declare namespace jspreadsheet {
     let license: string;
 
     /** Default row height for a table */
-    let defaultRowHeight: number;
+    let defaultRowHeight: number | string;
 
     /** The container that holds all spreadsheet instances in the screen */
     let spreadsheet: Spreadsheet[];
@@ -44,7 +44,7 @@ declare namespace jspreadsheet {
     function parser(options: any) : void;
 
     /** Jspreadsheet formula extension. More info at: https://jspreadsheet.com/products */
-    function formula(expression: string, variables: object, x: number, y: number, instance: jspreadsheet.worksheetInstance) : void;
+    function formula(expression: string, variables: object, x: number, y: number, instance: worksheetInstance) : void;
 
     /** Jspreadsheet parser extension. More info at: https://jspreadsheet.com/products */
     function render(element: HTMLElement, options: any) : void;
@@ -138,11 +138,11 @@ declare namespace jspreadsheet {
         /** Render method parser for the elements in the dropdown when type: select */
         render?: Function;
         /** When a item is clicked */
-        onclick?: Function;
+        onclick?: (el: HTMLElement, iconObject: object, toolbarItem: HTMLElement) => void;
         /** For the type select when a new item is selected */
-        onchange?: Function;
-        /** To update the state of this item */
-        updateState?: Function;
+        onchange?: (el: HTMLElement, pickerObject: object, reservedValue: any, itemValue: string, itemKey: string, mouseEvent: object) => void;
+        /** To update the state of the toolbar */
+        updateState?: (toolbarObject: object, toolbarItem: HTMLElement, option: any, extendOption: any) => void;
     }
 
     interface Dropdown {
@@ -157,7 +157,7 @@ declare namespace jspreadsheet {
         /** Remote backend to respond to the search. */
         url?: string;
         /** When the user add a new item to the dropdown. */
-        oninsert?: Function;
+        oninsert?: (dropdownObject: object, itemInformation: object, itemObject: object) => void;
     }
 
     interface DropdownItem {
@@ -172,7 +172,7 @@ declare namespace jspreadsheet {
         /** Name of the group where the item belongs to */
         group?: string;
         /** Keywords to help finding one item */
-        synonym?: Array<string>;
+        synonym?: string[];
         /** Item is disabled */
         disabled?: boolean;
         /** Color for the item */
@@ -196,7 +196,7 @@ declare namespace jspreadsheet {
         shortcut?: string;
         /** Show this text when the user mouse over the element */
         tooltip?: string;
-        /** Subm menu */
+        /** Submenu */
         submenu?: Array<ContextmenuItem>;
     }
 
@@ -209,7 +209,7 @@ declare namespace jspreadsheet {
         /** Render type. Default: 'default' */
         type?: 'default' | 'year-month-picker';
         /** Disable the dates out of the defined range. */
-        validRange?: Array<number>;
+        validRange?: number[];
         /** The calendar starts in a day of week (0 for Sunday - 6 for Saturday). Default: 0 (Sunday) */
         format?: string;
         /** Calendar input is readonly */
@@ -241,7 +241,7 @@ declare namespace jspreadsheet {
         readonly: boolean;
         // Coordinate X
         x: number;
-        // Coordiname Y
+        // Coordinate Y
         y: number;
         // Associate to an array of values
         a?: any[][];
@@ -265,7 +265,7 @@ declare namespace jspreadsheet {
         /** Column alignment. Default: center */
         align?: 'center' | 'left' | 'right' | 'justify';
         /** It is a method to overwrite the column definitions in real-time just before the column edition. */
-        filterOptions?: Function;
+        filterOptions?: (worksheet: worksheetInstance, cell: HTMLElement, x: number, y: number, value: number|string, options: Column) => Column;
         /** Load the items from the dropdown from a remote URL. */
         url?: string;
         /** Define the items in the dropdown and autocomplete column type. */
@@ -285,7 +285,7 @@ declare namespace jspreadsheet {
         /** Disable the mask when editing. */
         disabledMaskOnEdition?: boolean;
         /** It defines a renderer method or rule for the cell content. */
-        render?: string | Function;
+        render?: string | ((td: HTMLElement, value: number|string, x: number, y: number, worksheet: worksheetInstance, options: Column) => void);
         /** Define the format of the date or numbers in the cell. Default for the calendar: DD/MM/YYYY */
         format?: string;
         /** Define the column as primaryKey. */
@@ -387,22 +387,22 @@ declare namespace jspreadsheet {
         /** Apply updates when the properties of a cell or column is changed. */
         updateProperty: (x: number, y: number, instance: object, options: object) => void;
         /** Transform the raw data into processed data. It will shown a text instead of an id in the type dropdown for example. */
-        get: (options: object, value: any) => String
+        get: (options: object, value: any) => string
     }
 
     interface Plugin {
         /** When a new worksheet is added. */
-        beforeinit?: (worksheet: Object) => void;
+        beforeinit?: (worksheet: worksheetInstance) => void;
         /** When a new worksheet is added. */
-        init?: (worksheet: Object) => void;
+        init?: (worksheet: worksheetInstance) => void;
         /** It would receive a call for every spreadsheet event. */
-        onevent?: (event: String, a?: any, b?: any, c?: any, d?: any) => void;
+        onevent?: (event: string, a?: any, b?: any, c?: any, d?: any) => void;
         /** When the spreadsheet needs to save something in the server. */
-        persistence?: (method: String, args: Object) => void;
+        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: worksheetInstance, 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;
+        toolbar?: (instance: worksheetInstance, toolbar: Toolbar) => void;
     }
 
     interface Nested {
@@ -478,7 +478,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>, result: Object) => 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. */
@@ -536,7 +536,7 @@ declare namespace jspreadsheet {
         /** When the footers are created or updated. */
         onchangefooter?: (worksheet: worksheetInstance, newValue: string, oldValue: string) => void;
         /** When the value in a cell footer is changed. */
-        onchangefootervalue?: (worksheet: worksheetInstance, x: number, y: number, value: String) => void;
+        onchangefootervalue?: (worksheet: worksheetInstance, x: number, y: number, value: string) => void;
         /** On change nested headers */
         onchangenested?: (worksheet: worksheetInstance, options: object) => void;
         /** On change nested cell properties */
@@ -556,7 +556,7 @@ declare namespace jspreadsheet {
         /** When pagination is enabled and the user changes the page. */
         onchangepage?: (worksheet: worksheetInstance, pageNumber: number, oldPageNumber: number, quantityPerPage: number) => void;
         /** Add or change the options of a new worksheet. */
-        onbeforecreateworksheet?: (worksheetOptions: Worksheet, options: object, position: number) => Object;
+        onbeforecreateworksheet?: (worksheetOptions: Worksheet, options: object, position: number) => object;
         /** When the user creates a new worksheet. */
         oncreateworksheet?: (worksheet: worksheetInstance, worksheetOptions: Worksheet, position: number) => void;
         /** When the user renames a worksheet. */
@@ -586,7 +586,7 @@ declare namespace jspreadsheet {
         /** When a new row is created */
         oncreaterow?: (worksheet: worksheetInstance, rowNumber: number, tr: HTMLElement) => void;
         /** When a new column is created */
-        oncreatecolumn?: (worksheet: worksheetInstance, columnNumber: number, td: HTMLElement, options: Object) => void;
+        oncreatecolumn?: (worksheet: worksheetInstance, columnNumber: number, td: HTMLElement, options: Column) => void;
         /** A way to change the formula in real-time before execution */
         onbeforeformula?: (worksheet: worksheetInstance, expression: string, x: number, y: number) => string | false | void;
         /** Get the information about the expressions executed from the formula chain */
@@ -618,11 +618,11 @@ declare namespace jspreadsheet {
         /** When close a row group */
         oncloserowgroup?: (worksheet: object, row: number) => void
         /** General event handler */
-        onevent?: (worksheet: Object, method: Object, a?: any, b?: any, c?: any, d?: any, e?: any, f?: any) => any
+        onevent?: (worksheet: worksheetInstance, method: string, a?: any, b?: any, c?: any, d?: any, e?: any, f?: any) => any
         /** 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;
+        updateTable?: (worksheet: worksheetInstance, cell: HTMLElement, x: number, y: number, value: string) => void;
         /** Return false to cancel the contextMenu event, or return custom elements for the contextmenu. */
-        contextMenu?: Contextmenu;
+        contextMenu?: Contextmenu | null;
         /** The first row is the header titles when parsing a HTML table */
         parseTableFirstRowAsHeader?: boolean;
         /** Try to identify a column type when parsing a HTML table */
@@ -632,7 +632,7 @@ declare namespace jspreadsheet {
         /** About information */
         about?: string | Function,
         /** License string */
-        license?: string;
+        license?: string | null;
         /** Worksheets */
         worksheets?: Array<Worksheet>;
         /** Validations */
@@ -790,7 +790,7 @@ declare namespace jspreadsheet {
         /** Create a new worksheet from the given settings */
         createWorksheet: (options: Worksheet) => worksheetInstance;
         /** Delete an existing worksheet by its position */
-        deleteWorksheet: (position: Number) => void;
+        deleteWorksheet: (position: number) => void;
         /** DOM Element */
         el: HTMLElement;
         /** DOM Element. Alias for el */
@@ -807,8 +807,8 @@ declare namespace jspreadsheet {
         showToolbar: () => void;
         /** Hide the toolbar */
         hideToolbar: () => void;
-        /** Get the worksheet by its id */
-        getWorksheet: (id: String) => number;
+        /** Get the worksheet index by instance or worksheet instance by index */
+        getWorksheet: (worksheetIdent: worksheetInstance | number) => number | string;
         /** Get the active worksheet when applicable */
         getWorksheetActive: () => number;
         /** Get the worksheet instance by its position */
@@ -830,7 +830,7 @@ declare namespace jspreadsheet {
         /** HTMLElement loading element */
         loading: HTMLElement;
         /** Rename an existing worksheet by its position */
-        renameWorksheet: (position: number, title: String) => void;
+        renameWorksheet: (position: number, title: string) => void;
         /** Move the position of a worksheet */
         updateWorksheet: (from: number, to: number) => void;
         /** Move the position of a worksheet. DOM Only (Internal method) - Please use updateWorksheet */
@@ -894,15 +894,8 @@ declare namespace jspreadsheet {
         cursor: object;
         /** Cut */
         cut: () => void;
-        /**
-         * Get the worksheet data
-         *
-         * @param {boolean} only the selected cells
-         * @param {boolean} get the raw or processed data
-         * @param {string} Null the return will be an array. With this argument, the return will be a string separated by the character defined.
-         * @return {array} array of data
-         */
-        data: (highlighted?: boolean, processedData?: boolean, delimiter?: string) => Array<Array<any>> | string
+        /** Alias to getData */
+        data: (highlighted?: boolean, processed?: boolean, delimiter?: string, asJson?: boolean) => Array<Array<any>> | Array<Record<string, any>> | string | null;
         /** Internal use control type to defined JSON (1) or ARRAY (0). */
         dataType: number,
         /** Delete an existing column */
@@ -944,7 +937,7 @@ declare namespace jspreadsheet {
         /** Get attributes from one cell when applicable */
         getCells: (cellName: string) => Column;
         /** Get the column object by its position */
-        getColumn: (position: number) => Object;
+        getColumn: (position: number) => Column;
         /** Get the column data from its number */
         getColumnData: (col: number, processed?: boolean) => Array<any>;
         /** Get the column position by its name */
@@ -968,7 +961,7 @@ declare namespace jspreadsheet {
         /** Get the defined name or all defined names when key is null */
         getDefinedNames: (key?: string) => object;
         /** Internal method: Get the editor for one cell */
-        getEditor: (x: number, y: number) => Object;
+        getEditor: (x: number, y: number) => Column;
         /** Internal method: Get the filter */
         getFilter: (column: number) => Array<any>;
         /** Get the footers configuration */
@@ -990,11 +983,11 @@ declare namespace jspreadsheet {
         /** Aliases for getLabel */
         getLabelFromCoords: (cellNameOrColumnNumber: string|number, y?: number, extended?: boolean) => string;
         /** Get the merged cells. Cell name: A1, A2, etc or null for all cells */
-        getMerge: (cellName?: string) => Object | Array<number>;
+        getMerge: (cellName?: string) => object | Array<number>;
         /** Get one or all meta information for one cell. */
-        getMeta: (cellName: string, property: string) => Object;
+        getMeta: (cellName: string, property: string) => object;
         /** Get the nested cells */
-        getNestedCell: (x: number, y: number, properties?: any) => Object;
+        getNestedCell: (x: number, y: number, properties?: any) => object;
         /** Get the nested headers */
         getNestedHeaders: () => [];
         /** Get the next available number in the sequence */
@@ -1012,7 +1005,7 @@ declare namespace jspreadsheet {
         /** Get the selection in a range format */
         getRange: () => string;
         /** Get a row data or meta information by Id. */
-        getRowById: (row: number, element: boolean) => Object;
+        getRowById: (row: number, element: boolean) => Row;
         /** Get the data from one row */
         getRowData: (row: number, processed: boolean) => any[];
         /** Get the row id from its position */
@@ -1027,10 +1020,10 @@ declare namespace jspreadsheet {
         getSelectedColumns: () => number[];
         /** Get the selected rows. DOMElements or Indexes */
         getSelectedRows: (indexes?: boolean) => HTMLElement[] | number[];
-        /** Get the style from one cell. Ex. getStyle('A1') */
-        getStyle: (cell: string) => Object;
+        /** Get the style from a cell or all cells. getStyle() or getStyle('A1') */
+        getStyle: (cellName?: string|null) => string|object;
         /** Get value by the cell name or object. The value can be the raw or processed value. */
-        getValue: (cell: string, processed: boolean) => String;
+        getValue: (cell: string, processed: boolean) => string;
         /** Get value by the coordinates. The value can be the raw or processed value. */
         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. */
@@ -1052,15 +1045,15 @@ declare namespace jspreadsheet {
         /** Hide the search container */
         hideSearch: () => void;
         /** Add a new column */
-        insertColumn: (numOfColumnsOrData?: number|any[], columnNumber?: number, insertBefore?: boolean, properties?: Column, data?: any[], extraInformationFromEvents?: object, event?: object) => void;
+        insertColumn: (numOfColOrData?: number | any[], columnNumber?: number, insertBefore?: boolean, properties?: Column, data?: any[] | any[][] | null, extraInformationFromEvents?: object, mouseEvent?: object) => void;
         /** Add a new row */
-        insertRow: (numOfRows: number, rowNumber: number, insertBefore: boolean, data: any[]) => void;
+        insertRow: (numOfRowsOrData?: number | any[], rowNumber?: number, insertBefore?: boolean, data?: any[] | any[][] | null, mouseEvent?: object) => void;
         /** Check if cell is attached to the DOM */
         isAttached: (x: number, y: number) => boolean;
         /** The worksheet is editable */
         isEditable: () => boolean;
         /** Check if cell is readonly or not. State used to set the state */
-        isReadOnly: (cell: Object, state?: boolean) => boolean;
+        isReadOnly: (cellName: string, state?: boolean) => boolean;
         /** Verify if this coordinates is within a selection or blank for the current selection */
         isSelected: (x: number, y: number, selection?: number[]) => boolean;
         /** Navigation last */
@@ -1076,7 +1069,7 @@ declare namespace jspreadsheet {
         /** Get the column name */
         name: (col: number) => string;
         /** Start the edition for one cell */
-        openEditor: (cell: HTMLElement, empty?: boolean, mouseEvent?: Object) => void;
+        openEditor: (cell: HTMLElement, empty?: boolean, mouseEvent?: object) => void;
         /** Open the filters */
         openFilter: (column: number) => void;
         /** Worksheet configuration */
@@ -1088,7 +1081,7 @@ declare namespace jspreadsheet {
         /** Current page number */
         pageNumber: number;
         /** Pagination DOM container */
-        pagination: Object;
+        pagination: HTMLElement;
         /** Spreadsheet object */
         parent: spreadsheetInstance;
         /** Paste */
@@ -1104,9 +1097,9 @@ declare namespace jspreadsheet {
         /** Refresh footers */
         refreshFooter: () => void;
         /** Remove the merged cells by the cell name or a object with all cells to be removed. */
-        removeMerge: (cellName: String | Object) => void;
+        removeMerge: (cellName: string | object) => void;
         /** Reset the borders by name border name */
-        resetBorders: (border: String, resetPosition: boolean) => void;
+        resetBorders: (border: string, resetPosition: boolean) => void;
         /** Reset the filter of one or all columns */
         resetFilters: (colNumber?: number) => void;
         /** Destroy the footers */
@@ -1122,7 +1115,7 @@ declare namespace jspreadsheet {
         /** Reset the main selection */
         resetSelection: () => void;
         /** Get the style from one cell. Ex. resetStyle('A1') */
-        resetStyle: (cell?: String) => void;
+        resetStyle: (cell?: string) => void;
         /** DOM array of results */
         results: Array<number> | null;
         /** Navigation right */
@@ -1130,15 +1123,15 @@ declare namespace jspreadsheet {
         /** Rotate the spreadsheet cell text. cell = A1, B1... etc */
         rotate: (cell: string|string[], value:number) => void;
         /** Array of row objects */
-        rows: RowInstance[];
+        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;
+        save: (url: string, data: object, token?: string, callback?: (result: object) => void) => void;
         /** ScrollX DOM Element */
         scrollX: HTMLElement;
         /** ScrollY DOM Element */
         scrollY: HTMLElement;
         /** Search for something */
-        search: (str: String) => void;
+        search: (str: string) => void;
         /** Search HTML container */
         searchContainer: HTMLElement;
         /** Search HTML input */
@@ -1156,7 +1149,7 @@ declare namespace jspreadsheet {
         /** Set the column data from its number */
         setColumnData: (col: number, data: any[], force?: boolean) => void;
         /** Set the comments for one cell */
-        setComments: (cellName: String, comments: String) => void;
+        setComments: (cellName: string, comments: string) => void;
         /** Change the worksheet settings */
         setConfig: (config: Worksheet) => void;
         /** Set the worksheet data */
@@ -1172,11 +1165,11 @@ declare namespace jspreadsheet {
         /** Freeze x number of columns */
         setFreezeColumns: (num: number) => void;
         /** Set the header title. Empty or null to reset to the default header value. */
-        setHeader: (x: number, title?: String) => void;
+        setHeader: (x: number, title?: string) => void;
         /** 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 */
-        setMerge: (cellName: String | Object, colspan?: number, rowspan?: number) => void;
+        setMerge: (cellName: string | object, colspan?: number, rowspan?: number) => void;
         /** Get one or various meta information for one cell. */
         setMeta: (cell: string | object, property?: string, value?: string) => void;
         /** Set the nested headers */
@@ -1186,7 +1179,7 @@ declare namespace jspreadsheet {
         /** Set the properties for a column or cell */
         setProperties: (columnNumber: number, rowNumberOrColumnSettings: number|Column, settings?: Column) => void;
         /** Set or reset the cell as readonly */
-        setReadOnly: (cell: Object, state: boolean) => void;
+        setReadOnly: (cellName: string, state: boolean) => void;
         /** Set the data from one row */
         setRowData: (row: number, data: any[], force: boolean) => void;
         /** Set the row id from its position */
@@ -1247,7 +1240,7 @@ declare namespace jspreadsheet {
          */
         updateCell: (x: number, y: number, value: string, force?: boolean) => void;
         /** Internal method: update cells in a batch */
-        updateCells: (o: Object) => void;
+        updateCells: (o: Array<Record<string, object>>) => void;
         /** Update the selection based on two DOM cell selements */
         updateSelection: (el1: number, el2: number, origin: boolean) => void;
         /** Update the selection based on coordinates */
@@ -1312,6 +1305,18 @@ declare namespace jspreadsheet {
         updateMerge: (cellName: string, colspan: number, rowspan: number) => void;
         /** Get the worksheet name */
         getWorksheetName: () => string;
+        /** Rename an existing worksheet by its position */
+        renameWorksheet: (position: number, title: string) => void;
+        /** Open this worksheet */
+        openWorksheet: () => void;
+        /** Move the position of a worksheet. DOM Only (Internal method) - Please use updateWorksheet */
+        moveWorksheet: (from: number, to: number) => void;
+        /** Get the worksheet index by instance or worksheet instance by index */
+        getWorksheet: (worksheetIdent: worksheetInstance | number) => number | string;
+        /** Get the active worksheet when applicable */
+        getWorksheetActive: () => number;
+        /** Delete an existing worksheet by its position */
+        deleteWorksheet: (position: number) => void;
     }
 }