jspreadsheet - npm Package Compare versions

Comparing version 8.0.21 to 8.0.22

dist/index.d.ts

@@ -224,117 +224,117 @@ /**
         /** This method is called when the data in the spreadsheet is ready. */
-        onload?: (worksheet: Object, instance: Object) => void;
+        onload?: (spreadsheet: spreadsheetInstance) => void;
         /** Spreadsheet is clicked **/
-        onclick?: (worksheet: Object, section: String, x: Number, y: Number) => void;
+        onclick?: (worksheet: worksheetInstance, section: String, x: Number, y: Number) => void;
         /** When undo is applied */
-        onundo?: (worksheet: Object, historyRecord: Object) => void;
+        onundo?: (worksheet: worksheetInstance, historyRecord: Object) => void;
         /** When redo is applied */
-        onredo?: (worksheet: Object, historyRecord: Object) => void;
+        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?: (worksheet: Object, instance: Object, data: []) => Boolean | [];
+        onbeforesave?: (worksheet: worksheetInstance, instance: Object, data: []) => Boolean | [];
         /** After something is saved */
-        onsave?: (worksheet: Object, instance: Object, data: []) => void;
+        onsave?: (worksheet: worksheetInstance, instance: Object, data: []) => 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: Object, cell: Element, x: Number, y: Number, value: String) => String;
+        onbeforechange?: (worksheet: worksheetInstance, cell: Element, x: Number, y: Number, value: String) => String;
         /** After a column value is changed. */
-        onchange?: (worksheet: Object, cell: HTMLElement, x: Number, y: Number, newValue: String, oldValue: String) => void;
+        onchange?: (worksheet: worksheetInstance, cell: HTMLElement, x: Number, y: Number, newValue: String, oldValue: String) => void;
         /** Event: onafterchanges(jspreadsheetHTMLElement, jspreadsheetInstance) */
-        onafterchanges?: (worksheet: Object, record: Array<any>) => void;
+        onafterchanges?: (worksheet: worksheetInstance, records: Array<any>) => void;
         /** When a copy is performed in the spreadsheet. Any string returned will overwrite the user data or return null to progress with the default behavior. */
-        oncopy?: (worksheet: Object, selectedCells: [], data: String) => String;
+        oncopy?: (worksheet: worksheetInstance, selectedCells: [], data: String) => String;
         /** Before the paste action is performed. Can return parsed or filtered data, can cancel the action when return false. */
-        onbeforepaste?: (worksheet: Object, data: String, x: Number, y: Number) => [];
+        onbeforepaste?: (worksheet: worksheetInstance, data: String, x: Number, y: Number) => [];
         /** After a paste action is performed in the spreadsheet. */
-        onpaste?: (worksheet: Object, data: []) => void;
+        onpaste?: (worksheet: worksheetInstance, data: []) => void;
         /** Before a new row is inserted. You can cancel the insert event by returning false. */
-        onbeforeinsertrow?: (worksheet: Object, rowNumber: Number, numOfRows: Number, insertBefore: Boolean) => Boolean | undefined;
+        onbeforeinsertrow?: (worksheet: worksheetInstance, rowNumber: Number, numOfRows: Number, insertBefore: Boolean) => Boolean | undefined;
         /** After a new row is inserted. */
-        oninsertrow?: (worksheet: Object, rowNumber: Number, numOfRows: Number, insertBefore: Boolean) => void;
+        oninsertrow?: (worksheet: worksheetInstance, rowNumber: Number, numOfRows: Number, insertBefore: Boolean) => void;
         /** Before a row is deleted. You can cancel the delete event by returning false. */
-        onbeforedeleterow?: (worksheet: Object, rowNumber: Number, numOfRows: Number) => Boolean | undefined;
+        onbeforedeleterow?: (worksheet: worksheetInstance, rowNumber: Number, numOfRows: Number) => Boolean | undefined;
         /** After a row is excluded. */
