jspreadsheet 11.11.1 → 11.11.3

package/dist/index.d.ts

@@ -30,7 +30,7 @@ declare namespace jspreadsheet {
     /** Shortcuts */
     let shortcuts: Shortcuts;
     /** Get the worksheet instance by its name */
-    function getWorksheetInstanceByName(worksheetName: string, namespace?: string) : worksheetInstance;
+    let getWorksheetInstanceByName: GetWorksheetInstanceByNameFunction;
 
     /** Picker */
     let picker: Picker;
@@ -92,6 +92,8 @@ declare namespace jspreadsheet {
         print: () => [string],
     };
 
+    type GetWorksheetInstanceByNameFunction = (worksheetName?: string | null | undefined, namespace?: string) => worksheetInstance | Record<string, worksheetInstance>;
+
     interface Picker {
         (el: HTMLElement, options: PickerOptions) : void;
 
@@ -1150,6 +1152,8 @@ declare namespace jspreadsheet {
         zoom?: number;
         /** Detect column names from the data object given when the column names are not declared. Default: true */
         autoNames?: boolean;
+        /** Ignore Undefined Columns. Default: false */
+        ignoreUndefinedColumns?: boolean;
     }
 
     interface SpreadsheetHTMLElement extends HTMLDivElement {
@@ -1192,7 +1196,7 @@ declare namespace jspreadsheet {
         /** Tools HTMLElement container */
         tools: HTMLElement;
         /** Worksheets container */
-        worksheets: Array<Worksheet>;
+        worksheets: Array<worksheetInstance>;
         /** Load plugins into the spreadsheet */
         setPlugins: (plugins: Record<string, Function>) => void;
         /** Internal method: event dispatch controllers. */
@@ -1205,7 +1209,7 @@ declare namespace jspreadsheet {
         /** Get the worksheet name */
         getWorksheetName: (position: number) => string | undefined;
         /** Get the worksheet instance by its name */
-        getWorksheetInstanceByName: (worksheetName: string, namespace?: string) => worksheetInstance | Record<string, worksheetInstance>;
+        getWorksheetInstanceByName: GetWorksheetInstanceByNameFunction;
         /** Open a worksheet */
         openWorksheet: (position: number, force?: boolean) => void;
         /** Create a new worksheet */
@@ -1248,6 +1252,8 @@ declare namespace jspreadsheet {
 
     type DeleteMediaItem = string | { id: string, [key: string]: any };
 
+    type SetValueFirstArgument = string | { x: number, y: number, value: any, force?: boolean }[];
+
     interface worksheetInstance {
         /** Array with the borders information */
         borders: CustomArray<Border>;
@@ -1574,7 +1580,7 @@ declare namespace jspreadsheet {
         setMerge(cellName: Record<string, [number, number]>): false | undefined;
         setMerge(cellName: string, colspan: number, rowspan: number): false | undefined;
         /** Get one or various meta information for one cell. */
-        setMeta: (cell: string | object, property?: string, value?: string) => false | undefined;
+        setMeta: (cell: string | Record<string, any>, property?: string, value?: string) => false | undefined;
         /** Set the nested headers */
         setNestedHeaders: (config: Nested[][]) => void;
         /** Deprecated. Alias for parent.setPlugins */
@@ -1600,7 +1606,7 @@ declare namespace jspreadsheet {
         setRowId(row: Record<number, number>): void;
         setRowId(row: number, newId: number): void;
         /** Set the style for one cell. Ex. setStyle('A1', 'background-color', 'red') */
-        setStyle(cell: string | string[], property: string, value?: string, forceOverwrite?: boolean): false | undefined;
+        setStyle(cell: string | string[] | { x: number, y: number }[], property: string, value?: string, forceOverwrite?: boolean): false | undefined;
         setStyle(cell: Record<string, string>, property?: undefined, value?: undefined, forceOverwrite?: boolean): false | undefined;
         /**
          * Set a cell value
@@ -1609,7 +1615,7 @@ declare namespace jspreadsheet {
          * @param value
          * @param force value over readonly cells
          */
-        setValue: (cell: any, value?: any, forceOverwrite?: boolean, origin?: string) => false | undefined;
+        setValue: (cell: SetValueFirstArgument, value?: any, forceOverwrite?: boolean, origin?: string) => false | undefined;
         /**
          * Set a cell value
          *
@@ -1747,7 +1753,7 @@ declare namespace jspreadsheet {
         /** Delete an existing worksheet by its position */
         deleteWorksheet: (position?: number) => false | undefined;
         /** Rename an existing worksheet by its position */
-        renameWorksheet: (position?: number, title: string) => false | undefined;
+        renameWorksheet: (position: number | undefined, title: string) => false | undefined;
         /** Move the position of a worksheet. ignoreDomUpdates: true will block updates to the DOM */
         moveWorksheet: (from: number, to: number, ignoreDomUpdates?: boolean) => false | undefined;
         /** Get the active worksheet when applicable */
@@ -1755,7 +1761,7 @@ declare namespace jspreadsheet {
         /** Get the worksheet name */
         getWorksheetName: (position?: number) => string | undefined;
         /** Get the worksheet instance by its name */
-        getWorksheetInstanceByName: (worksheetName: string, namespace?: string) => worksheetInstance | Record<string, worksheetInstance>;
+        getWorksheetInstanceByName: GetWorksheetInstanceByNameFunction;
         /** Set a worksheet state visibility */
         setWorksheetState: (worksheetIndex: number, state: boolean) => void;
         /** Parse the toolbar definitions with defaults */