@toolbox-web/grid 1.23.3 → 1.23.4

package/lib/plugins/pinned-rows/types.d.ts

@@ -1,11 +1,49 @@
 import { ColumnConfig } from '../../core/types';
-/** Position of the status bar relative to the grid */
+/**
+ * Position of the status bar (info bar) relative to the grid body.
+ *
+ * - `'top'` — Renders above the grid header. Useful for summary toolbars.
+ * - `'bottom'` — Renders below the grid body (default). Standard placement for status information.
+ */
 export type PinnedRowsPosition = 'top' | 'bottom';
-/** Aggregator function signature */
+/**
+ * Custom aggregation function signature.
+ *
+ * Receives all current rows, the target field name, and optionally the column config.
+ * Should return a single aggregated value (number, string, etc.) for display in the
+ * aggregation row cell.
+ *
+ * @example
+ * ```typescript
+ * const weightedAvg: AggregatorFn = (rows, field, column) => {
+ *   const total = rows.reduce((sum, r) => sum + (r[field] * r.weight), 0);
+ *   const weights = rows.reduce((sum, r) => sum + r.weight, 0);
+ *   return weights ? total / weights : 0;
+ * };
+ * ```
+ */
 export type AggregatorFn = (rows: unknown[], field: string, column?: ColumnConfig) => unknown;
-/** Aggregator formatter function - formats the computed value for display */
+/**
+ * Formats the computed aggregation value for display in the cell.
+ *
+ * Called after the aggregator function runs. Receives the raw computed value
+ * and should return a display string (e.g. currency formatting, unit suffixes).
+ *
+ * @example
+ * ```typescript
+ * const currencyFormatter: AggregatorFormatter = (value) =>
+ *   `$${Number(value).toLocaleString('en-US', { minimumFractionDigits: 2 })}`;
+ * ```
+ */
 export type AggregatorFormatter = (value: unknown, field: string, column?: ColumnConfig) => string;
