@toolbox-web/grid 1.23.3 → 1.23.4

package/lib/plugins/pivot/types.d.ts

@@ -1,12 +1,57 @@
 import { ExpandCollapseAnimation } from '../../core/types';
 export type { ExpandCollapseAnimation } from '../../core/types';
-/** Available aggregation function types */
+/**
+ * Built-in aggregation functions for pivot value fields.
+ *
+ * Each function is applied per-cell to aggregate the matching data rows into a single value:
+ *
+ * | Function | Result | Blank handling |
+ * |----------|--------|----------------|
+ * | `'sum'` | Numeric total of all values | Non-numeric values ignored |
+ * | `'avg'` | Arithmetic mean | Non-numeric values excluded from count |
+ * | `'count'` | Number of rows in the group | Counts all rows including blanks |
+ * | `'min'` | Smallest numeric value | Non-numeric values ignored |
+ * | `'max'` | Largest numeric value | Non-numeric values ignored |
+ * | `'first'` | Value from the first row in the group | May be `undefined` if group is empty |
+ * | `'last'` | Value from the last row in the group | May be `undefined` if group is empty |
+ *
+ * @example
+ * ```typescript
+ * const valueFields: PivotValueField[] = [
+ *   { field: 'revenue', aggFunc: 'sum', header: 'Total Revenue' },
+ *   { field: 'revenue', aggFunc: 'avg', header: 'Avg Revenue' },
+ *   { field: 'orders',  aggFunc: 'count', header: '# Orders' },
+ * ];
+ * ```
+ */
 export type AggFunc = 'sum' | 'avg' | 'count' | 'min' | 'max' | 'first' | 'last';