-        ondeleterow?: (worksheet: Object, rowNumber: Number, numOfRows: Number, rowHTMLElements: [], rowData: [], cellAttributes: []) => void;
+        ondeleterow?: (worksheet: worksheetInstance, rowNumber: Number, numOfRows: Number, rowHTMLElements: [], rowData: [], cellAttributes: []) => void;
         /** Before a new column is inserted. You can cancel the insert event by returning false. */
-        onbeforeinsertcolumn?: (worksheet: Object, columnNumber: Number, numOfColumns: Number, insertBefore: Boolean) => Boolean | undefined;
+        onbeforeinsertcolumn?: (worksheet: worksheetInstance, columnNumber: Number, numOfColumns: Number, insertBefore: Boolean) => Boolean | undefined;
         /** After a new column is inserted. */
-        oninsertcolumn?: (worksheet: Object, columnNumber: Number, numOfColumns: Number, historyRecords: [], insertBefore: Boolean) => void;
+        oninsertcolumn?: (worksheet: worksheetInstance, columnNumber: Number, numOfColumns: Number, historyRecords: [], insertBefore: Boolean) => void;
         /** Before a column is excluded. You can cancel the insert event by returning false. */
-        onbeforedeletecolumn?: (worksheet: Object, columnNumber: Number, numOfColumns: Number) => Boolean | undefined;
+        onbeforedeletecolumn?: (worksheet: worksheetInstance, columnNumber: Number, numOfColumns: Number) => Boolean | undefined;
         /** After a column is excluded. */
-        ondeletecolumn?: (worksheet: Object, columnNumber: Number, numOfColumns: Number, affectedHTMLElements: [], historyProperties: [], cellAttributes: []) => void;
+        ondeletecolumn?: (worksheet: worksheetInstance, columnNumber: Number, numOfColumns: Number, affectedHTMLElements: [], historyProperties: [], cellAttributes: []) => void;
         /** After a row is moved to a new position. */
-        onmoverow?: (worksheet: Object, origin: Number, destination: Number) => void;
+        onmoverow?: (worksheet: worksheetInstance, origin: Number, destination: Number) => void;
         /** After a column is moved to a new position. */
-        onmovecolumn?: (worksheet: Object, origin: Number, destination: Number) =>  void;
+        onmovecolumn?: (worksheet: worksheetInstance, origin: Number, destination: Number) =>  void;
         /** After a height change for one or more rows. */
-        onresizerow?: (worksheet: Object, row: Number | [], height: Number | [], oldHeight: Number | []) => void;
+        onresizerow?: (worksheet: worksheetInstance, row: Number | [], height: Number | [], oldHeight: Number | []) => void;
         /** After a column width change for one or more columns. */
-        onresizecolumn?: (worksheet: Object, column: Number | [], width: Number | [], oldWidth: Number | []) => void;
+        onresizecolumn?: (worksheet: worksheetInstance, column: Number | [], width: Number | [], oldWidth: Number | []) => void;
         /** When the selection is changed. */
-        onselection?: (worksheet: Object, px: Number, py: Number, ux: Number, uy: Number, origin: Number) => void;
+        onselection?: (worksheet: worksheetInstance, px: Number, py: Number, ux: Number, uy: Number, origin: Number) => void;
         /** Before a new comment is added or updated. Return false to cancel the event. */
-        onbeforecomments?: (worksheet: Object, cells: Object) => Boolean | undefined;
+        onbeforecomments?: (worksheet: worksheetInstance, cells: Object) => Boolean | undefined;
         /** After a new comment is added or updated. */
-        oncomments?: (worksheet: Object, cells: Object) => void;
+        oncomments?: (worksheet: worksheetInstance, cells: Object) => void;
         /** It runs before sorting a column. It should return an array with a custom sorting or false to cancel the user action. */
-        onbeforesort?: (worksheet: Object, column: Number, direction: Number, newOrderValues: []) => Boolean | [] | undefined;
+        onbeforesort?: (worksheet: worksheetInstance, column: Number, direction: Number, newOrderValues: []) => Boolean | [] | undefined;
         /** When a column is sorted. */
-        onsort?: (worksheet: Object, column: Number, direction: Number, newOrderValues: []) => void;
+        onsort?: (worksheet: worksheetInstance, column: Number, direction: Number, newOrderValues: []) => void;
         /** When the spreadsheed gets the focus. */