-/** Simple aggregator reference - string key for built-in or custom function */
+/**
+ * Shorthand aggregator reference — either a built-in name or a custom function.
+ *
+ * Built-in names: `'sum'`, `'avg'`, `'min'`, `'max'`, `'count'`, `'first'`, `'last'`.
+ * Pass a custom {@link AggregatorFn} for non-standard aggregations.
+ *
+ * Use {@link AggregatorConfig} instead when you also need a custom formatter.
+ */
 export type AggregatorRef = string | AggregatorFn;
 /** Full aggregator config with optional formatter */
 export interface AggregatorConfig {

package/lib/plugins/pinned-rows/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/pinned-rows/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD,sDAAsD;AACtD,MAAM,MAAM,kBAAkB,GAAG,KAAK,GAAG,QAAQ,CAAC;AAElD,oCAAoC;AACpC,MAAM,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,KAAK,OAAO,CAAC;AAE9F,6EAA6E;AAC7E,MAAM,MAAM,mBAAmB,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,KAAK,MAAM,CAAC;AAEnG,+EAA+E;AAC/E,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,YAAY,CAAC;AAElD,qDAAqD;AACrD,MAAM,WAAW,gBAAgB;IAC/B,qGAAqG;IACrG,OAAO,EAAE,aAAa,CAAC;IACvB,kEAAkE;IAClE,SAAS,CAAC,EAAE,mBAAmB,CAAC;CACjC;AAED,2EAA2E;AAC3E,MAAM,MAAM,oBAAoB,GAAG,aAAa,GAAG,gBAAgB,CAAC;AAEpE;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,mEAAmE;IACnE,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,0FAA0F;IAC1F,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC;IAC5B,+DAA+D;IAC/D,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,MAAM,CAAC,CAAC;IACxE,oDAAoD;IACpD,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,KAAK,OAAO,CAAC,CAAC,CAAC;IAChH;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;CACpD;AAED,sDAAsD;AACtD,MAAM,WAAW,gBAAgB;IAC/B,mDAAmD;IACnD,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B,uDAAuD;IACvD,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,0DAA0D;IAC1D,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,oEAAoE;IACpE,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,+CAA+C;IAC/C,YAAY,CAAC,EAAE,eAAe,EAAE,CAAC;IACjC,iEAAiE;IACjE,eAAe,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACzC;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,iDAAiD;AACjD,MAAM,WAAW,eAAe;IAC9B,sCAAsC;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,qCAAqC;IACrC,QAAQ,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;IACtC,4CAA4C;IAC5C,MAAM,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,WAAW,GAAG,MAAM,CAAC;CAC9D;AAED,0CAA0C;AAC1C,MAAM,WAAW,iBAAiB;IAChC,uCAAuC;IACvC,SAAS,EAAE,MAAM,CAAC;IAClB,qCAAqC;IACrC,YAAY,EAAE,MAAM,CAAC;IACrB,8BAA8B;IAC9B,YAAY,EAAE,MAAM,CAAC;IACrB,mCAAmC;IACnC,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,uBAAuB;IACvB,IAAI,EAAE,OAAO,EAAE,CAAC;IAChB,oCAAoC;IACpC,IAAI,EAAE,WAAW,CAAC;CACnB;AAED,sDAAsD;AACtD,MAAM,WAAW,eAAe;IAC9B,+BAA+B;IAC/B,cAAc,EAAE,WAAW,GAAG,IAAI,CAAC;IACnC,qCAAqC;IACrC,uBAAuB,EAAE,WAAW,GAAG,IAAI,CAAC;IAC5C,wCAAwC;IACxC,0BAA0B,EAAE,WAAW,GAAG,IAAI,CAAC;IAC/C,gDAAgD;IAChD,aAAa,EAAE,WAAW,GAAG,IAAI,CAAC;CACnC;AAGD,OAAO,QAAQ,kBAAkB,CAAC;IAChC,UAAU,aAAa;QACrB,UAAU,EAAE,OAAO,oBAAoB,EAAE,gBAAgB,CAAC;KAC3D;CACF"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/pinned-rows/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG,KAAK,GAAG,QAAQ,CAAC;AAElD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,KAAK,OAAO,CAAC;AAE9F;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,KAAK,MAAM,CAAC;AAEnG;;;;;;;GAOG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,YAAY,CAAC;AAElD,qDAAqD;AACrD,MAAM,WAAW,gBAAgB;IAC/B,qGAAqG;IACrG,OAAO,EAAE,aAAa,CAAC;IACvB,kEAAkE;IAClE,SAAS,CAAC,EAAE,mBAAmB,CAAC;CACjC;AAED,2EAA2E;AAC3E,MAAM,MAAM,oBAAoB,GAAG,aAAa,GAAG,gBAAgB,CAAC;AAEpE;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,mEAAmE;IACnE,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,0FAA0F;IAC1F,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC;IAC5B,+DAA+D;IAC/D,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,MAAM,CAAC,CAAC;IACxE,oDAAoD;IACpD,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,KAAK,OAAO,CAAC,CAAC,CAAC;IAChH;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;CACpD;AAED,sDAAsD;AACtD,MAAM,WAAW,gBAAgB;IAC/B,mDAAmD;IACnD,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B,uDAAuD;IACvD,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,0DAA0D;IAC1D,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,oEAAoE;IACpE,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,+CAA+C;IAC/C,YAAY,CAAC,EAAE,eAAe,EAAE,CAAC;IACjC,iEAAiE;IACjE,eAAe,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACzC;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,iDAAiD;AACjD,MAAM,WAAW,eAAe;IAC9B,sCAAsC;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,qCAAqC;IACrC,QAAQ,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;IACtC,4CAA4C;IAC5C,MAAM,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,WAAW,GAAG,MAAM,CAAC;CAC9D;AAED,0CAA0C;AAC1C,MAAM,WAAW,iBAAiB;IAChC,uCAAuC;IACvC,SAAS,EAAE,MAAM,CAAC;IAClB,qCAAqC;IACrC,YAAY,EAAE,MAAM,CAAC;IACrB,8BAA8B;IAC9B,YAAY,EAAE,MAAM,CAAC;IACrB,mCAAmC;IACnC,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,uBAAuB;IACvB,IAAI,EAAE,OAAO,EAAE,CAAC;IAChB,oCAAoC;IACpC,IAAI,EAAE,WAAW,CAAC;CACnB;AAED,sDAAsD;AACtD,MAAM,WAAW,eAAe;IAC9B,+BAA+B;IAC/B,cAAc,EAAE,WAAW,GAAG,IAAI,CAAC;IACnC,qCAAqC;IACrC,uBAAuB,EAAE,WAAW,GAAG,IAAI,CAAC;IAC5C,wCAAwC;IACxC,0BAA0B,EAAE,WAAW,GAAG,IAAI,CAAC;IAC/C,gDAAgD;IAChD,aAAa,EAAE,WAAW,GAAG,IAAI,CAAC;CACnC;AAGD,OAAO,QAAQ,kBAAkB,CAAC;IAChC,UAAU,aAAa;QACrB,UAAU,EAAE,OAAO,oBAAoB,EAAE,gBAAgB,CAAC;KAC3D;CACF"}