+/**
+ * Configuration for the pivot plugin.
+ *
+ * Pivot mode transforms flat row data into a cross-tabulation (pivot table)
+ * by grouping rows along one axis (`rowGroupFields`), spreading unique values
+ * of another field across columns (`columnGroupFields`), and computing
+ * aggregate values (`valueFields`) at each intersection.
+ *
+ * @example
+ * ```typescript
+ * new PivotPlugin({
+ *   rowGroupFields: ['department'],
+ *   columnGroupFields: ['quarter'],
+ *   valueFields: [{ field: 'revenue', aggFunc: 'sum' }],
+ *   showTotals: true,
+ *   showGrandTotal: true,
+ * })
+ * ```
+ */
 export interface PivotConfig {
     /** Whether pivot view is active on load (default: true when fields are configured) */
     active?: boolean;
+    /** Fields to group rows by (vertical axis). Multiple fields create nested groups. */
     rowGroupFields?: string[];
+    /** Fields whose unique values become column headers (horizontal axis). */
     columnGroupFields?: string[];
+    /** Value fields to aggregate at each row/column intersection. */
     valueFields?: PivotValueField[];
     showTotals?: boolean;
     showGrandTotal?: boolean;
@@ -25,9 +70,19 @@ export interface PivotConfig {
      */
     animation?: ExpandCollapseAnimation;
 }
+/**
+ * Defines a value field in the pivot table — which data field to aggregate
+ * and how to compute the aggregation.
+ *
+ * Multiple `PivotValueField` entries on the same `field` with different `aggFunc`
+ * values create separate columns (e.g. "Revenue (Sum)" and "Revenue (Avg)").
+ */
 export interface PivotValueField {
+    /** The row data field to aggregate (must exist on the source row objects). */
     field: string;
+    /** Aggregation function to apply (see {@link AggFunc} for options). */
     aggFunc: AggFunc;
+    /** Custom column header label. Defaults to `"field (aggFunc)"` if omitted. */
     header?: string;
 }
 export interface PivotState {
@@ -35,10 +90,20 @@ export interface PivotState {
     pivotResult: PivotResult | null;
     expandedKeys: Set<string>;
 }
+/**
+ * Computed result of the pivot transformation.
+ *
+ * Produced internally by the pivot engine after processing source rows
+ * through the configured `rowGroupFields`, `columnGroupFields`, and `valueFields`.
+ */
 export interface PivotResult {
+    /** Hierarchical pivot rows (group headers + leaf rows). */
     rows: PivotRow[];
+    /** Unique column keys derived from `columnGroupFields` values. */
     columnKeys: string[];
+    /** Per-column totals (keyed by column key). Present when `showTotals` is enabled. */
     totals: Record<string, number>;
+    /** Grand total across all columns. Present when `showGrandTotal` is enabled. */
     grandTotal: number;
 }
 export interface PivotRow {

package/lib/plugins/pivot/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/pivot/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAChE,YAAY,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAEhE,2CAA2C;AAC3C,MAAM,MAAM,OAAO,GAAG,KAAK,GAAG,KAAK,GAAG,OAAO,GAAG,KAAK,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,CAAC;AAEjF,MAAM,WAAW,WAAW;IAC1B,sFAAsF;IACtF,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,WAAW,CAAC,EAAE,eAAe,EAAE,CAAC;IAChC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,6DAA6D;IAC7D,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,2DAA2D;IAC3D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yEAAyE;IACzE,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,uBAAuB,CAAC;CACrC;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;IAChC,YAAY,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,QAAQ,EAAE,CAAC;IACjB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,QAAQ;IACvB,kDAAkD;IAClD,MAAM,EAAE,MAAM,CAAC;IACf,iCAAiC;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,kCAAkC;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC;IACtC,mCAAmC;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wDAAwD;IACxD,OAAO,EAAE,OAAO,CAAC;IACjB,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC;IACtB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAGD,OAAO,QAAQ,kBAAkB,CAAC;IAChC,UAAU,aAAa;QACrB,KAAK,EAAE,OAAO,eAAe,EAAE,WAAW,CAAC;KAC5C;CACF"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/pivot/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAChE,YAAY,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,OAAO,GAAG,KAAK,GAAG,KAAK,GAAG,OAAO,GAAG,KAAK,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,CAAC;AAEjF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,WAAW;IAC1B,sFAAsF;IACtF,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,qFAAqF;IACrF,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,0EAA0E;IAC1E,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,iEAAiE;IACjE,WAAW,CAAC,EAAE,eAAe,EAAE,CAAC;IAChC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,6DAA6D;IAC7D,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,2DAA2D;IAC3D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yEAAyE;IACzE,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,uBAAuB,CAAC;CACrC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B,8EAA8E;IAC9E,KAAK,EAAE,MAAM,CAAC;IACd,uEAAuE;IACvE,OAAO,EAAE,OAAO,CAAC;IACjB,8EAA8E;IAC9E,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;IAChC,YAAY,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,2DAA2D;IAC3D,IAAI,EAAE,QAAQ,EAAE,CAAC;IACjB,kEAAkE;IAClE,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,qFAAqF;IACrF,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,gFAAgF;IAChF,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,QAAQ;IACvB,kDAAkD;IAClD,MAAM,EAAE,MAAM,CAAC;IACf,iCAAiC;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,kCAAkC;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC;IACtC,mCAAmC;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wDAAwD;IACxD,OAAO,EAAE,OAAO,CAAC;IACjB,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC;IACtB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAGD,OAAO,QAAQ,kBAAkB,CAAC;IAChC,UAAU,aAAa;QACrB,KAAK,EAAE,OAAO,eAAe,EAAE,WAAW,CAAC;KAC5C;CACF"}

package/lib/plugins/print/PrintPlugin.d.ts

@@ -49,7 +49,7 @@ import { PrintConfig, PrintParams } from './types';
  * };
  *
  * // Trigger print
- * const printPlugin = grid.getPlugin(PrintPlugin);
+ * const printPlugin = grid.getPluginByName('print');
  * await printPlugin.print();
  * ```
  *