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

package/dist/index-esm.js

@@ -27744,7 +27744,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 +28225,4 @@ class Spreadsheet extends Widget {
     }
 }
 
-export { Range$1 as Range, Sheet, Spreadsheet, View, Workbook };
+export { Range$1 as Range, Sheet, SpreadsheetWidget, View, Workbook };

package/dist/index.js

@@ -27745,7 +27745,7 @@
         "dataBound"
     ];
 
-    class Spreadsheet extends Widget {
+    class SpreadsheetWidget extends Widget {
         constructor(element, options$1) {
             super(element, deepExtend({}, options, options$1));
             this.events = events;
@@ -28228,7 +28228,7 @@
 
     exports.Range = Range$1;
     exports.Sheet = Sheet;
-    exports.Spreadsheet = Spreadsheet;
+    exports.SpreadsheetWidget = SpreadsheetWidget;
     exports.View = View;
     exports.Workbook = Workbook;
 

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-develop.9",
   "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 styles that will be applied to the 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 props that will be applied a sheet and its content.
+ */
 export interface SheetDescriptor {
     /**
      * The active cell in the sheet, for example, `A1`.
@@ -233,13 +258,25 @@ export interface SheetDescriptor {
      */
     showGridLines?: boolean;
 
+    /**
+     * 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;
 
+    /**
+     * 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 +287,22 @@ export interface DocumentDescriptor {
      * An array which defines the document sheets and their content.
      */
     sheets?: SheetDescriptor[];
+
+    /**
+     * 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 +353,323 @@ export interface DocumentDescriptor {
     rows?: number;
 }
 
+/**
+ * The View object.
+ */
 export class View {
     constructor(element: HTMLElement, options: any);
+
+    /**
+     * A Boolean value which indicates if clipboard will be.
+     *
+     * @default true
+     */
     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 {
-    background(value?: string): string;
+    /**
+     * 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?: Colo): 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;
 }
 
+/**
+ * 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
+ */
 export interface ExternalRef<T> {
     get current(): T | null;
 }
 
+/**
+ * Represents the options that will be applied the Spreadsheet.
+ */
 export interface SpreadsheetOptions extends DocumentDescriptor {
+    /**
+     * 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 Spreadsheet instance.
+ */
+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 +702,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 +722,13 @@ export class Spreadsheet {
      */
     refresh(): void;
 
+    /**
+     * @hidden
+     */
     bind(eventName: string, handler: any, one?: boolean): void;
 
+    /**
+     * @hidden
+     */
     destroy(): void;
 }