@progress/kendo-spreadsheet-common 1.0.0-develop.8 → 1.0.0

package/dist/index-esm.js

@@ -949,6 +949,7 @@ const messages = {};
 messages.view = {
     nameBox: "Name Box",
     errors: {
+        modifyMerged: "Cannot change part of a merged cell.",
         openUnsupported: "Unsupported format. Please select an .xlsx file.",
         shiftingNonblankCells: "Cannot insert cells due to data loss possibility. Select another insert location or delete the data from the end of your worksheet.",
         insertColumnWhenRowIsSelected: "Cannot insert column when all columns are selected.",
@@ -3060,6 +3061,18 @@ function parseDate(str, format) {
         ]);
 }
 
+function defineAlias(alias, name) {
+    var orig = FUNCS[name];
+    if (!orig) {
+        throw new Error("Function " + name + " is not yet defined");
+    }
+    if (!orig.kendoSpreadsheetAliases) {
+        orig.kendoSpreadsheetAliases = [ name ];
+    }
+    orig.kendoSpreadsheetAliases.push(alias);
+    FUNCS[alias] = orig;
+}
+
 /* -----[ exports ]----- */
 
 calc.runtime.CalcError = CalcError;
@@ -3078,24 +3091,8 @@ calc.runtime.isLeapYear = isLeapYear;
 calc.runtime.daysInYear = daysInYear;
 calc.runtime.parseDate = parseDate;
 calc.runtime.limitPrecision = limitPrecision;
-
-// spreadsheet.dateToNumber = dateToSerial;
-// spreadsheet.numberToDate = serialToDate;
-// spreadsheet.defineFunction = defineFunction;
-// spreadsheet.CalcError = CalcError;
-
 calc.runtime.defineFunction = defineFunction;
-calc.runtime.defineAlias = function(alias, name) {
-    var orig = FUNCS[name];
-    if (!orig) {
-        throw new Error("Function " + name + " is not yet defined");
-    }
-    if (!orig.kendoSpreadsheetAliases) {
-        orig.kendoSpreadsheetAliases = [ name ];
-    }
-    orig.kendoSpreadsheetAliases.push(alias);
-    FUNCS[alias] = orig;
-};
+calc.runtime.defineAlias = defineAlias;
 
 /* -----[ Excel operators ]----- */
 
@@ -10801,13 +10798,13 @@ class Controller {
                 this.editor.deactivate(true); // make sure we don't call any change hooks
                 this.view.showError(result, function() {
                     // we only get here in case of a validation error when the user decided to retry.
-                    this.activateEditor(false);
+                    // this.activateEditor(false);
                     // reset to last input from user
-                    this.editor.value(this._lastEditorValue);
+                    // this.editor.value(this._lastEditorValue);
                     // however, set _value manually such that it'll detect change properly.  ugly :-\
-                    this.editor._value = this._workbook._inputForRef(this._workbook.activeSheet()._viewActiveCell());
+                    // this.editor._value = this._workbook._inputForRef(this._workbook.activeSheet()._viewActiveCell());
                     // seems like a nice UX to have the whole input selected
-                    this.editor.select();
+                    // this.editor.select();
                 }.bind(this));
             } else {
                 this.view.openDialog(result.reason);
@@ -21933,7 +21930,7 @@ class FormulaInput extends Widget {
             return;
         }
 
-        const data = this.formulaSource.filter((item) => String(item.value).startsWith(value.toLowerCase()));
+        const data = this.formulaSource.filter((item) => String(item.value).toLowerCase().startsWith(value.toLowerCase()));
 
         this.list.data(data);
 
@@ -22604,7 +22601,7 @@ class View extends Observable {
             messages: messages.view
         }, this.options, options);
 
-        this.events = ['update'];
+        this.events = ['update', 'message'];
 
         this._chrome();
 
@@ -23021,7 +23018,7 @@ class View extends Observable {
 
     selectClipboardContents() {
         if (!this.isClipboardDeactivated) {
-            this.clipboard.focus();
+            this.clipboard.focus({ preventScroll: true });
             selectElementContents(this.clipboard);
         }
     }
@@ -23087,81 +23084,41 @@ class View extends Observable {
         });
     }
 
