@progress/kendo-spreadsheet-common 1.0.0-develop.2 → 1.0.0-develop.3

package/dist/index-esm.js

@@ -956,8 +956,9 @@ const options = {
     headerHeight: 20,
     headerWidth: 32,
     excel: {
+        fileName: "Spreadsheet.xslx",
+        forceProxy: false,
         proxyURL: "",
-        fileName: "Workbook.xlsx"
     },
     messages: {},
     pdf: {
@@ -27990,8 +27991,8 @@ class Spreadsheet extends Widget {
         return this._workbook.saveJSON();
     }
 
-    fromFile(blob, name) {
-        return this._workbook.fromFile(blob, name);
+    fromFile(blob) {
+        return this._workbook.fromFile(blob);
     }
 
     saveAsPDF(options) {

package/dist/index.js

@@ -956,8 +956,9 @@
         headerHeight: 20,
         headerWidth: 32,
         excel: {
+            fileName: "Spreadsheet.xslx",
+            forceProxy: false,
             proxyURL: "",
-            fileName: "Workbook.xlsx"
         },
         messages: {},
         pdf: {
@@ -27990,8 +27991,8 @@
             return this._workbook.saveJSON();
         }
 
-        fromFile(blob, name) {
-            return this._workbook.fromFile(blob, name);
+        fromFile(blob) {
+            return this._workbook.fromFile(blob);
         }
 
         saveAsPDF(options) {

package/package.json

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

package/src/index.d.ts

@@ -1,20 +1,401 @@
-/**
- * @hidden
- */
-export class Spreadsheet {
+
+/* eslint-disable max-len */
+export interface CellDefaultStyle {
+    /**
+     * The background [CSS color](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value) of the cell.
+     */
+    background?: string;
+
+    /**
+     * The text [CSS color](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value) of the cell.
+     */
+    color?: string;
+
+    /**
+     * The font family of the cell.
+     */
+    fontFamily?: string;
+
+    /**
+     * The font size of the cell in pixels.
+     */
+    fontSize?: number;
+
+    /**
+     * If set to `true`, sets the cell font to bold.
+     */
+    bold?: boolean;
+
+    /**
+     * If set to `true`, sets the cell font to italic.
+     */
+    italic?: boolean;
+
+    /**
+     * If set to `true`, sets the cell font to underline.
+     */
+    underline?: boolean;
+
+    /**
+     * If set to `true`, sets the cell wrap.
+     */
+    wrap?: boolean;
+}
+
+export interface ExcelExportSettings {
+    /**
+     * Specifies the file name of the exported Excel file.
+     *
+     * @default 'Spreadsheet.xslx'
+     */
+    fileName?: string;
+
+    /**
+     * If set to `true`, the content will be forwarded to proxyURL even if the browser supports the saving of files locally.
+     *
+     * @default false
+     */
+    forceProxy?: boolean;
+
+    /**
+     * The URL of the server side proxy which will stream the file to the end user. A proxy will be used when the browser is not capable of saving files locally. Such browsers are IE version 9 and lower and Safari. The developer is responsible for implementing the server-side proxy. The proxy will return the decoded file with the `Content-Disposition` header set to `attachment; filename="<fileName.xslx>"`.
+     * The proxy will receive a POST request with the following parameters in the request body:
+     * - contentType - The MIME type of the file.
+     * - base64 - The base-64 encoded file content.
+     * - fileName - The file name as requested by the caller.
+     *
+     * @default null
+     */
+    proxyURL?: string | null;
+}
+
+export interface SheetColumn {
+    /**
+     * The zero-based index of the column. Required to ensure correct positioning.
+     */
+    index?: number;
+
+    /**
+     * The width of the column in pixels. Defaults to columnWidth.
+     */
+    width?: number;
+}
+
+export interface CellBorder {
+    /**
+     * The border color of the cell. Many standard CSS formats are supported. However, the canonical form is #ccff00.
+     */
+    color?: string;
+    /**
+     * The width of the border in pixels.
+     */
+    size?: number;
+}
+
+export interface Cell extends CellDefaultStyle {
+    /**
+     * The style information for the bottom border of the cell.
+     */
+    borderBottom?: CellBorder;
+
+    /**
+     * The style information for the left border of the cell.
+     */
+    borderLeft?: CellBorder;
+
+    /**
+     * The style information for the right border of the cell.
+     */
+    borderRight?: CellBorder;
+
+    /**
+     * The style information for the top border of the cell.
+     */
+    borderTop?: CellBorder;
+
+    /**
+     * If set to `false`, disables the cell.
+     */
+    enable?: boolean;
+
+    /**
+     * The format of the cell text. For more information, refer to the article on
+     * [creating or deleting a custom number format on MS Office](https://support.office.com/en-au/article/Create-or-delete-a-custom-number-format-78f2a361-936b-4c03-8772-09fab54be7f4).
+     */
+    format?: string;
+
+    /**
+     * The cell formula without the leading equals sign, for example, `A1 * 10`.
+     */
+    formula?: string;
+
+    /**
+     * If set to `true`, renders the cell value as HTML.
+     * It is important to sanitize the value of the cell on the server for passing safe html because there is no client-side sanitizing.
+     * When editing a cell the new value can be checked and prevented in the client `changing` event.
+     */
+    html?: boolean;
+
+    /**
+     * The zero-based index of the cell. Required to ensure correct positioning.
+     */
+    index?: number;
+
+    /**
+     * The hyperlink (URL) of the cell.
+     */
+    link?: string;
+
+    /**
+     * The text-align setting for the cell content.
+     *
+     * The available options are: `left`, `center`, `right` or `justify`.
+     */
+    textAlign?: string;
+
+    /**
+     * The cell value.
+     */
+    value?: number | string | boolean | Date;
+
+    /**
+     * The vertical align setting for the cell content.
+     *
+     * The available options are: `top`, `center` or `bottom`.
+     */
+    verticalAlign?: string;
+}
+
+export interface SheetRow {
+    cells?: Cell[];
+
+    /**
+     * The row height in pixels. Defaults to rowHeight.
+     */
+    height?: number;
+
+    /**
+     * The absolute row index. Required to ensure correct positioning.
+     */
+    index?: number;
+
+    /**
+     * The table row element role in the context of the Grid table structure.
+     */
+    type?: string;
+}
+
+export interface SheetDescriptor {
+    /**
+     * The active cell in the sheet, for example, `A1`.
+     */
+    activeCell?: string;
+
+    /**
+     * The name of the sheet.
+     */
+    name?: string;
+
+    /**
+     * An array which defines the columns in this sheet and their content.
+     */
+    columns?: SheetColumn[];
+
+    /**
+     * The number of frozen columns in this sheet.
+     */
+    frozenColumns?: number;
+
+    /**
+     * The number of frozen rows in this sheet.
+     */
+    frozenRows?: number;
+
+    /**
+     * An array of merged cell ranges, for example, `B1:D2`.
+     */
+    mergedCells?: string[];
+
+    /**
+     * The row data for this sheet.
+     */
+    rows?: SheetRow[];
+
+    /**
+     * The selected range in the sheet, for example, `A1:B10`.
+     */
+    selection?: string;
+
+    /**
+     * A Boolean value which indicates if the grid lines of the sheet will be displayed.
+     *
+     * @default true
+     */
+    showGridLines?: boolean;
+
+    hyperlinks?: { ref: string; target: string; }[];
+
+    defaultCellStyle?: CellDefaultStyle;
+
+    drawings?: { topLeftCell: any; offsetX: number; offsetY: number; width: number; height: number; image: string; opacity: any; }[];
+}
+
+export interface DocumentDescriptor {
+    /**
+     * The name of the currently active sheet. Must exactly match one of the sheet names.
+     */
+    activeSheet?: string;
+
+    /**
+     * An array which defines the document sheets and their content.
+     */
+    sheets?: SheetDescriptor[];
+    names?: { value: string; name: string; sheet: string; localName: string; }[];
+    images?: { [name: string]: string };
+
+    /**
+     * The default column width in pixels.
+     *
+     * @default 64
+     */
+    columnWidth?: number;
+
+    /**
+     * The number of columns in the document.
+     *
+     * @default 50
+     */
+    columns?: number;
+
+    /**
+     * The default cell styles that will be applied to the sheet cells.
+     */
+    defaultCellStyle?: CellDefaultStyle;
+
+    /**
+     * The height of the header row in pixels.
+     *
+     * @default 20
+     */
+    headerHeight?: number;
+
+    /**
+     * The width of the header column in pixels.
+     *
+     * @default 32
+     */
+    headerWidth?: number;
+
+    /**
+     * The default row height in pixels.
+     *
+     * @default 20
+     */
+    rowHeight?: number;
+
+    /**
+     * The number of rows in the document.
+     *
+     * @default 200
+     */
+    rows?: number;
+}
+
+export class View {
     constructor(element: HTMLElement, options: any);
-    get view(): any;
-    get workbook(): any;
+	enableClipboard(enable: boolean): void;
+	workbook(workbook?: Workbook): void | Workbook;
+	sheet(sheet: Sheet): void;
+	refresh(reason: any): void;
+    nameEditor: any;
+    bind(eventName: string, handler: any, one?: boolean): void;
+}
+
+export class Workbook {
+    constructor(options: any, view: View);
+	execute(options: any): any;
+	refresh(reason: any): void;
+	undoRedoStack: any;
+}
+export class Sheet {
+    constructor();
+	resize(newRows: number, newCols: number): void;
+	name(): string;
+    range(cell: any): any;
+    activeCell(): any;
+}
+
+export interface ExternalRef<T> {
+    get current(): T | null;
+}
+
+export interface SpreadsheetOptions extends DocumentDescriptor {
+    name?: string,
+    sheetsbar?: boolean,
+    /**
+     * Configures the Excel export settings of the Spreadsheet.
+     */
+    excel?: ExcelExportSettings;
+
+    messages?: any;
+
+    locale?: string;
+
+    formulaBarInputRef?: ExternalRef<any>;
+    formulaCellInputRef?: ExternalRef<any>;
+    nameBoxRef?: ExternalRef<any>;
+}
+
+export class Spreadsheet {
+    constructor(element: HTMLElement, options: SpreadsheetOptions);
+    get view(): View;
+    get workbook(): Workbook;
 
     executeCommand(options: any): void;
 
-    fromJSON(options: { sheets: any[] }): any;
-    toJSON(): void;
+    /**
+     * Loads the workbook data from an object with the format that is defined in the configuration.
+     *
+     * Note: All existing sheets and their data will be lost.
+     *
+     * @param json The object from where data will be loaded. This has to be the deserialized object, not the JSON string.
+     */
+    fromJSON(json: DocumentDescriptor): void;
 
-    fromFile(file: any, fileName: string): void;
+    /**
+     * Serializes the workbook.
+     */
+    toJSON(): DocumentDescriptor;
+
+    /**
+     * Clears the Spreadsheet and populates it with data from the specified Excel (.xlsx) file.
+     *
+     * @param blob The file or blob that is usually obtained through a file input.
+     */
+    fromFile(file: File | Blob): void;
+
+    /**
+     * Initiates the Excel export. Also fires the excelExport event.
+     *
+     * Node: 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;
 
-    activeSheet(): any;
-    sheets(): any[];
+    /**
+     * Gets or sets the active sheet.
+     */
+    activeSheet(sheet?: Sheet): Sheet | void;
+
+    /**
+     * Returns an array with the sheets in the workbook.
+     */
+    sheets(): Sheet[];
+
+    /**
+     * Re-renders all data in the Spreadsheet.
+     */
+    refresh(): void;
+
     destroy(): void;
 }