@progress/kendo-spreadsheet-common 1.0.0-develop.10 → 1.0.0-develop.12

package/dist/index-esm.js

@@ -3060,6 +3060,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 +3090,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 ]----- */
 
@@ -21933,7 +21929,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);
 
@@ -28225,4 +28221,4 @@ class SpreadsheetWidget extends Widget {
     }
 }
 
-export { Range$1 as Range, Sheet, SpreadsheetWidget, 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

@@ -3061,6 +3061,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 +3091,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 ]----- */
 
@@ -21934,7 +21930,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);
 
@@ -28226,10 +28222,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.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.10",
+  "version": "1.0.0-develop.12",
   "keywords": [
     "Kendo UI"
   ],

package/src/index.d.ts

@@ -258,10 +258,15 @@ export interface SheetDescriptor {
      */
     showGridLines?: boolean;
 
+    /**
+     * @hidden
+     */
+    gridLinesColor?: string | null;
+
     /**
      * An array which contains the hyperlinks of the cells.
      */
-    hyperlinks?: { ref: string; target: string; }[];
+    hyperlinks?: { ref: string; target: string }[];
 
     /**
      * The default cell styles that will be applied to the sheet cells.
@@ -271,7 +276,7 @@ export interface SheetDescriptor {
     /**
      * 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; }[];
+    drawings?: { topLeftCell: any; offsetX: number; offsetY: number; width: number; height: number; image: string; opacity: any }[];
 }
 
 /**
@@ -291,7 +296,7 @@ export interface DocumentDescriptor {
     /**
      * An array which holds the names of the sheets.
      */
-    names?: { value: string; name: string; sheet: string; localName: string; }[];
+    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
@@ -417,72 +422,84 @@ export class Workbook {
 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,
@@ -491,12 +508,14 @@ export class Range {
     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.
      */
@@ -508,18 +527,21 @@ export class Range {
      * - 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.
      */
@@ -530,24 +552,28 @@ export class Range {
     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.
      */
@@ -558,8 +584,6 @@ export class Range {
  * The Sheet object.
  */
 export class Sheet {
-    constructor();
-
     /**
      * Changes the size of the rows and columns of the current sheet.
      *
@@ -584,7 +608,7 @@ export class Sheet {
      */
     activeCell(): any;
 
-     /**
+    /**
      * A Boolean value which indicates if the grid lines of the sheet will be displayed.
      *
      * @default true
@@ -606,12 +630,12 @@ export interface SpreadsheetOptions extends DocumentDescriptor {
     /**
      * The name of the sheet.
      */
-    name?: string,
+    name?: string;
 
     /**
      * @hidden
      */
-    sheetsbar?: boolean,
+    sheetsbar?: boolean;
 
     /**
      * Configures the Excel export settings of the Spreadsheet.
@@ -623,7 +647,7 @@ export interface SpreadsheetOptions extends DocumentDescriptor {
      */
     messages?: any;
 
-     /**
+    /**
      * Sets the component locale.
      */
     locale?: string;
@@ -730,3 +754,236 @@ export class SpreadsheetWidget {
      */
     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;