-    openDialog() { // openDialog(name, options) {
-        // let sheet = this._sheet;
-        // return sheet.withCultureDecimals(function() {
-        //     let dialog = kendo.spreadsheet.dialogs.create(name, options);
-
-        //     if (dialog) {
-        //         dialog.bind("action", this._executeCommand.bind(this));
-        //         dialog.bind("deactivate", this._destroyDialog.bind(this));
-        //         this._dialogs.push(dialog);
-
-        //         let ref = sheet.activeCell();
-        //         let range = new kendo.spreadsheet.Range(ref, sheet);
-
-        //         dialog.open(range);
-        //         return dialog;
-        //     }
-        // }.bind(this));
+    openDialog(name, options) {
+        let sheet = this._sheet;
+        return sheet.withCultureDecimals(function() {
+            let ref = sheet.activeCell();
+            let range = new Range$1(ref, sheet);
+            this.trigger('message', { ...options, name, ref, range });
+        }.bind(this));
     }
 
-    showError() { // showError(options, reopenEditor) {
-        // let currentDialogs = this._dialogs;
-        // let errorMessages = this.options.messages.errors;
-        // let hasOpenedError = false;
+    showError(options, reopenEditor) {
+        let currentDialogs = this._dialogs;
+        let errorMessages = this.options.messages.errors;
 
-        // if (currentDialogs.length > 0) {
-        //     currentDialogs.forEach(function(dialog) {
-        //         if (dialog.options && dialog.options.title === ERROR) {
-        //             hasOpenedError = true;
-        //         }
-        //     });
-        // }
-        // if (hasOpenedError) {
-        //     return;
-        // }
+        if (currentDialogs.length > 0) {
+            return;
+        }
 
-        // let focusButton = function(e) {
-        //     let cont = e.sender.dialog().element;
-        //     cont.find(".k-button").first().trigger("focus");
-        //     cont.find(".k-button, input").on("keydown", function(ev) {
-        //         if (ev.keyCode === kendo.keys.ESC) {
-        //             e.sender.close();
-        //         }
-        //     });
-        // };
+        let onClose = function() {
+            currentDialogs.pop();
+            // let dlg = e.sender;
+            this.selectClipboardContents();
+            if (reopenEditor) { // dlg._retry &&
+                reopenEditor();
+            }
+        }.bind(this);
 
-        // let onClose = function(e) {
-        //     let dlg = e.sender;
-        //     this.selectClipboardContents();
-        //     if (dlg._retry && reopenEditor) {
-        //         reopenEditor();
-        //     }
-        // }.bind(this);
-
-        // if (kendo.spreadsheet.dialogs.registered(options.type)) {
-        //     let dialogOptions = {
-        //         close: onClose
-        //     };
-
-        //     if (options.type === "validationError") {
-        //         dialogOptions = $.extend(dialogOptions, {
-        //             title: options.title || "Error",
-        //             text: options.body ? options.body : errorMessages[options.type],
-        //             activate: focusButton
-        //         });
-        //     }
+        const dialogOptions = {
+            title: options.title || "Error",
+            text: options.body ? options.body : errorMessages[options.type],
+            close: onClose
+        };
 
-        //     this.openDialog(options.type, dialogOptions);
-        // } else {
-        //     this.openDialog("message", {
-        //         title : options.title || "Error",
-        //         text  : options.body ? options.body : errorMessages[options.type],
-        //         activate: focusButton,
-        //         close: onClose
-        //     });
-        // }
+        currentDialogs.push(dialogOptions);
+
+        this.openDialog(options.type || "message", dialogOptions);
     }
 
     destroy() {
@@ -23998,6 +23955,16 @@ class PropertyChangeCommand extends Command {
     }
 }
 
+class PropertyCleanCommand extends PropertyChangeCommand {
+    exec() {
+        let range = this.range();
+        if (range.enable()) {
+            this.getState();
+            range.clearFormat();
+        }
+    }
+}
+
 class ClearContentCommand extends Command {
     exec() {
         let values = [], range, rowValues, nullValues, validationState, currentRange;
@@ -24993,14 +24960,14 @@ class OpenCommand extends Command {
         }
 
         let workbook = this.options.workbook;
-        workbook.fromFile(this.options.file).then(function(){
-            let errors = workbook.excelImportErrors;
-            if (errors && errors.length) {
-                workbook._view.openDialog("importError", {
-                    errors: errors
-                });
-            }
-        });
+        workbook.fromFile(this.options.file);
+
+        let errors = workbook.excelImportErrors;
+        if (errors && errors.length) {
+            workbook._view.openDialog("importError", {
+                errors: errors
+            });
+        }
     }
 }
 
@@ -25099,6 +25066,7 @@ var commands = /*#__PURE__*/Object.freeze({
     OpenCommand: OpenCommand,
     PasteCommand: PasteCommand,
     PropertyChangeCommand: PropertyChangeCommand,
+    PropertyCleanCommand: PropertyCleanCommand,
     ReorderDrawingsCommand: ReorderDrawingsCommand,
     RowHeightCommand: RowHeightCommand,
     SaveAsCommand: SaveAsCommand,
@@ -27744,7 +27712,7 @@ const events = [
     "dataBound"
 ];
 
-class Spreadsheet extends Widget {
+class SpreadsheetWidget extends Widget {
     constructor(element, options$1) {
         super(element, deepExtend({}, options, options$1));
         this.events = events;
@@ -28225,4 +28193,4 @@ class Spreadsheet extends Widget {
     }
 }
 
-export { Range$1 as Range, Sheet, Spreadsheet, View, Workbook };
+export { CalcError, CellRef, Context, Matrix, NULLREF, NameRef, Range$1 as Range, RangeRef, Ref, Sheet, SpreadsheetWidget, UnionRef, View, Workbook, dateToSerial, defineAlias, defineFunction, packDate, packTime, serialToDate, unpackDate, unpackTime };

package/dist/index.js

@@ -950,6 +950,7 @@
     messages.view = {
         nameBox: "Name Box",
         errors: {
+            modifyMerged: "Cannot change part of a merged cell.",
             openUnsupported: "Unsupported format. Please select an .xlsx file.",
             shiftingNonblankCells: "Cannot insert cells due to data loss possibility. Select another insert location or delete the data from the end of your worksheet.",
             insertColumnWhenRowIsSelected: "Cannot insert column when all columns are selected.",
@@ -3061,6 +3062,18 @@
             ]);
     }
 
+    function defineAlias(alias, name) {
+        var orig = FUNCS[name];
+        if (!orig) {
+            throw new Error("Function " + name + " is not yet defined");
+        }
+        if (!orig.kendoSpreadsheetAliases) {
+            orig.kendoSpreadsheetAliases = [ name ];
+        }
+        orig.kendoSpreadsheetAliases.push(alias);
+        FUNCS[alias] = orig;
+    }
+
     /* -----[ exports ]----- */
 
     calc.runtime.CalcError = CalcError;
@@ -3079,24 +3092,8 @@
     calc.runtime.daysInYear = daysInYear;
     calc.runtime.parseDate = parseDate;
     calc.runtime.limitPrecision = limitPrecision;
-
-    // spreadsheet.dateToNumber = dateToSerial;
-    // spreadsheet.numberToDate = serialToDate;
-    // spreadsheet.defineFunction = defineFunction;
-    // spreadsheet.CalcError = CalcError;
-
     calc.runtime.defineFunction = defineFunction;
-    calc.runtime.defineAlias = function(alias, name) {
-        var orig = FUNCS[name];
-        if (!orig) {
-            throw new Error("Function " + name + " is not yet defined");
-        }
-        if (!orig.kendoSpreadsheetAliases) {
-            orig.kendoSpreadsheetAliases = [ name ];
-        }
-        orig.kendoSpreadsheetAliases.push(alias);
-        FUNCS[alias] = orig;
-    };
+    calc.runtime.defineAlias = defineAlias;
 
     /* -----[ Excel operators ]----- */
 
@@ -10802,13 +10799,13 @@
                     this.editor.deactivate(true); // make sure we don't call any change hooks
                     this.view.showError(result, function() {
                         // we only get here in case of a validation error when the user decided to retry.
-                        this.activateEditor(false);
+                        // this.activateEditor(false);
                         // reset to last input from user
-                        this.editor.value(this._lastEditorValue);
+                        // this.editor.value(this._lastEditorValue);
                         // however, set _value manually such that it'll detect change properly.  ugly :-\
-                        this.editor._value = this._workbook._inputForRef(this._workbook.activeSheet()._viewActiveCell());
+                        // this.editor._value = this._workbook._inputForRef(this._workbook.activeSheet()._viewActiveCell());
                         // seems like a nice UX to have the whole input selected
-                        this.editor.select();
+                        // this.editor.select();
                     }.bind(this));
                 } else {
                     this.view.openDialog(result.reason);
@@ -21934,7 +21931,7 @@
                 return;
             }
 
-            const data = this.formulaSource.filter((item) => String(item.value).startsWith(value.toLowerCase()));
+            const data = this.formulaSource.filter((item) => String(item.value).toLowerCase().startsWith(value.toLowerCase()));
 
             this.list.data(data);
 
@@ -22605,7 +22602,7 @@
                 messages: messages.view
             }, this.options, options);
 
-            this.events = ['update'];
+            this.events = ['update', 'message'];
 
             this._chrome();
 
@@ -23022,7 +23019,7 @@
 
         selectClipboardContents() {
             if (!this.isClipboardDeactivated) {
-                this.clipboard.focus();
+                this.clipboard.focus({ preventScroll: true });
                 selectElementContents(this.clipboard);
             }
         }
@@ -23088,81 +23085,41 @@
             });
         }
 
