jspreadsheet 9.2.6 → 9.2.8

package/dist/index.d.ts

@@ -55,6 +55,54 @@ declare namespace jspreadsheet {
     /** Get the current version */
     function version(): object;
 
+    /** Only available with the Validations extension */
+    interface Validation {
+        /** Excel-like range format Sheet1!A1:A6 */
+        range: string;
+        /** Validation type */
+        type: 'number' | 'text' | 'date' | 'list' | 'textLength' | 'empty' | 'notEmpty';
+        /** Validation action can be a warning or reject when the condition are not match or a format when the condition matches */
+        action: 'warning' | 'reject' | 'format';
+        /** Criteria to be match */
+        criteria:
+            | '='
+            | '!='
+            | '>='
+            | '>'
+            | '<='
+            | '<'
+            | 'between'
+            | 'not between'
+            | 'valid date'
+            | 'valid email'
+            | 'valid url'
+            | 'contains'
+            | 'not contains'
+            | 'begins with'
+            | 'ends with'
+        /** Custom message to the user */
+        text?: string;
+        /** Ignore blank cells */
+        allowBlank?: boolean;
+        /** For type: format you can apply some CSS when condition is matched */
+        format?: {
+            color: string;
+            'background-color': string;
+            'font-weight': number;
+            'font-style': string;
+        }
+        /** For type: format you can add a class when condition is matched */
+        className?: string;
+    }
+
+    /** Only available with the Validations extension */
+    interface Validations {
+        // Index position in the array of validations
+        index?: number | null;
+        // The validation definition object
+        value: Validation;
+    }
+
     /** Native editors */
     interface Editors {
         // Create a DOM element for a cell edition
@@ -537,6 +585,8 @@ declare namespace jspreadsheet {
         onchangefooter?: (worksheet: worksheetInstance, newValue: string, oldValue: string) => void;
         /** When the value in a cell footer is changed. */
         onchangefootervalue?: (worksheet: worksheetInstance, x: number, y: number, value: string) => void;
+        /** When the footer cell is rendered */
+        onrenderfootercell?: (worksheet: worksheetInstance, x: number, y: number, value: string, td: HTMLElement) => void;
         /** On change nested headers */
         onchangenested?: (worksheet: worksheetInstance, options: object) => void;
         /** On change nested cell properties */
@@ -636,7 +686,7 @@ declare namespace jspreadsheet {
         /** Worksheets */
         worksheets?: Array<Worksheet>;
         /** Validations */
-        validations?: any;
+        validations?: Validation[];
         /** Plugins */
         plugins?: Record<string, Function>
     }
@@ -1317,6 +1367,12 @@ declare namespace jspreadsheet {
         getWorksheetActive: () => number;
         /** Delete an existing worksheet by its position */
         deleteWorksheet: (position: number) => void;
+        /** Get a validation object. Require the extension Validations. */
+        getValidations: (validationIndex: number | null) => Validation | Validation[];
+        /** Insert or update existing validations by index. Require the extension Validations. */
+        setValidations: (validations: Validations[]) => void;
+        /** Reset validations by validation indexes. Require the extension Validations. */
+        resetValidations: (validationIndex: number | number[]) => void;
     }
 }