@guiexpert/demo-table-models 1.1.92 → 1.1.94

package/lib/createAggregationModel.d.ts

@@ -0,0 +1,10 @@
+import { TableModelAndOptionsIf } from '@guiexpert/table';
+
+/**
+ * Aggregation demo (since 1.1.94): flat sales orders with three total rows in the footer (sum, average, maximum) and a range
+ * selection model – `tableApi.getSelectionAggregates()` gives the numbers for a status bar.
+ * The totals follow `externalFilterFunction` (set it on the returned options before the table is created).
+ *
+ * @param count - number of orders (default 50,000)
+ */
+export declare function createAggregationModelAndOptions(count?: number): TableModelAndOptionsIf;

package/lib/createLargeModel.d.ts

@@ -1,15 +1,26 @@
 import { AreaModel, CellRendererIf, TableModelAndOptionsIf } from '@guiexpert/table';
 
-export declare function createLargeModelAndOptions(rowcount?: number): TableModelAndOptionsIf;
+/**
+ * Two million rows (or `rowcount`) without row objects: an own body model computes the cells.
+ *
+ * @param rowcount - number of rows
+ * @param rowNumbersVisible - since 1.1.93: a fixed row number column in front ("#", 1 … 2,000,000)
+ */
+export declare function createLargeModelAndOptions(rowcount?: number, rowNumbersVisible?: boolean): TableModelAndOptionsIf;
 export declare class LargeBodyModel extends AreaModel {
     private rowcount;
+    private readonly columnOffset;
     private readonly nf;
     private barRenderer;
-    constructor(rowcount?: number);
+    /**
+     * @param rowcount - number of rows
+     * @param columnOffset - columns in front of the data columns (1 for a RowNumberColumnDef)
+     */
+    constructor(rowcount?: number, columnOffset?: number);
     getRowCount(): number;
     getRowHeight(_rowIndex: number): number;
     getConstantRowHeight(): number | undefined;
-    getValueAt(rowIndex: number, columnIndex: number): number | string;
+    getValueAt(rowIndex: number, col: number): number | string;
     getCellRenderer(_rowIndex: number, columnIndex: number): CellRendererIf | undefined;
     getYPosByRowIndex(rowIndex: number): number;
 }

package/lib/createPivotModel.d.ts

@@ -0,0 +1,24 @@
+import { RowGroupField, TableModelAndOptionsIf } from '@guiexpert/table';
+import { PivotOrderIf } from '../model/pivot-order.if.js';
+
+/**
+ * Deterministic orders for pivot demos: {@link generateSalesOrders} plus an order date between 2024-01-01 and 2026-12-31.
+ *
+ * @param count - number of orders
+ * @param seed - the same seed gives the same orders
+ */
+export declare function generatePivotOrders(count: number, seed?: number): PivotOrderIf[];
+/** The year of an order (pivot field). */
+export declare const pivotYear: RowGroupField<PivotOrderIf>;
+/** The quarter of an order as 1 … 4, shown as "Q1" … "Q4" (pivot field). */
+export declare const pivotQuarter: RowGroupField<PivotOrderIf>;
+/**
+ * Pivot demo (since 1.1.94): orders by country › city (rows) × year › quarter (columns), revenue (sum of total) and
+ * number of orders, year totals (collapsible years), total column and total row. Pivot again at runtime with
+ * `tableApi.setPivotConfig({ columnFields: [pivotYear] })`.
+ *
+ * @param count - number of orders (default 50,000)
+ * @param columnFields - the column fields (default year › quarter)
+ * @param expanded - open row levels (default 0: countries closed)
+ */
+export declare function createPivotModelAndOptions(count?: number, columnFields?: RowGroupField<PivotOrderIf>[], expanded?: number): TableModelAndOptionsIf;

package/lib/createRowGroupModel.d.ts

@@ -0,0 +1,21 @@
+import { ColumnDefIf, RowGroupField, TableModelAndOptionsIf } from '@guiexpert/table';
+import { SalesOrderIf } from '../model/sales-order.if.js';
+
+/**
+ * Deterministic sales orders for row grouping demos (country, city, product, category, quantity, price, total).
+ *
+ * @param count - number of orders
+ * @param seed - the same seed gives the same orders
+ */
+export declare function generateSalesOrders(count: number, seed?: number): SalesOrderIf[];
+/** The columns of {@link generateSalesOrders}. */
+export declare function createSalesOrderColumnDefs(): ColumnDefIf[];
+/**
+ * Row grouping demo (since 1.1.94): orders grouped by country › city (default), with the sum of quantity and total, the
+ * average price and a total row. Regroup at runtime with `tableApi.setRowGroupBy(["category", "product"])`.
+ *
+ * @param count - number of orders (default 50,000)
+ * @param groupBy - the levels (default country › city)
+ * @param expanded - open levels (default 1: countries open, cities closed)
+ */
+export declare function createRowGroupModelAndOptions(count?: number, groupBy?: RowGroupField<SalesOrderIf>[], expanded?: number): TableModelAndOptionsIf;

package/model/pivot-order.if.d.ts

@@ -0,0 +1,6 @@
+import { SalesOrderIf } from './sales-order.if.js';
+
+/** An order of the pivot demo ({@link generatePivotOrders}): a sales order with an order date (ISO, `YYYY-MM-DD`). */
+export interface PivotOrderIf extends SalesOrderIf {
+    date: string;
+}

package/model/sales-order.if.d.ts

@@ -0,0 +1,11 @@
+/** An order of the row grouping demo ({@link generateSalesOrders}). */
+export interface SalesOrderIf {
+    id: number;
+    country: string;
+    city: string;
+    product: string;
+    category: string;
+    quantity: number;
+    price: number;
+    total: number;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guiexpert/demo-table-models",
-  "version": "1.1.92",
+  "version": "1.1.94",
   "license": "MIT",
   "author": "Dr. Marc Kronberg <info@gui.expert> (https://gui.expert)",
   "repository": {
@@ -31,7 +31,7 @@
   },
   "dependencies": {
     "tslib": "^2.3.0",
-    "@guiexpert/table": "^1.1.92"
+    "@guiexpert/table": "^1.1.94"
   },
   "devDependencies": {
     "@types/node": "^20.11.17",