-        openDialog() { // openDialog(name, options) {
-            // let sheet = this._sheet;
-            // return sheet.withCultureDecimals(function() {
-            //     let dialog = kendo.spreadsheet.dialogs.create(name, options);
-
-            //     if (dialog) {
-            //         dialog.bind("action", this._executeCommand.bind(this));
-            //         dialog.bind("deactivate", this._destroyDialog.bind(this));
-            //         this._dialogs.push(dialog);
-
-            //         let ref = sheet.activeCell();
-            //         let range = new kendo.spreadsheet.Range(ref, sheet);
-
-            //         dialog.open(range);
-            //         return dialog;
-            //     }
-            // }.bind(this));
+        openDialog(name, options) {
+            let sheet = this._sheet;
+            return sheet.withCultureDecimals(function() {
+                let ref = sheet.activeCell();
+                let range = new Range$1(ref, sheet);
+                this.trigger('message', { ...options, name, ref, range });
+            }.bind(this));
         }
 
-        showError() { // showError(options, reopenEditor) {
-            // let currentDialogs = this._dialogs;
-            // let errorMessages = this.options.messages.errors;
-            // let hasOpenedError = false;
+        showError(options, reopenEditor) {
+            let currentDialogs = this._dialogs;
+            let errorMessages = this.options.messages.errors;
 
-            // if (currentDialogs.length > 0) {
-            //     currentDialogs.forEach(function(dialog) {
-            //         if (dialog.options && dialog.options.title === ERROR) {
-            //             hasOpenedError = true;
-            //         }
-            //     });
-            // }
-            // if (hasOpenedError) {
-            //     return;
-            // }
+            if (currentDialogs.length > 0) {
+                return;
+            }
 
-            // let focusButton = function(e) {
-            //     let cont = e.sender.dialog().element;
-            //     cont.find(".k-button").first().trigger("focus");
-            //     cont.find(".k-button, input").on("keydown", function(ev) {
-            //         if (ev.keyCode === kendo.keys.ESC) {
-            //             e.sender.close();
-            //         }
-            //     });
-            // };
+            let onClose = function() {
+                currentDialogs.pop();
+                // let dlg = e.sender;
+                this.selectClipboardContents();
+                if (reopenEditor) { // dlg._retry &&
+                    reopenEditor();
+                }
+            }.bind(this);
 
-            // let onClose = function(e) {
-            //     let dlg = e.sender;
-            //     this.selectClipboardContents();
-            //     if (dlg._retry && reopenEditor) {
-            //         reopenEditor();
-            //     }
-            // }.bind(this);
-
-            // if (kendo.spreadsheet.dialogs.registered(options.type)) {
-            //     let dialogOptions = {
-            //         close: onClose
-            //     };
-
-            //     if (options.type === "validationError") {
-            //         dialogOptions = $.extend(dialogOptions, {
-            //             title: options.title || "Error",
-            //             text: options.body ? options.body : errorMessages[options.type],
-            //             activate: focusButton
-            //         });
-            //     }
+            const dialogOptions = {
+                title: options.title || "Error",
+                text: options.body ? options.body : errorMessages[options.type],
+                close: onClose
+            };
 
-            //     this.openDialog(options.type, dialogOptions);
-            // } else {
-            //     this.openDialog("message", {
-            //         title : options.title || "Error",
-            //         text  : options.body ? options.body : errorMessages[options.type],
-            //         activate: focusButton,
-            //         close: onClose
-            //     });
-            // }
+            currentDialogs.push(dialogOptions);
+
+            this.openDialog(options.type || "message", dialogOptions);
         }
 
         destroy() {
@@ -23999,6 +23956,16 @@
         }
     }
 
+    class PropertyCleanCommand extends PropertyChangeCommand {
+        exec() {
+            let range = this.range();
+            if (range.enable()) {
+                this.getState();
+                range.clearFormat();
+            }
+        }
+    }
+
     class ClearContentCommand extends Command {
         exec() {
             let values = [], range, rowValues, nullValues, validationState, currentRange;
@@ -24994,14 +24961,14 @@
             }
 
             let workbook = this.options.workbook;
-            workbook.fromFile(this.options.file).then(function(){
-                let errors = workbook.excelImportErrors;
-                if (errors && errors.length) {
-                    workbook._view.openDialog("importError", {
-                        errors: errors
-                    });
-                }
-            });
+            workbook.fromFile(this.options.file);
+
+            let errors = workbook.excelImportErrors;
+            if (errors && errors.length) {
+                workbook._view.openDialog("importError", {
+                    errors: errors
+                });
+            }
         }
     }
 