-        onfocus?: (worksheet: Object) => void;
+        onfocus?: (worksheet: worksheetInstance) => void;
         /** When the spreadsheet loses the focus. */
-        onblur?: (worksheet: Object) => void;
+        onblur?: (worksheet: worksheetInstance) => void;
         /** When merge cells is executed. */
-        onmerge?: (worksheet: Object, cellName: String, colspan: Number, rowspan: Number) => void;
+        onmerge?: (worksheet: worksheetInstance, cellName: String, colspan: Number, rowspan: Number) => void;
         /** When the header title is changed. */
-        onchangeheader?: (worksheet: Object, column: Number, newValue: String, oldValue: String) => void;
+        onchangeheader?: (worksheet: worksheetInstance, column: Number, newValue: String, oldValue: String) => void;
         /** When the footers are created or updated. */
-        onchangefooter?: (worksheet: Object, column: Number, newValue: String, oldValue: String) => void;
+        onchangefooter?: (worksheet: worksheetInstance, column: Number, newValue: String, oldValue: String) => void;
         /** When the value in a cell footer is changed. */
-        onchangefootervalue?: (worksheet: Object, x: Number, y: Number, value: String) => void;
+        onchangefootervalue?: (worksheet: worksheetInstance, x: Number, y: Number, value: String) => void;
         /** When an editor is created. */
-        oncreateeditor?: (worksheet: Object, cell: HTMLElement, x: Number, y: Number, element: HTMLElement, options: Object) => void;
+        oncreateeditor?: (worksheet: worksheetInstance, cell: HTMLElement, x: Number, y: Number, element: HTMLElement, options: Object) => void;
         /** When the editor is opened. **/
-        oneditionstart?: (worksheet: Object, cell: HTMLElement, x: Number, y: Number) => void;
+        oneditionstart?: (worksheet: worksheetInstance, cell: HTMLElement, x: Number, y: Number) => void;
         /** When the editor is closed. **/
-        oneditionend?: (worksheet: Object, cell: HTMLElement, x: Number, y: Number, newValue: [], save: Boolean) => void;
+        oneditionend?: (worksheet: worksheetInstance, cell: HTMLElement, x: Number, y: Number, newValue: [], save: Boolean) => void;
         /** When the style of a cell is changed. */
-        onchangestyle?: (worksheet: Object, mixed: [], key: String, value: String) => void;
+        onchangestyle?: (worksheet: worksheetInstance, mixed: [], key: String, value: String) => void;
         /** When a cell meta information is added or updated. */
-        onchangemeta?: (worksheet: Object, mixed: [], key: String, value: String) => void;
+        onchangemeta?: (worksheet: worksheetInstance, mixed: [], key: String, value: String) => void;
         /** Before the page is changed. Can cancel the action when return is false. */
-        onbeforechangepage?: (worksheet: Object, pageNumber: Number, oldPage: Number, quantityPerPage: Number) => Boolean | undefined;
+        onbeforechangepage?: (worksheet: worksheetInstance, pageNumber: Number, oldPage: Number, quantityPerPage: Number) => Boolean | undefined;
         /** When pagination is enabled and the user changes the page. */
-        onchangepage?: (worksheet: Object, pageNumber: Number, oldPageNumber: Number) => void;
+        onchangepage?: (worksheet: worksheetInstance, pageNumber: Number, oldPageNumber: Number) => void;
         /** Add or change the options of a new worksheet. */
-        onbeforecreateworksheet?: (worksheet: Worksheet, options: Object) => Object;
+        onbeforecreateworksheet?: (worksheet: Worksheet, index: Number) => Object;
         /** When the user creates a new worksheet. */
-        oncreateworksheet?: (worksheet: Object, options: Object) => void;
+        oncreateworksheet?: (worksheet: worksheetInstance, options: Worksheet, index: Number) => void;
         /** When the user renames a worksheet. */
-        onrenameworksheet?: (worksheet: Object, worksheetNumber: Number) => void;
+        onrenameworksheet?: (worksheet: worksheetInstance, worksheetNumber: Number, newValue: String, oldValue: String) => void;
         /** >When the user deletes a worksheet. */
