@guiexpert/demo-table-models 1.1.93 → 1.1.96

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/createFormulaModel.d.ts

@@ -0,0 +1,32 @@
+import { ColumnDefIf, TableModelAndOptionsIf } from '@guiexpert/table';
+
+/** One line of an invoice – the data has no net, VAT or gross: formulas compute them. */
+export interface InvoiceLineIf {
+    id: number;
+    country: string;
+    product: string;
+    quantity: number;
+    price: number;
+    /** discount in percent (0, 5, 10, 15) */
+    discount: number;
+}
+/** Invoice lines with a fixed seed: the sales orders of the row grouping demo plus a discount. */
+export declare function generateInvoiceLines(count: number, seed?: number): InvoiceLineIf[];
+/** The formulas of the demo (also shown on the website). */
+export declare const INVOICE_FORMULAS: {
+    readonly net: "ROUND([quantity] * [price] * (1 - [discount] / 100), 2)";
+    readonly vat: "ROUND([net] * 0.19, 2)";
+    readonly gross: "[net] + [vat]";
+    readonly custom: "IF([discount] > 0, ROUND([gross] / [quantity], 2), \"–\")";
+};
+/** The columns: data (price and discount editable), formulas for net, VAT, gross, a share, a rank and a custom formula. */
+export declare function createInvoiceColumnDefs(customFormula?: string): ColumnDefIf[];
+/**
+ * Formula demo (since 1.1.95): invoice lines whose net, VAT and gross are formula columns (`ColumnDef.create({ formula })`),
+ * a share of the net total and a rank („Show values as“), a custom formula (change it with
+ * `tableApi.setColumnFormula("custom", text)`) and a total row (`footerAggregates` over the calculated columns).
+ * Price, quantity and discount are editable – the formulas follow.
+ *
+ * @param count - number of invoice lines (default 2,000)
+ */
+export declare function createFormulaModelAndOptions(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/createPriceListModel.d.ts

@@ -0,0 +1,20 @@
+import { TableModelAndOptionsIf, BatchEditOptionsIf, FillHandleOptionsIf } from '@guiexpert/table';
+import { PriceItemIf } from '../model/price-item.if.js';
+
+/**
+ * A fixed price list for fill handle and batch edit demos (since 1.1.96): `count` articles with SKU, product, category,
+ * valid-from date, price, discount and stock. The same count gives the same articles.
+ *
+ * @param count - number of articles (default 16)
+ */
+export declare function generatePriceItems(count?: number): PriceItemIf[];
+/**
+ * Fill handle and batch edit demo (since 1.1.96): a price list with range selection and the fill handle; price, discount,
+ * valid-from and stock are editable (and checked), "Net" is calculated (not filled). With `batchEdit` changes are
+ * collected until `tableApi.commitBatchEdit()` ("Save") or `cancelBatchEdit()` ("Discard").
+ *
+ * @param items - the rows (default: {@link generatePriceItems})
+ * @param batchEdit - collect changes (`tableOptions.batchEdit`), default `true`
+ * @param fillHandle - fill handle options, default `true`
+ */
+export declare function createPriceListModelAndOptions(items?: PriceItemIf[], batchEdit?: boolean | Partial<BatchEditOptionsIf>, fillHandle?: boolean | Partial<FillHandleOptionsIf>): TableModelAndOptionsIf;

package/lib/createRowDragModel.d.ts

@@ -0,0 +1,19 @@
+import { TableModelAndOptionsIf, RowDragOptionsIf } from '@guiexpert/table';
+import { TaskIf } from '../model/task.if.js';
+
+/**
+ * A fixed priority list for row drag demos (since 1.1.95): `count` tasks (title, owner, status, estimate in hours).
+ * The same count gives the same tasks; the first task is `locked` (no drag handle) when `withLocked` is true.
+ *
+ * @param count - number of tasks (default 20; titles repeat with a number above 20)
+ * @param withLocked - mark the first task as locked
+ */
+export declare function generateTasks(count?: number, withLocked?: boolean): TaskIf[];
+/**
+ * Row drag demo (since 1.1.95): a priority list with row numbers ("#" = the position), a drag handle in the title column
+ * (not for locked tasks), multi-row selection and focus. Drag a grip – or press Ctrl+Alt+↑/↓.
+ *
+ * @param tasks - the rows (default: {@link generateTasks}) – reordered in place by the table (managed)
+ * @param rowDragOptions - e.g. `{ managed: false }` for events only
+ */
+export declare function createRowDragModelAndOptions(tasks?: TaskIf[], rowDragOptions?: Partial<RowDragOptionsIf>): 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/lib/createTimeTableModel.d.ts

@@ -55,5 +55,8 @@ export declare const tableOptions: {
     ariaDescribedBy?: string | undefined;
     ariaTexts?: Partial<import('@guiexpert/table').AriaTextsIf> | undefined;
     overlayOptions?: Partial<import('@guiexpert/table').OverlayOptionsIf> | undefined;
+    rowDragOptions?: Partial<import('@guiexpert/table').RowDragOptionsIf> | undefined;
+    fillHandle?: boolean | Partial<import('@guiexpert/table').FillHandleOptionsIf> | undefined;
+    batchEdit?: boolean | Partial<import('@guiexpert/table').BatchEditOptionsIf> | undefined;
 };
 export declare function createTimeTableModel(): TableModelIf;

package/lib/treepeople/generateTreePeopleModel.d.ts

@@ -55,6 +55,9 @@ export declare function createTreePeopleTableOptions(addDemoSelection?: boolean)
     ariaDescribedBy?: string | undefined;
     ariaTexts?: Partial<import('@guiexpert/table').AriaTextsIf> | undefined;
     overlayOptions?: Partial<import('@guiexpert/table').OverlayOptionsIf> | undefined;
+    rowDragOptions?: Partial<import('@guiexpert/table').RowDragOptionsIf> | undefined;
+    fillHandle?: boolean | Partial<import('@guiexpert/table').FillHandleOptionsIf> | undefined;
+    batchEdit?: boolean | Partial<import('@guiexpert/table').BatchEditOptionsIf> | undefined;
 };
 export declare function createTreePeopleColumnDefs(): ColumnDefIf[];
 export declare function createTreePeopleModelAndOptions(addDemoSelection?: boolean): 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/price-item.if.d.ts

@@ -0,0 +1,13 @@
+/** An article of the price list demo (fill handle and batch edit, since 1.1.96). */
+export interface PriceItemIf {
+    id: number;
+    sku: string;
+    product: string;
+    category: string;
+    /** ISO date `YYYY-MM-DD` */
+    validFrom: string;
+    price: number;
+    /** percent, 0 … 50 */
+    discount: number;
+    stock: number;
+}

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/model/task.if.d.ts

@@ -0,0 +1,9 @@
+/** A task of the priority list demo (row drag, since 1.1.95). */
+export interface TaskIf {
+    id: number;
+    title: string;
+    owner: string;
+    status: "todo" | "doing" | "done";
+    estimate: number;
+    locked?: boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guiexpert/demo-table-models",
-  "version": "1.1.93",
+  "version": "1.1.96",
   "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.93"
+    "@guiexpert/table": "^1.1.96"
   },
   "devDependencies": {
     "@types/node": "^20.11.17",