@@ -25100,6 +25067,7 @@
         OpenCommand: OpenCommand,
         PasteCommand: PasteCommand,
         PropertyChangeCommand: PropertyChangeCommand,
+        PropertyCleanCommand: PropertyCleanCommand,
         ReorderDrawingsCommand: ReorderDrawingsCommand,
         RowHeightCommand: RowHeightCommand,
         SaveAsCommand: SaveAsCommand,
@@ -27745,7 +27713,7 @@
         "dataBound"
     ];
 
-    class Spreadsheet extends Widget {
+    class SpreadsheetWidget extends Widget {
         constructor(element, options$1) {
             super(element, deepExtend({}, options, options$1));
             this.events = events;
@@ -28226,10 +28194,27 @@
         }
     }
 
+    exports.CalcError = CalcError;
+    exports.CellRef = CellRef;
+    exports.Context = Context;
+    exports.Matrix = Matrix;
+    exports.NULLREF = NULLREF;
+    exports.NameRef = NameRef;
     exports.Range = Range$1;
+    exports.RangeRef = RangeRef;
+    exports.Ref = Ref;
     exports.Sheet = Sheet;
-    exports.Spreadsheet = Spreadsheet;
+    exports.SpreadsheetWidget = SpreadsheetWidget;
+    exports.UnionRef = UnionRef;
     exports.View = View;
     exports.Workbook = Workbook;
+    exports.dateToSerial = dateToSerial;
+    exports.defineAlias = defineAlias;
+    exports.defineFunction = defineFunction;
+    exports.packDate = packDate;
+    exports.packTime = packTime;
+    exports.serialToDate = serialToDate;
+    exports.unpackDate = unpackDate;
+    exports.unpackTime = unpackTime;
 
 }));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@progress/kendo-spreadsheet-common",
   "description": "Kendo UI platform-independent Spreadsheet library",
-  "version": "1.0.0-develop.8",
+  "version": "1.0.0",
   "keywords": [
     "Kendo UI"
   ],

package/src/index.d.ts

@@ -1,5 +1,9 @@
 
 /* eslint-disable max-len */
