@guiexpert/table 1.1.90 → 1.1.91

package/lib/table/service/excel-service.d.ts

@@ -1,5 +1,28 @@
-import { ExcelServiceIf } from './excel-service.if';
+import { ExcelServiceIf } from './excel-service.if.js';
 
+/**
+ * Writes real `.xlsx` files (Office Open XML) without any library – compressed with the browser's
+ * built-in `CompressionStream`. Numbers stay numbers, everything else becomes text.
+ *
+ * {@link TableApi.downloadExcel} exports what the table shows; use the ExcelService directly for any other data.
+ *
+ * @example
+ * // all rows, own columns – independent of filter and sorting
+ * const body = tableApi.getBodyModel() as AreaModelObjectArray<Order>;
+ * const matrix = [
+ *   ["ID", "Customer", "Total"],
+ *   ...body.getAllRows().map(o => [o.id, o.customer, o.total])
+ * ];
+ * await new ExcelService().downloadExcel(matrix, "orders.xlsx", "GuiExpert");
+ *
+ * @example
+ * // a Blob instead of a download, e.g. for an upload
+ * const blob = await new ExcelService().createExcelBlob(matrix);
+ *
+ * @see Training: [Excel export without a library](https://gui.expert/training/excel-export/)
+ *
+ * @category Export & clipboard
+ */
 export declare class ExcelService implements ExcelServiceIf {
     /**
      * Downloads a matrix data as an Excel file.

package/lib/table/service/excel-service.if.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Writes an Excel file from a matrix of values. The default implementation is {@link ExcelService};
+ * pass your own as last argument of the `TableScope` constructor to change how {@link TableApi.downloadExcel} exports.
+ *
+ * @category Export & clipboard
+ */
 export interface ExcelServiceIf {
+    /** Creates the file from `matrix` (rows of values) and hands it to the browser as download. */
     downloadExcel(matrix: Array<Array<any>>, filename: string, author?: string): void | Promise<void>;
 }

package/lib/table/service/ge-filter.service.d.ts

@@ -1,3 +1,4 @@
+/** @category Sorting & filtering */
 export declare class GeFilterService {
     filterPredict<T>(item: T, filterString: string, toString?: (t: T) => string): boolean;
     filterRows<T>(rows: T[], filterString: string, toString?: (t: T) => string): T[];

package/lib/table/service/simple-dom-service.d.ts

@@ -1,5 +1,6 @@
-import { DomServiceIf } from './dom-service.if';
+import { DomServiceIf } from './dom-service.if.js';
 
+/** @category DOM */
 export declare class SimpleDomService implements DomServiceIf {
     setStyle(el: any, style: string, value: any): any;
     appendText(parent: HTMLDivElement, text: string): HTMLDivElement;
@@ -9,4 +10,5 @@ export declare class SimpleDomService implements DomServiceIf {
     createElement<T>(name: string): T;
     createText(value: string): any;
     setAttribute(ele: HTMLElement, key: string, value: string): void;
+    removeAttribute(ele: HTMLElement, key: string): void;
 }

package/lib/table/service/store-state-collapsed-expand.service.d.ts

@@ -1,7 +1,8 @@
-import { AbstractStoreStateService } from './abstract-store-state.service';
-import { CollapsedExpandedData } from './data/collapsed-expanded.data';
-import { GetStorageKeyFn } from '../data/options/auto-restore-options.if';
+import { AbstractStoreStateService } from './abstract-store-state.service.js';
+import { CollapsedExpandedData } from './data/collapsed-expanded.data.js';
+import { GetStorageKeyFn } from '../data/options/auto-restore-options.if.js';
 
+/** @category Internals */
 export declare class StoreStateCollapsedExpandService extends AbstractStoreStateService {
     private readonly COLLAPSED_EXPANDED_STATE;
     private collapsedExpandedState;

package/lib/table/service/store-state-scroll-pos.service.d.ts

@@ -1,6 +1,7 @@
-import { AbstractStoreStateService } from './abstract-store-state.service';
-import { GetStorageKeyFn } from '../data/options/auto-restore-options.if';
+import { AbstractStoreStateService } from './abstract-store-state.service.js';
+import { GetStorageKeyFn } from '../data/options/auto-restore-options.if.js';
 
+/** @category Internals */
 export declare class StoreStateScrollPosService extends AbstractStoreStateService {
     private readonly SCROLL_STATE;
     private scrollOffset;

package/lib/table/service/store-state-sorting.service.d.ts

@@ -1,7 +1,8 @@
-import { AbstractStoreStateService } from './abstract-store-state.service';
-import { GetStorageKeyFn } from '../data/options/auto-restore-options.if';
-import { SortItem } from '../data/common/sort-item';
+import { AbstractStoreStateService } from './abstract-store-state.service.js';
+import { GetStorageKeyFn } from '../data/options/auto-restore-options.if.js';
+import { SortItem } from '../data/common/sort-item.js';
 
+/** @category Internals */
 export declare class StoreStateSortingService extends AbstractStoreStateService {
     private readonly SORTING_STATE;
     private sortItems;

package/lib/table/service/tree-row.service.d.ts

@@ -1,6 +1,10 @@
-import { TreeRowIf } from '../data/common/tree-row-if';
+import { TreeRowIf } from '../data/common/tree-row-if.js';
 
+/** @category Tree & checkboxes */
 export declare class TreeRowService {
     flattenTree<T>(rows: TreeRowIf<T>[], ret?: TreeRowIf<T>[]): TreeRowIf<T>[];
+    /** The children of a visible, expanded row are visible – collapsed subtrees are not walked at all
+     *  (before, every node of the tree was visited and checked up to the root on every expand/collapse). */
+    private flattenVisibleChildren;
     isVisible(row: TreeRowIf<any>): boolean;
 }