jspreadsheet 8.1.16 → 8.2.4

package/dist/index.d.ts

@@ -345,7 +345,7 @@ declare namespace jspreadsheet {
         onbeforesort?: (worksheet: worksheetInstance, column: number, direction: number, newOrderValues: []) => boolean | [] | void;
         /** When a column is sorted. */
         onsort?: (worksheet: worksheetInstance, column: number, direction: number, newOrderValues: []) => void;
-        /** When the spreadsheed gets the focus. */
+        /** When the spreadsheet gets the focus. */
         onfocus?: (worksheet: worksheetInstance) => void;
         /** When the spreadsheet loses the focus. */
         onblur?: (worksheet: worksheetInstance) => void;
@@ -454,7 +454,7 @@ declare namespace jspreadsheet {
         defaultColWidth?: number | string;
         /** Default row height. Default: null */
         defaultRowHeight?: number | string;
-        /** Default alignment for a new column: [center, left, right] */
+        /** Deprecated. The default alignment of a cell is defined by a CSS class from 8.2.0+ */
         defaultColAlign?: 'center' | 'left' | 'right' | 'justify';
         /** Minimum number of spare rows. Default: 0 */
         minSpareRows?: number;
@@ -556,7 +556,7 @@ declare namespace jspreadsheet {
         /** Contextmenu HTMLElement */
         contextmenu: HTMLElement;
         /** Create a new worksheet from the given settings */
-        createWorksheet: (options: Worksheet) => void;
+        createWorksheet: (options: Worksheet) => worksheetInstance;
         /** Delete an existing worksheet by its position */
         deleteWorksheet: (position: Number) => void;
         /** DOM Element */
@@ -565,7 +565,7 @@ declare namespace jspreadsheet {
         element: HTMLElement;
         /** DOM Element container for the filters */
         filters: HTMLElement;
-        /** Toggle the fullscreen mode */
+        /** Toggle the full screen mode */
         fullscreen: (state: Boolean) => void;
         /** Get the toolbar object definitions */
         getToolbar: Toolbar,
@@ -647,7 +647,7 @@ declare namespace jspreadsheet {
         /** DOM Corner square */
         corner: HTMLElement;
         /** Create a new worksheet */
-        createWorksheet: (worksheetOptions: Worksheet) => void;
+        createWorksheet: (worksheetOptions: Worksheet) => worksheetInstance;
         /** Internal selected cell */
         cursor: object;
         /** Cut */
@@ -703,8 +703,8 @@ declare namespace jspreadsheet {
         getColumnData: (col: number, processed?: boolean) => Array<any>;
         /** Get the column position by its name */
         getColumnIdByName: (name: string) => number;
-        /** Get the settings for one column. Row its optional when need to get the information from one specific cell. */
-        getColumnOptions: (x: number, y: number) => void;
+        /** Alias for getProperty */
+        getColumnOptions: (x: number, y?: number) => Column;
         /** Get the comments from one cell. Example: getComments('A1') */
         getComments: (cellName?: string) => string;
         /** Get the worksheet settings */
@@ -714,9 +714,11 @@ declare namespace jspreadsheet {
          *
          * @param {boolean} only the selected cells
          * @param {boolean} get the raw or processed data
-         * @return {array} array of data
+         * @param {string} delimiter to get the data as a string with columns separate by the char delimiter.
+         * @param {boolean} get the data as a JSON object.
+         * @return {array|object} array or object with the data
          */
-        getData: (highlighted?: boolean, processed?: boolean, delimiter?: string) => Array<any>;
+        getData: (highlighted?: boolean, processed?: boolean, delimiter?: string, asJson?: boolean) => Array<any> | String;
         /** Get the defined name or defined names when key is null */
         getDefinedNames: (key?: string) => object;
         /** Internal method: Get the editor for one cell */
@@ -728,11 +730,11 @@ declare namespace jspreadsheet {
         /** Get the footer value */
         getFooterValue: (x: number, y: number) => any;
         /** Get the header title */
-        getHeader: (columnnumber: number) => string;
+        getHeader: (columnNumber: number) => string;
         /** Get all header elements */
         getHeaders: (asArray: boolean) => Array<any>;
-        /** Get the height of one row by its position */
-        getHeight: (row: number) => void;
+        /** Get the height of one row by its position when height is defined. */
+        getHeight: (row?: number) => Array | number;
         /** Get the highlighted coordinates **/
         getHighlighted: () => Array<any>;
         /** Get json */
@@ -741,8 +743,8 @@ declare namespace jspreadsheet {
         getLabel: (cellName: string) => Object;
         /** Get the processed data cell shown to the user by its coordinates */
         getLabelFromCoords: (x: number, y: number) => string[];
-        /** Get the merged cells. Cellname: A1, A2, etc */
-        getMerge: (cellName: string) => void;
+        /** Get the merged cells. Cell name: A1, A2, etc */
+        getMerge: (cellName: string) => Object | Array<number>;
         /** Get one or all meta information for one cell. */
         getMeta: (cellName: string, property: string) => Object;
         /** Get the nested cells */
@@ -753,14 +755,14 @@ declare namespace jspreadsheet {
         getNestedHeaders: () => [];
         /** Get the next available number in the sequence */
         getNextSequence: () => number;
-        /** Get the column or cell options by coordinates */
-        getOptions: (x: number, y: number) => object;
+        /** Alias to getProperty */
+        getOptions: (x: number, y?: number) => Column;
         /** Get the primaryKey column when applicable. */
         getPrimaryKey: () => number;
-        /** Get processed data by the coordinates of the cell */
-        getProcessed: (x: number, y: number, extended: boolean) => void;
-        /** Get the properties for one column or cell */
-        getProperties: (x: number, y: number) => void;
+        /** Get processed data by the coordinates of the cell. Extended process a color, progressbar and rating as raw. */
+        getProcessed: (x: number, y: number, extended?: boolean) => any;
+        /** Get the properties for one column when only x is present or the cell when x and y is defined. */
+        getProperties: (x: number, y?: number) => Column;
         /** Get the selection in a range format */
         getRange: () => string;
         /** Get a row data or meta information by Id. */
@@ -771,20 +773,18 @@ declare namespace jspreadsheet {
         getRowId: (row: number) => number;
         /** Get all selected cells */
         getSelected: (columnNameOnly: boolean) => any[];
-        /** Get the selected columns */
-        getSelectedColumns: () => [];
-        /** Get the selected rows */
-        getSelectedRows: () => [];
+        /** Get the selected columns. DOMElements or Indexes */
+        getSelectedColumns: (indexes?: Boolean) => Array<HTMLElement> | Array<number>;
+        /** Get the selected rows. DOMElements or Indexes */
+        getSelectedRows: (indexes?: Boolean) => Array<HTMLElement> | Array<number>;
         /** Get the style from one cell. Ex. getStyle('A1') */
         getStyle: (cell: string) => Object;
-        /** Get value by the cellname or object. The value can be the raw or processed value. */
+        /** Get value by the cell name or object. The value can be the raw or processed value. */
         getValue: (cell: string, processed: boolean) => String;
         /** Get value by the coordinates. The value can be the raw or processed value. */
-        getValueFromCoords: (x: number, y: number, processed: boolean) => void;
-        /** Get the width of one column by its position */
-        getWidth: (x: number) => void;
-        /** Get the editor type for one column or cell */
-        getType: (x: number, y: number) => void;
+        getValueFromCoords: (x: number, y: number, processed: boolean) => any;
+        /** Get the width of one column by index or all column width as an array when index is null. */
+        getWidth: (x?: index) => Array<number> | number;
         /** Go to the row number, [col number] **/
         goto: (y: number, x?: number) => void;
         /** Hold the header container */
@@ -837,7 +837,7 @@ declare namespace jspreadsheet {
         page: (pagenumber: number) => void;
         /** Current page number */
         pagenumber: number;
-        /** Pagination DOM containr */
+        /** Pagination DOM container */
         pagination: Object;
         /** Spreadsheet object */
         parent: spreadsheetInstance;
@@ -853,7 +853,7 @@ declare namespace jspreadsheet {
         refreshBorders: (border?: string) => void;
         /** Refresh footers */
         refreshFooter: () => void;
-        /** Remove the merged cells by the cellname */
+        /** Remove the merged cells by the cell name */
         removeMerge: (cellName: String) => void;
         /** Reset the borders by name border name */
         resetBorders: (border: String, resetPosition: boolean) => void;