+
+/**
+ * Represents the default cell styles that will be applied to the sheet cells.
+ */
 export interface CellDefaultStyle {
     /**
      * The background [CSS color](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value) of the cell.
@@ -42,11 +46,14 @@ export interface CellDefaultStyle {
     wrap?: boolean;
 }
 
+/**
+ * Configures the Excel export settings of the Spreadsheet.
+ */
 export interface ExcelExportSettings {
     /**
      * Specifies the file name of the exported Excel file.
      *
-     * @default 'Spreadsheet.xslx'
+     * @default 'Workbook.xslx'
      */
     fileName?: string;
 
@@ -69,6 +76,9 @@ export interface ExcelExportSettings {
     proxyURL?: string | null;
 }
 
+/**
+ * The SheetColumn object.
+ */
 export interface SheetColumn {
     /**
      * The zero-based index of the column. Required to ensure correct positioning.
@@ -81,6 +91,9 @@ export interface SheetColumn {
     width?: number;
 }
 
+/**
+ * The CellBorder object.
+ */
 export interface CellBorder {
     /**
      * The border color of the cell. Many standard CSS formats are supported. However, the canonical form is #ccff00.
@@ -92,6 +105,9 @@ export interface CellBorder {
     size?: number;
 }
 
+/**
+ * Represents the interface of a Spreadsheet cell.
+ */
 export interface Cell extends CellDefaultStyle {
     /**
      * The style information for the bottom border of the cell.
@@ -166,7 +182,13 @@ export interface Cell extends CellDefaultStyle {
     verticalAlign?: string;
 }
 
+/**
+ * The SheetRow object.
+ */
 export interface SheetRow {
+    /**
+     * The cells in the row.
+     */
     cells?: Cell[];
 
     /**
@@ -185,6 +207,9 @@ export interface SheetRow {
     type?: string;
 }
 
+/**
+ * Represents the interface of a Spreadsheet document sheet and its content.
+ */
 export interface SheetDescriptor {
     /**
      * The active cell in the sheet, for example, `A1`.
@@ -233,13 +258,30 @@ export interface SheetDescriptor {
      */
     showGridLines?: boolean;
 
-    hyperlinks?: { ref: string; target: string; }[];
+    /**
+     * @hidden
+     */
+    gridLinesColor?: string | null;
+
+    /**
+     * An array which contains the hyperlinks of the cells.
+     */
+    hyperlinks?: { ref: string; target: string }[];
 
+    /**
+     * The default cell styles that will be applied to the sheet cells.
+     */
     defaultCellStyle?: CellDefaultStyle;
 
-    drawings?: { topLeftCell: any; offsetX: number; offsetY: number; width: number; height: number; image: string; opacity: any; }[];
+    /**
+     * An array which contains the drawings used in this sheet.
+     */
+    drawings?: { topLeftCell: any; offsetX: number; offsetY: number; width: number; height: number; image: string; opacity: any }[];
 }
 
+/**
+ * Represents the configuration of a Spreadsheet document.
+ */
 export interface DocumentDescriptor {
     /**
      * The name of the currently active sheet. Must exactly match one of the sheet names.
@@ -250,7 +292,22 @@ export interface DocumentDescriptor {
      * An array which defines the document sheets and their content.
      */
     sheets?: SheetDescriptor[];
-    names?: { value: string; name: string; sheet: string; localName: string; }[];
+
+    /**
+     * An array which holds the names of the sheets.
+     */
+    names?: { value: string; name: string; sheet: string; localName: string }[];
+
+    /**
+     * An object containing any images used in the Spreadsheet. The keys should be image ID-s
+     * (they are referenced by this ID in `sheets.drawings`) and the values should be image URLs.
+     * The image URLs can be either [data URLs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs), in which case the images are fully contained by the JSON,
+     * or can be external URLs.
+     * Note that when external URLs are used, they should reside on the same domain, or the server must
+     * be configured with the proper [CORS headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS),
+     * for the Spreadsheet to be able to fetch binary image data using a XMLHttpRequest. If it cannot fetch
+     * the image, export to Excel or PDF might not work.
+     */
     images?: { [name: string]: string };
 
     /**
@@ -301,84 +358,360 @@ export interface DocumentDescriptor {
     rows?: number;
 }
 
+/**
+ * The View object.
+ */
 export class View {
     constructor(element: HTMLElement, options: any);
+
+    /**
+     * A function which enables and disables the clipboard.
+     */
     enableClipboard(enable: boolean): void;
+
+    /**
+     * Returns the workbook object of the View.
+     */
     workbook(workbook?: Workbook): void | Workbook;
+    /**
+     * @hidden
+     */
     sheet(sheet: Sheet): void;
+
+    /**
+     * Re-renders all data in the View.
+     */
     refresh(reason: any): void;
+    /**
+     * @hidden
+     */
     nameEditor: any;
+    /**
+     * @hidden
+     */
     bind(eventName: string, handler: any, one?: boolean): void;
 }
 
+/**
+ * The props of the Workbook component.
+ */
 export class Workbook {
     constructor(options: any, view: View);
+
+    /**
+     * Executes a command with the passed options.
+     *
+     * @param options The object from where data will be loaded. This has to be the deserialized object, not the JSON string.
+     */
     execute(options: any): any;
+
+    /**
+     * Re-renders all data in the Workbook.
+     */
     refresh(reason: any): void;
+
+    /**
+     * A collection holding the commands available for undo and redo.
+     */
     undoRedoStack: any;
 }
 
+/**
+ * Represents one or more rectangular regions of cells in a given Sheet.
+ */
 export class Range {
+    /**
+     * Gets or sets the background color of the cells in the range.
+     *
+     * @param value Any valid [CSS color](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value).
+     * @returns the current background color of the top-left cell of the range.
+     */
     background(value?: string): string;
+    /**
+     * Gets or sets the bold state of the cells in the range.
+     *
+     * @param value True to make the text bold; false otherwise.
+     * @returns the current bold state of the top-left cell of the range.
+     */
     bold(value?: boolean): boolean;
+    /**
+     * Gets or sets the state of the bottom border of the cells. If the range includes more than a single cell, the setting is applied to all cells.
+     *
+     * @param value The border configuration object. It may contain size and color keys.
+     * @returns the current value of the top-left cell of the range.
+     */
     borderBottom(value?: CellBorder): CellBorder;
+    /**
+     * Gets or sets the state of the left border of the cells. If the range includes more than a single cell, the setting is applied to all cells.
+     *
+     * @param value The border configuration object. It may contain size and color keys.
+     * @returns the current value of the top-left cell of the range.
+     */
     borderLeft(value?: CellBorder): CellBorder;
+    /**
+     * Gets or sets the state of the right border of the cells. If the range includes more than a single cell, the setting is applied to all cells.
+     *
+     * @param value The border configuration object. It may contain size and color keys.
+     * @returns the current value of the top-left cell of the range.
+     */
     borderRight(value?: CellBorder): CellBorder;
+    /**
+     * Gets or sets the state of the top border of the cells. If the range includes more than a single cell, the setting is applied to all cells.
+     *
+     * @param value The border configuration object. It may contain size and color keys.
+     * @returns the current value of the top-left cell of the range.
+     */
     borderTop(value?: CellBorder): CellBorder;
+    /**
+     * Gets or sets the text color of the cells in the range.
+     *
+     * @param value - Any valid [CSS color](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value).
+     * @returns the current text color of the top-left cell of the range.
+     */
     color(value?: string): string;
+    /**
+     * Clears the contents of the range cells.
+     *
+     * @param value An object which may contain `contentsOnly: true` or `formatOnly: true` key values. Clearing the format will remove the cell formatting and visual styles.
+     * If a parameter is not passed, the method will clear both the cells values and the formatting.
+     */
     clear(value?: { contentsOnly?: boolean; formatOnly: boolean }): void;
+    /**
+     * Gets or sets the disabled state of the cells in the range.
+     *
+     * @param value True to make the cell enabled; false to disable it.
+     * @returns the current disabled state of the top-left cell of the range.
+     */
     enable(value?: boolean): boolean;
+    /**
+     * Gets or sets the font family of the cells in the range.
+     *
+     * @param value The font family that should be set.
+     * @returns the font family of the top-left cell of the range.
+     */
     fontFamily(value?: string): string;
+    /**
+     * Gets or sets the font size of the cells in the range.
+     *
+     * @param value The font size (in pixels) that should be set.
+     * @returns the font size of the top-left cell of the range.
+     */
     fontSize(value?: number): number;
+    /**
+     * Executes a function for each cell in the range.
+     *
+     * @param value The function that will be executed against every cell. The function receives the following parameters:
+     * `rowIndex` - the row index of the cell,
+     * `columnIndex` - the column index of the cell,
+     * `cellProperties` - the cell properties
+     */
     forEachCell(value: (rowIndex: number, columnIndex: number, cellProperties: Cell) => void): void;
+    /**
+     * Gets or sets the format of the cells.
+     *
+     * @param value The new format for the cells.
+     * @returns the format of the top-left cell of the range. When used as a setter, format returns the Range object to allow chained calls.
+     */
     format(value?: string): string;
+    /**
+     * Gets or sets the formula of the cells.
+     *
+     * @param value The new formula of the cell. The string may optionally start with `=`.
+     * @returns the formula of the top-left cell of the range.
+     */
     formula(value?: string): string;
+    /**
+     * Gets or sets the value of the cells. This is similar to `value`, but it parses the argument as if it was entered through the text box:
+     * - if it starts with `=` (equal sign), a formula is set. This may throw an error if the formula is syntactically invalid. Example: `range("C1").input("=A1+B1")`.
+     * - if it looks like a number, a numeric value (not string) is set.
+     * - if it's `true` or `false` (case-insensitive) the respective boolean value is set.
+     * - if it's a `Date` object, or a string that can be parsed as a date, it is converted to the numerical representation of the date.
+     * - if it starts with `'` (single quote), a string containing the rest of the characters is set. Example: `range("A1").input("'TRUE")` — sets the text "TRUE", not the boolean.
+     *
+     * @param value The value to be set to the cells.
+     * @returns the current value of the top-left cell of the range.
+     */
     input(value?: string | number | Date): any;
+    /**
+     * Gets or sets the italic state of the cells in the range.
+     *
+     * @param value True will make the text of the cells italic; false otherwise.
+     * @returns the current italic state of the top-left cell of the range.
+     */
     italic(value?: boolean): boolean;
+    /**
+     * Gets or sets the hyperlink of the cells in the range.
+     *
+     * @param value Pass a string (the URL) to create a hyperlink. Pass `null` to remove the link. Omit argument to get the existing URL, if any.
+     * @returns the current hyperlink attribute of the top-left cell of the range.
+     */
     link(value?: string): any;
+    /**
+     * Sets the sheet selection to the range cells.
+     */
     select(): void;
+    /**
+     * Gets or sets the text alignment of the cells in the range.
+     *
+     * @param value One of the following values: "left", "center", "right" and "justify".
+     * @returns the current text alignment of the top-left cell of the range.
+     */
     textAlign(value?: string): string;
+    /**
+     * Gets or sets the value of the cells. If the cell has formula set, the value setting will clear it.
+     *
+     * @param value The value to be set to the cells.
+     * @returns the current value of the top-left cell of the range.
+     */
     value(value?: string | number | Date): any;
+    /**
+     * Gets or sets the vertical alignment of the cells in the range.
+     *
+     * @param value One of the following values: "top", "center" and "bottom".
+     * @returns the current text alignment of the top-left cell of the range.
+     */
     verticalAlign(value?: string): string;
+    /**
+     * Gets or sets the wrap of the range cells.
+     *
+     * @param value `true` if to enable wrapping, `false` otherwise.
+     * @returns the current wrap state of the top-left cell of the range.
+     */
     wrap(value?: boolean): boolean;
 }
 
+/**
+ * @hidden
+ */
+export interface SelectedHeaders {
+    all: boolean;
+    allCols: boolean;
+    allRows: boolean;
+    cols: {
+        [key: number]: 'full' | 'partial';
+    };
+    rows: {
+        [key: number]: 'full' | 'partial';
+    };
+}
+
+/**
+ * The Sheet object.
+ */
 export class Sheet {
-    constructor();
+    /**
+     * Changes the size of the rows and columns of the current sheet.
+     *
+     * @param newRows The rows of the sheet after the resizing.
+     *
+     * @param newCols The columns of the sheet after the resizing.
+     */
     resize(newRows: number, newCols: number): void;
+
+    /**
+     * Returns the name of the sheet.
+     */
     name(): string;
+
+    /**
+     * Returns a Range object based on the passed cells.
+     */
     range(cell: string): Range;
+
+    /**
+     * Returns the active cell in the sheet, for example, A1.
+     */
     activeCell(): any;
+
+    /**
+     * A Boolean value which indicates if the grid lines of the sheet will be displayed.
+     *
+     * @default true
+     */
     showGridLines(value?: any): any;
+
+    /**
+     * @hidden
+     */
+    selectedHeaders(): SelectedHeaders;
 }
 
+/**
+ * @hidden
+ */
 export interface ExternalRef<T> {
     get current(): T | null;
 }
 
+/**
+ * Represents the options that will be applied the Spreadsheet.
+ */
 export interface SpreadsheetOptions extends DocumentDescriptor {
-    name?: string,
-    sheetsbar?: boolean,
+    /**
+     * The name of the sheet.
+     */
+    name?: string;
+
+    /**
+     * @hidden
+     */
+    sheetsbar?: boolean;
+
     /**
      * Configures the Excel export settings of the Spreadsheet.
      */
     excel?: ExcelExportSettings;
 
+    /**
+     * Sets the component messages.
+     */
     messages?: any;
 
+    /**
+     * Sets the component locale.
+     */
     locale?: string;
 
+    /**
+     * @hidden
+     */
     formulaBarInputRef?: ExternalRef<any>;
+    /**
+     * @hidden
+     */
     formulaCellInputRef?: ExternalRef<any>;
+    /**
+     * @hidden
+     */
     nameBoxRef?: ExternalRef<any>;
 }
 
-export class Spreadsheet {
+/**
+ * Represents the SpreadsheetWidget, holding the core functionality of the Spreadsheet.
+ */
+export class SpreadsheetWidget {
     constructor(element: HTMLElement, options: SpreadsheetOptions);
+
+    /**
+     * Returns the `View` object of the Spreadsheet.
+     */
     get view(): View;
+
+    /**
+     * Returns the `Workbook` object of the Spreadsheet.
+     */
     get workbook(): Workbook;
+
+    /**
+     * @hidden
+     */
     get options(): SpreadsheetOptions;
 
+    /**
+     * Executes the passed command against the selected cell/range.
+     *
+     * @param options An object containing the command name and the required by it options.
+     */
     executeCommand(options: any): void;
 
     /**
@@ -411,7 +744,7 @@ export class Spreadsheet {
     /**
      * Initiates the Excel export. Also fires the excelExport event.
      *
-     * Node: Calling this method may trigger the built-in popup blocker of the browser.
+     * Note: Calling this method may trigger the built-in popup blocker of the browser.
      * To avoid that, always call it as a response to an end-user action, for example, a button click.
      */
     saveAsExcel(options: any): void;
@@ -431,7 +764,246 @@ export class Spreadsheet {
      */
     refresh(): void;
 
+    /**
+     * @hidden
+     */
     bind(eventName: string, handler: any, one?: boolean): void;
 
+    /**
+     * @hidden
+     */
     destroy(): void;
 }
+
+/**
+ * The context object of the custom JavaScript functions (primitives) in formulas.
+ */
+export class Context {
+    /**
+     * Verifies that all references in the given array are resolved before invoking your callback—that is, executes any formula.
+     * If this array turns out to include the cell where the current formula lives, it returns a `#CIRCULAR!` error. Elements that are not references are ignored.
+     */
+    resolveCells(array: Ref[] | Ref[][], callback: () => any): any;
+
+    /**
+     * Returns as a flat array the values in any reference that exist in the given array. Elements that are not references are copied over.
+     */
+    cellValues(array: (Ref | Matrix)[] | Ref | Matrix): any;
+
+    /**
+     * Converts the given argument to a matrix, if possible.
+     * It accepts a `RangeRef` object or a plain JavaScript non-empty array.
+     * Additionally, if a `Matrix` object is provided, it is returned as is.
+     */
+    asMatrix(arg: RangeRef | RangeRef[] | Matrix): Matrix;
+
+    /**
+     * Returns the `Workbook` object where the current formula is evaluated.
+     */
+    workbook(): Workbook;
+
+    /**
+     * Returns the data that is the value in the given reference.
+     * If a `CellRef` is given, it returns a single value. For a `RangeRef` or `UnionRef`, it returns a flat array of values.
+     */
+    getRefData(ref: CellRef | RangeRef | UnionRef): any;
+}
+
+/**
+ * The "matrix" type which can be used in the custom JavaScript functions (primitives) in formulas.
+ */
+export class Matrix {
+    constructor(context: Context);
+    /**
+     * Indicate the width of the matrix.
+     */
+    width: number;
+
+    /**
+     * Indicate the height of the matrix.
+     */
+    height: number;
+
+    /**
+     * Returns a new matrix with the same data.
+     */
+    clone(): Matrix;
+
+    /**
+     * Returns the element at a given location.
+     */
+    get(row: number, col: number): any;
+
+    /**
+     * Sets the element at a given location.
+     */
+    set(row: number, col: number, value: any): void;
+
+    /**
+     * Iterates through elements of the matrix and calling the `func` for each element (first columns, then rows).
+     *
+     * @param func The function which will be called for each element.
+     * @param includeEmpty If `true`, it will call the function for empty (`null`) elements as well. Otherwise, it only calls it where a value exists.
+     */
+    each(func: (value: any, row: number, column: number) => void, includeEmpty: boolean): void;
+
+    /**
+     * Similar to `each`, but produces a new matrix of the same shape as the original one with the values returned by the function.
+     *
+     * @param func The function which will be called for each element.
+     * @param includeEmpty If `true`, it will call the function for empty (`null`) elements as well. Otherwise, it only calls it where a value exists.
+     */
+    map(func: (value: any, row: number, column: number) => void, includeEmpty: boolean): Matrix;
+
+    /**
+     * Returns the transposed matrix. The rows of the original matrix become columns of the transposed one.
+     */
+    transpose(): Matrix;
+
+    /**
+     * Returns the unit square matrix of size `n`.
+     */
+    unit(n: number): Matrix;
+
+    /**
+     * Multiplies the current matrix by the given matrix, and returns a new matrix as the result.
+     */
+    multiply(m: Matrix): Matrix;
+
+    /**
+     * Returns the determinant of this matrix. The matrix should contain only numbers and be square. Note that there are no checks for this.
+     */
+    determinant(): number;
+
+    /**
+     * Returns the inverse of this matrix. The matrix should contain only numbers and be square.
+     * Note that there are no checks for this. If the inverse does not exist, the determinant is zero, then it returns `null`.
+     */
+    inverse(): Matrix | null;
+}
+
+/**
+ * A class from which formula calculation errors will be instantiated.
+ */
+export class CalcError {
+    /**
+     * The error code.
+     */
+    code: string;
+}
+
+/**
+ * A base class only. All references inherit from it, but no direct instance of this object should ever be created.
+ * The class is exported just to make it easier to check whether something is a reference: `x instanceof Ref`.
+ */
+export class Ref {
+    /**
+     * The name of the sheet that this cell points to.
+     */
+    sheet: string;
+}
+
+/**
+ * Represents a cell reference. Note that the references do not contain data.
+ * Instead they just point to where the data is.
+ */
+export class CellRef extends Ref {
+    /**
+     * The row number, zero-based.
+     */
+    row: number;
+    /**
+     * The column number, zero-based.
+     */
+    col: number;
+}
+
+/**
+ * Represents a name cell reference.
+ */
+export class NameRef extends Ref { }
+
+/**
+ * A range reference.
+ */
+export class RangeRef extends Ref {
+    /**
+     * The top-left CellRef of the range.
+     */
+    topLeft: CellRef;
+    /**
+     * The bottom-right CellRef of the range.
+     */
+    bottomRight: CellRef;
+}
+
+/**
+ * A union. It contains a refs property, which is an array of references (it can be empty).
+ * A UnionRef can be created by the union operator, which is the comma.
+ */
+export class UnionRef extends Ref {
+    refs: (CellRef | RangeRef)[];
+}
+export class NULLREFClass {}
+
+/**
+ * An object (a singleton) and not a class.
+ * It represents the NULL reference, and could occur, for example, when you intersect two disjoint ranges, or when a formula depends on a cell that has been deleted.
+ * For example, when you put in some cell `=test(B5)` and then right-click on column `B` and delete it.
+ * To test when something is the `NULL` reference, just do `x === NULLREF`.
+ */
+export const NULLREF: NULLREFClass;
+
+/**
+ * Converts date parameters to number.
+ */
+export function packDate(year: number, month: number, date: number): number;
+
+/**
+ * Converts number to date parameters.
+ */
+export function unpackDate(serial: number): {
+    year: number;
+    month: number;
+    date: number;
+    day: number;
+    ord: number
+};
+
+/**
+ * Converts time parameters to number.
+ */
+export function packTime(hh: number, mm: number, ss: number, ms: number): number;
+
+/**
+ * Converts number to time parameters.
+ */
+export function unpackTime(serial: number): {
+    hours: number;
+    minutes: number;
+    seconds: number;
+    milliseconds: number
+};
+
+/**
+ * Converts number to date.
+ */
+export function serialToDate(serial: number): Date;
+
+/**
+ * Converts date to number.
+ */
+export function dateToSerial(date: Date): number;
+
+/**
+ * Defines custom formula.
+ */
+export function defineFunction(name: string, func: Function): {
+    args(args: any, log: any): any;
+    argsAsync(args: any, log: any): any;
+};
+
+/**
+ * Defines alias of a formula.
+ */
+export function defineAlias(alias: string, name: string): void;