@niicojs/excel 0.2.5 → 0.2.7

package/dist/index.d.ts

@@ -89,10 +89,12 @@ type AggregationType = 'sum' | 'count' | 'average' | 'min' | 'max';
 interface PivotValueConfig {
     /** Source field name (column header) */
     field: string;
-    /** Aggregation function */
-    aggregation: AggregationType;
+    /** Aggregation function (default: 'sum') */
+    aggregation?: AggregationType;
     /** Display name (e.g., "Sum of Sales") */
     name?: string;
+    /** Number format (e.g., '$#,##0.00', '0.00%') */
+    numberFormat?: string;
 }
 /**
  * Configuration for creating a pivot table
@@ -521,6 +523,12 @@ declare class Styles {
     private _findOrCreateFill;
     private _findOrCreateBorder;
     private _findOrCreateNumFmt;
+    /**
+     * Get or create a number format ID for the given format string.
+     * Returns built-in IDs (0-163) for standard formats, or creates custom IDs (164+).
+     * @param format - The number format string (e.g., '0.00', '#,##0', '$#,##0.00')
+     */
+    getOrCreateNumFmtId(format: string): number;
     /**
      * Check if styles have been modified
      */
@@ -620,6 +628,7 @@ declare class PivotTable {
     private _valueFields;
     private _filterFields;
     private _pivotTableIndex;
+    private _styles;
     constructor(name: string, cache: PivotCache, targetSheet: string, targetCell: string, targetRow: number, targetCol: number, pivotTableIndex: number);
     /**
      * Get the pivot table name
@@ -641,6 +650,11 @@ declare class PivotTable {
      * Get the pivot table index (for file naming)
      */
     get index(): number;
+    /**
+     * Set the styles reference for number format resolution
+     * @internal
+     */
+    setStyles(styles: Styles): this;
     /**
      * Add a field to the row area
      * @param fieldName - Name of the source field (column header)
@@ -652,12 +666,21 @@ declare class PivotTable {
      */
     addColumnField(fieldName: string): this;
     /**
-     * Add a field to the values area with aggregation
-     * @param fieldName - Name of the source field (column header)
-     * @param aggregation - Aggregation function (sum, count, average, min, max)
-     * @param displayName - Optional display name (defaults to "Sum of FieldName")
+     * Add a field to the values area with aggregation.
+     *
+     * Supports two call signatures:
+     * - Positional: `addValueField(fieldName, aggregation?, displayName?, numberFormat?)`
+     * - Object: `addValueField({ field, aggregation?, name?, numberFormat? })`
+     *
+     * @example
+     * // Positional arguments
+     * pivot.addValueField('Sales', 'sum', 'Total Sales', '$#,##0.00');
+     *
+     * // Object form
+     * pivot.addValueField({ field: 'Sales', aggregation: 'sum', name: 'Total Sales', numberFormat: '$#,##0.00' });
      */
-    addValueField(fieldName: string, aggregation?: AggregationType, displayName?: string): this;
+    addValueField(config: PivotValueConfig): this;
+    addValueField(fieldName: string, aggregation?: AggregationType, displayName?: string, numberFormat?: string): this;
     /**
      * Add a field to the filter (page) area
      * @param fieldName - Name of the source field (column header)