-        ondeleteworksheet?: (worksheet: Object, worksheetNumber: Number) => void;
+        ondeleteworksheet?: (worksheet: worksheetInstance, worksheetNumber: Number) => void;
         /** When the user updates the worksheet tab position. */
-        onmoveworksheet?: (worksheet: Object, from: Number, to: Number) => void;
+        onmoveworksheet?: (worksheet: worksheetInstance, from: Number, to: Number) => void;
         /** When the user opens a worksheet. */
-        onopenworksheet?: (worksheet: Object, index: Number) => void;
+        onopenworksheet?: (worksheet: worksheetInstance, index: Number) => void;
         /** When there is a row id update */
-        onchangerowid?: (worksheet: Object, instance: Object, rows: []) => void;
+        onchangerowid?: (worksheet: worksheetInstance, rows: []) => void;
         /** Action to be executed before searching. The accepted method return would be: null to continue with the default behavior, false to cancel the user action or an array with the row numbers to overwrite the default result. */
-        onbeforesearch?: (worksheet: Object, query: String, results: []) => [];
+        onbeforesearch?: (worksheet: worksheetInstance, query: String, results: []) => [];
         /** After the search is applied to the rows. */
-        onsearch?: (worksheet: Object, query: String, results: []) => void;
+        onsearch?: (worksheet: worksheetInstance, query: String, results: []) => void;
         /** Action to be executed before filtering rows. It can cancel the action by returning false. */
-        onbeforefilter?: (worksheet: Object, filters: [], data: []) => void;
+        onbeforefilter?: (worksheet: worksheetInstance, filters: [], data: []) => void;
         /** After the filter has been applied to the rows. */
-        onfilter?: (worksheet: Object, filters: [], data: []) => void;
+        onfilter?: (worksheet: worksheetInstance, filters: [], data: []) => void;
         /** When a new cell is created **/
-        oncreatecell?: (worksheet: Object, cell: HTMLElement, x: Number, y: Number, value: any) => void;
+        oncreatecell?: (worksheet: worksheetInstance, cell: HTMLElement, x: Number, y: Number, value: any) => void;
         /** Run every single table update action. Can bring performance issues if perform too much changes. */
-        updateTable?: (worksheet: Object, cell: Object, x: Number, y: Number, value: String) => void;
+        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. */
-        contextmenu?: (worksheet: Object, x: Number, y: Number, e: Event, section: String, section_argument1: String | Number, section_argument2: String | Number) => [];
+        contextmenu?: (worksheet: worksheetInstance, x: Number, y: Number, e: Event, section: String, section_argument1: String | Number, section_argument2: String | Number) => [];
         /** The first row is the header titles when parsing a HTML table */
-        parseTableFirstRowAsHeader?: Boolean,
+        parseTableFirstRowAsHeader?: boolean,
         /** Try to identify a column type when parsing a HTML table */
-        parseTableAutoCellType?: Boolean,
+        parseTableAutoCellType?: boolean,
         /** Global cell wrapping. Default: false */
@@ -463,3 +463,3 @@ wordWrap?: boolean;
 
-    interface SpreadsheetInstance {
+    interface spreadsheetInstance {
         /** Spreadsheet configuration */
@@ -545,3 +545,3 @@ config?: Spreadsheet;
         /** Spreadsheet object */
-        parent?: SpreadsheetInstance;
+        parent?: spreadsheetInstance;
         /** Array with the borders information */
@@ -883,2 +883,4 @@ borders?: [];
         updateCell?: (x: Number, y: Number, value: String, force: Boolean) => void;
+        /** Set viewport width and height */
+        setViewport?: (width: Number, height: Number) => void;
     }
@@ -885,0 +887,0 @@ }

package.json

@@ -27,3 +27,3 @@ {
     "types": "dist/index.d.ts",
-    "version": "8.0.21"
+    "version": "8.0.22"
 }

No alert changes

Improved metrics

Total package byte prevSize

353218

increased by0.61%

Lines of code

2119

increased by0.05%

No dependency changes