@guiexpert/demo-table-models 1.0.23 → 1.0.24

package/index.cjs

@@ -10,7 +10,7 @@
                 data-col-index="${a}"
                 data-input-type="text"
                 style="width:calc(100% - 8px);height:100%;border:0;padding:0 0 0 8px;"
-                class="ge-table-cell-editor-input">`}}}class q{constructor(e="none",r="single"){this.selectionType=e,this.selectionMode=r,this.ranges=[],this.negativeRanges=[],this.allSelected=!1,this.silent=!1,this.listenerArr=[]}getEventSelectionChangedListeners(){return this.listenerArr}addEventSelectionChangedListener(e){this.listenerArr.includes(e)||this.listenerArr.push(e)}removeEventSelectionChangedListener(e){const r=this.listenerArr.indexOf(e,0);r>-1&&this.listenerArr.splice(r,1)}fireChangeEvent(){this.silent||this.listenerArr.forEach(e=>e.onSelectionChanged(this))}firstClick(e,r){this.selectionType==="row"?this.addRange(o.singleRow(e)):this.selectionType==="column"&&this.addRange(o.singleColumn(r))}getSelectionCount(e,r){let a=0;for(const t of this.ranges)t.isInRange(e,r)&&a++;return this.allSelected&&a++,this.isInNegativeRange(e,r)&&(a=0),a}isInNegativeRange(e,r){for(const a of this.negativeRanges)if(a.isInRange(e,r))return!0;return!1}getRanges(){return this.ranges}clear(){this.ranges=[],this.negativeRanges=[],this.allSelected=!1,this.fireChangeEvent()}hasSelection(){return this.allSelected||!!this.ranges.length}hasNoSelection(){return!this.hasSelection()}getMergedRowIndices(){const e=new Set;for(const r of this.ranges)for(let a=r.r1;a<=r.r2;a++)!e.has(a)&&!this.isInNegativeRange(a,0)&&e.add(a);return Array.from(e)}selectAll(){this.allSelected=!0,this.fireChangeEvent()}isAllSelected(){return this.allSelected}addSelection(e){this.addRange(e),this.fireChangeEvent()}removeSelection(e){if(this.selectionType==="none")return;let r=e;this.selectionType==="row"?r=o.singleRow(e.r1):this.selectionType==="column"&&(r=o.singleColumn(e.c1)),this.negativeRanges.push(r),this.fireChangeEvent()}togglePoint(e,r){this.getSelectionCount(e,r)>0?this.removeSelection(o.singleCell(e,r)):this.addSelection(o.singleCell(e,r))}isSelected(e,r){return this.getSelectionCount(e,r)>0}addRange(e){this.selectionType!=="none"&&(this.allSelected=!1,this.selectionMode==="single"&&(this.ranges=[]),this.selectionType==="row"?(e.c1=0,e.c2=Number.MAX_SAFE_INTEGER):this.selectionType==="column"?(e.r1=0,e.r2=Number.MAX_SAFE_INTEGER):this.selectionType==="cell"?(e.r2=e.r1,e.c2=e.c1):this.selectionType,this.ranges.push(e),this.fireChangeEvent())}}class Xe{constructor(e="none"){this.selectionType=e,this.rowIndex=-1,this.columnIndex=-1,this.changed=!1,this.listenerArr=[]}getEventFocusChangedListeners(){return this.listenerArr}addEventFocusChangedListener(e){this.listenerArr.includes(e)||this.listenerArr.push(e)}removeEventFocusChangedListener(e){const r=this.listenerArr.indexOf(e,0);r>-1&&this.listenerArr.splice(r,1)}fireChangeEvent(){this.listenerArr.forEach(e=>e.onFocusChanged(this))}clearChanged(){this.changed=!1}hasChanged(){return this.changed}clear(){this.rowIndex=-1,this.columnIndex=-1,this.fireChangeEvent()}setFocus(e,r){(this.rowIndex!==e||this.columnIndex!==r)&&(this.rowIndex=e,this.columnIndex=r,this.changed=!0,this.fireChangeEvent())}hasFocus(e,r){return this.rowIndex===e&&this.columnIndex===r}getFocus(){return[this.rowIndex,this.columnIndex]}}class ee{constructor(e=new w("❯","",["gt-table-icon-expanded"]),r=new w("❯","transform: rotate(180deg) translate(-100%, -100%); transform-origin: 0 0;",["ge-table-icon-collapsed"])){this.iconExpanded=e,this.iconCollapsed=r}}const Ye=new q,Je=new Xe("cell");class z{constructor(){this.overflowX="auto",this.overflowY="auto",this.horizontalBorderVisible=!0,this.verticalBorderVisible=!0,this.footerSeparatorBorderVisible=!0,this.headerSeparatorBorderVisible=!0,this.fixedEastSeparatorBorderVisible=!0,this.fixedWestSeparatorBorderVisible=!0,this.tableTopBorderVisible=!0,this.tableBottomBorderVisible=!0,this.hoverRowVisible=!0,this.hoverColumnVisible=!0,this.columnsResizable=!0,this.columnsDraggable=!0,this.columnResizeHandleWidthInPx=4,this.defaultRowHeights={header:34,body:34,footer:34},this.footerVerticalSeparator=!1,this.headerToggleExpandCollapseIcons=!1,this.headerVerticalSeparator=!1,this.treeOptions=new We,this.headerGroupOptions=new ee,this.showCheckboxWihoutExtraColumn=!1,this.externalFilterFunction=void 0,this.sortedOptions=new Ke,this.sortOrder=["asc","desc"],this.getEditRenderer=(e,r)=>new je,this.getSelectionModel=()=>Ye,this.getFocusModel=()=>Je}}const D=class D{createContent(e,r,a){return new Promise((t,n)=>{if(r!=null&&r.hasSelection()){const m=this.mergeRanges(r.getRanges());if(m){m.c2=Math.min(m.c2,e.getColumnCount()-1),m.r2=Math.min(m.r2,e.getBodyModel().getRowCount()-1);const d=[];for(let i=m.r1;i<=m.r2;i++){const u=[];for(let p=m.c1;p<=m.c2;p++){const c=r.isSelected(i,p)?e.getBodyModel().getTextValueAt(i,p):"";u.push(c)}d.push(u.join(D.columnSeparatorChar))}return t(d.join(D.rowSeparatorChar))}}if(a){const[m,d]=a.getFocus(),i=e.getBodyModel().getTextValueAt(m,d);return t(i)}n("Cannot copy, neither selection nor focus defined.")})}copyContent(e){return navigator.clipboard.writeText(e)}copyToClipboard(e,r,a){return new Promise((t,n)=>{this.createContent(e,r,a).then(m=>{m&&this.copyContent(m).then(d=>{t(m)}).catch(d=>{n()})}).catch(m=>{n()})})}mergeRanges(e){let r;for(const a of e)r?(r.r1=Math.min(r.r1,a.r1),r.c1=Math.min(r.c1,a.c1),r.r2=Math.max(r.r2,a.r2),r.c2=Math.max(r.c2,a.c2)):r=new o(a.r1,a.c1,a.r2,a.c2);return r}};D.columnSeparatorChar="	",D.rowSeparatorChar=`
+                class="ge-table-cell-editor-input">`}}}class q{constructor(e="none",r="single"){this.selectionType=e,this.selectionMode=r,this.ranges=[],this.negativeRanges=[],this.allSelected=!1,this.silent=!1,this.listenerArr=[]}getEventSelectionChangedListeners(){return this.listenerArr}addEventSelectionChangedListener(e){this.listenerArr.includes(e)||this.listenerArr.push(e)}removeEventSelectionChangedListener(e){const r=this.listenerArr.indexOf(e,0);r>-1&&this.listenerArr.splice(r,1)}fireChangeEvent(){this.silent||this.listenerArr.forEach(e=>e.onSelectionChanged(this))}firstClick(e,r){this.selectionType==="row"?this.addRange(o.singleRow(e)):this.selectionType==="column"&&this.addRange(o.singleColumn(r))}getSelectionCount(e,r){let a=0;for(const t of this.ranges)t.isInRange(e,r)&&a++;return this.allSelected&&a++,this.isInNegativeRange(e,r)&&(a=0),a}isInNegativeRange(e,r){for(const a of this.negativeRanges)if(a.isInRange(e,r))return!0;return!1}getRanges(){return this.ranges}clear(){this.ranges=[],this.negativeRanges=[],this.allSelected=!1,this.fireChangeEvent()}hasSelection(){return this.allSelected||!!this.ranges.length}hasNoSelection(){return!this.hasSelection()}getMergedRowIndices(){const e=new Set;for(const r of this.ranges)for(let a=r.r1;a<=r.r2;a++)!e.has(a)&&!this.isInNegativeRange(a,0)&&e.add(a);return Array.from(e)}selectAll(){this.allSelected=!0,this.fireChangeEvent()}isAllSelected(){return this.allSelected}addSelection(e){this.addRange(e),this.fireChangeEvent()}removeSelection(e){if(this.selectionType==="none")return;let r=e;this.selectionType==="row"?r=o.singleRow(e.r1):this.selectionType==="column"&&(r=o.singleColumn(e.c1)),this.negativeRanges.push(r),this.fireChangeEvent()}togglePoint(e,r){this.getSelectionCount(e,r)>0?this.removeSelection(o.singleCell(e,r)):this.addSelection(o.singleCell(e,r))}isSelected(e,r){return this.getSelectionCount(e,r)>0}addRange(e){this.selectionType!=="none"&&(this.allSelected=!1,this.selectionMode==="single"&&(this.ranges=[]),this.selectionType==="row"?(e.c1=0,e.c2=Number.MAX_SAFE_INTEGER):this.selectionType==="column"?(e.r1=0,e.r2=Number.MAX_SAFE_INTEGER):this.selectionType==="cell"?(e.r2=e.r1,e.c2=e.c1):this.selectionType,this.ranges.push(e),this.fireChangeEvent())}}class Xe{constructor(e="none"){this.selectionType=e,this.rowIndex=-1,this.columnIndex=-1,this.changed=!1,this.listenerArr=[]}getEventFocusChangedListeners(){return this.listenerArr}addEventFocusChangedListener(e){this.listenerArr.includes(e)||this.listenerArr.push(e)}removeEventFocusChangedListener(e){const r=this.listenerArr.indexOf(e,0);r>-1&&this.listenerArr.splice(r,1)}fireChangeEvent(){this.listenerArr.forEach(e=>e.onFocusChanged(this))}clearChanged(){this.changed=!1}hasChanged(){return this.changed}clear(){this.rowIndex=-1,this.columnIndex=-1,this.fireChangeEvent()}setFocus(e,r){(this.rowIndex!==e||this.columnIndex!==r)&&(this.rowIndex=e,this.columnIndex=r,this.changed=!0,this.fireChangeEvent())}hasFocus(e,r){return this.rowIndex===e&&this.columnIndex===r}getFocus(){return[this.rowIndex,this.columnIndex]}}class ee{constructor(e=new w("❯","",["gt-table-icon-expanded"]),r=new w("❯","transform: rotate(180deg) translate(-100%, -100%); transform-origin: 0 0;",["ge-table-icon-collapsed"])){this.iconExpanded=e,this.iconCollapsed=r}}const Ye=new q,Je=new Xe("cell");class z{constructor(){this.overflowX="auto",this.overflowY="auto",this.horizontalBorderVisible=!0,this.verticalBorderVisible=!0,this.footerSeparatorBorderVisible=!0,this.headerSeparatorBorderVisible=!0,this.fixedEastSeparatorBorderVisible=!0,this.fixedWestSeparatorBorderVisible=!0,this.tableTopBorderVisible=!0,this.tableBottomBorderVisible=!0,this.hoverRowVisible=!0,this.hoverColumnVisible=!0,this.columnsResizable=!0,this.columnsDraggable=!0,this.columnResizeHandleWidthInPx=4,this.defaultRowHeights={header:34,body:34,footer:34},this.footerVerticalSeparator=!1,this.headerToggleExpandCollapseIcons=!1,this.headerVerticalSeparator=!1,this.treeOptions=new We,this.headerGroupOptions=new ee,this.showCheckboxWihoutExtraColumn=!1,this.externalFilterFunction=void 0,this.sortedOptions=new Ke,this.sortOrder=["asc","desc"],this.resizeEventDebounceDelay=500,this.getEditRenderer=(e,r)=>new je,this.getSelectionModel=()=>Ye,this.getFocusModel=()=>Je}}const D=class D{createContent(e,r,a){return new Promise((t,n)=>{if(r!=null&&r.hasSelection()){const m=this.mergeRanges(r.getRanges());if(m){m.c2=Math.min(m.c2,e.getColumnCount()-1),m.r2=Math.min(m.r2,e.getBodyModel().getRowCount()-1);const d=[];for(let i=m.r1;i<=m.r2;i++){const u=[];for(let p=m.c1;p<=m.c2;p++){const c=r.isSelected(i,p)?e.getBodyModel().getTextValueAt(i,p):"";u.push(c)}d.push(u.join(D.columnSeparatorChar))}return t(d.join(D.rowSeparatorChar))}}if(a){const[m,d]=a.getFocus(),i=e.getBodyModel().getTextValueAt(m,d);return t(i)}n("Cannot copy, neither selection nor focus defined.")})}copyContent(e){return navigator.clipboard.writeText(e)}copyToClipboard(e,r,a){return new Promise((t,n)=>{this.createContent(e,r,a).then(m=>{m&&this.copyContent(m).then(d=>{t(m)}).catch(d=>{n()})}).catch(m=>{n()})})}mergeRanges(e){let r;for(const a of e)r?(r.r1=Math.min(r.r1,a.r1),r.c1=Math.min(r.c1,a.c1),r.r2=Math.max(r.r2,a.r2),r.c2=Math.max(r.c2,a.c2)):r=new o(a.r1,a.c1,a.r2,a.c2);return r}};D.columnSeparatorChar="	",D.rowSeparatorChar=`
 `;let me=D;const $=class ${};$.themes=["light","combat","paper","blackboard"],$.vars={light:`html[data-theme="light"] {
   --ge-table-bg: rgba(255,255,255, 0.5);
   --ge-table-header-west-bg: rgba(233, 233, 233, 0.5);

package/index.js

@@ -236,7 +236,7 @@ class z {
       header: 34,
       body: 34,
       footer: 34
-    }, this.footerVerticalSeparator = !1, this.headerToggleExpandCollapseIcons = !1, this.headerVerticalSeparator = !1, this.treeOptions = new ke(), this.headerGroupOptions = new ee(), this.showCheckboxWihoutExtraColumn = !1, this.externalFilterFunction = void 0, this.sortedOptions = new Re(), this.sortOrder = ["asc", "desc"], this.getEditRenderer = (e, r) => new De(), this.getSelectionModel = () => Ue, this.getFocusModel = () => Me;
+    }, this.footerVerticalSeparator = !1, this.headerToggleExpandCollapseIcons = !1, this.headerVerticalSeparator = !1, this.treeOptions = new ke(), this.headerGroupOptions = new ee(), this.showCheckboxWihoutExtraColumn = !1, this.externalFilterFunction = void 0, this.sortedOptions = new Re(), this.sortOrder = ["asc", "desc"], this.resizeEventDebounceDelay = 500, this.getEditRenderer = (e, r) => new De(), this.getSelectionModel = () => Ue, this.getFocusModel = () => Me;
   }
 }
 const D = class D {
@@ -1520,6 +1520,42 @@ class I extends Ee {
   }
 }
 class f {
+  /**
+   * TableFactory
+   *
+   * This class is responsible for creating table models based on various
+   * parameters and configurations. TableFactory provides different methods
+   * to create these models that must comply with TableModelIf interface.
+   *
+   * Methods:
+   *
+   * createTableModel(p: Partial<{...}>): TableModelIf
+   * Receives a set of parameters as a Partial object with a number of properties
+   * and returns an instance of an object that complies to TableModelIf interface.
+   * Refer to the method's documentation for details.
+   *
+   * buildByTypedRowsParam(param: {rows: T[]; columnDefs: ColumnDefIf[]; tableOptions?: TableOptionsIf; fixedLeftColumnCount?: number; fixedRightColumnCount?: number}): TableModelIf
+   * Receives a parameter object with essential properties needed to build the table model,
+   * including rows (type T array), column definitions (ColumnDefIf array),
+   * optional table options (TableOptionsIf object), and optional fixed column counts,
+   * and returns an instance of TableModelIf.
+   *
+   * buildByTypedRows(rows: T[], columnDefs: ColumnDefIf[], tableOptions?: TableOptionsIf, fixedLeftColumnCount?: number, fixedRightColumnCount?: number): TableModelIf
+   * Similar to `buildByTypedRowsParam` but accepts separate parameters instead of a single parameter object.
+   *
+   * createByObjectArrayParam(param: {rows: T[]; header?: string[][]; footer?: string[][]; fixedLeftColumnCount?: number; fixedRightColumnCount?: number; rowCheckboxVisible?: boolean; defaultRowHeights?: DefaultRowHeightsIf; columnDefs?: ColumnDefIf[]; columnSizes?: number[]}): TableModelIf
+   * Similar to `createTableModel` but accepts an object parameter with properties required to create a table, including row data, header and footer multi-line data, fixed column counts, visibility of row checkbox, default row heights, column definitions, and column sizes, and returns a TableModelIf instance.
+   *
+   * createByAreaModels(headerAreaModel: AreaModelIf, bodyAreaModel: AreaModelIf, footerAreaModel: AreaModelIf, fixedLeftColumnCount: number, fixedRightColumnCount: number, rowCheckboxVisible: boolean, defaultRowHeights: DefaultRowHeightsIf): TableModelIf
+   * Accepts area models for header, body, and footer, along with fixed column counts, visibility of row checkbox, and default row heights, to create a table model.
+   *
+   * createByAreaModelsParam(param: {headerAreaModel?: AreaModelIf; bodyAreaModel: AreaModelIf; footerAreaModel?: AreaModelIf; fixedLeftColumnCount?: number; fixedRightColumnCount?: number; rowCheckboxVisible?: boolean; defaultRowHeights?: DefaultRowHeightsIf; columnDefs?: ColumnDefIf[]; columnSizes?: number[]; overridingColumnWidth?: number; columnCount?: number}): TableModelIf
+   * Similar to `createByAreaModels` but accepts an object parameter with the required and optional properties to create the table model.
+   *
+   * createByObjectArray(rows: T[], header: string[][], footer: string[][], fixedLeftColumnCount: number, fixedRightColumnCount: number, rowCheckboxVisible: boolean, defaultRowHeights: DefaultRowHeightsIf): TableModelIf
+   * Allows to create a table model utilizing object array data for rows, header, and footer along with the specified configurations.
+   * Please consult each method's documentation for detailed explanation of their functionality.
+   */
   static createTableModel(e) {
     var r, a, t, n, m, d, i, u, p, c, N, G, v, k;
     if (e.defaultRowHeights === void 0)
@@ -1593,6 +1629,23 @@ class f {
       e.getSelectionModel
     );
   }
+  /**
+   * Constructs a table model (an instance of `TableModelIf`) by using provided parameters.
+   *
+   * @template T The generic parameter that represents the datatype of rows.
+   *
+   * @param {Object} param The parameter object.
+   * @param {T[]} param.rows The rows data to be used in the table model.
+   * @param {ColumnDefIf[]} param.columnDefs The definition of columns that are to be used in the table model.
+   * @param {TableOptionsIf} [param.tableOptions=new TableOptions()] Optional table options that may override default table settings. Defaults to `new TableOptions()`.
+   * @param {number} [param.fixedLeftColumnCount=0] Optional parameter that specifies the count of fixed (non-scrollable) columns from the left. Defaults to `0`.
+   * @param {number} [param.fixedRightColumnCount=0] Optional parameter that specifies the count of fixed (non-scrollable) columns from the right. Defaults to `0`.
+   *
+   * @returns {TableModelIf} The newly constructed table model.
+   *
+   * @static
+   * @method
+   */
   static buildByTypedRowsParam(e) {
     return f.buildByTypedRows(
       e.rows ?? [],
@@ -1602,6 +1655,42 @@ class f {
       e.fixedRightColumnCount ?? 0
     );
   }
+  /**
+   * Static method that helps to build a table model object. It takes in tabular data and options and constructs a suitable
+   * model for rendering as a table. This method is capable of handling both 'Flat' and 'Tree' data structures.
+   *
+   * @typeparam T - The type of the data in the rows.
+   *
+   * @param rows - An array of the data rows. The type of these rows could be anything which is defined by the generic type parameter T.
+   *
+   * @param columnDefs - An array of objects that define the columns of the table. Each object represents one column.
+   *
+   * @param tableOptions - A configuration object that allows you to customize how the table is displayed and behaves.
+   * This is optional, and if not provided it defaults to a new instance of TableOptions.
+   *
+   * @param fixedLeftColumnCount - Optional parameter that specifies the number of columns that should remain fixed from the left
+   * side of the table while scrolling horizontally. It defaults to 0 if not provided.
+   *
+   * @param fixedRightColumnCount - Optional parameter that specifies the number of columns that should remain fixed from the right
+   * side of the table while scrolling horizontally. It defaults to 0 if not provided.
+   *
+   * @returns A TableModelIf object which can be used to render the table. The TableModelIf defines the structure of the table and
+   * contains all its data and state.
+   *
+   * @usageNotes
+   *
+   * Here is an example of using this static method to build a table model:
+   *
+   * ```typescript
+   * const tableModel = TableFactory.buildByTypedRows<User>(users, [{ property: 'name', headerLabel: 'Name' }, { property: 'email', headerLabel: 'Email' }]);
+   * ```
+   *
+   * This will build a table with two columns 'Name' and 'Email', each row representing a 'User' object from the 'users' array.
+   *
+   * **Warning:** This function assumes that the first columnDef provided represents a checkbox column if the property of the first
+   * columnDef is "CheckboxColumn". If the first column is not a checkbox column, ensure that the first columnDef does not have "CheckboxColumn"
+   * as its property.
+   */
   static buildByTypedRows(e, r, a = new z(), t = 0, n = 0) {
     const m = a.defaultRowHeights, d = r[0].property === "CheckboxColumn";
     if (e != null && e.length && X(e[0])) {
@@ -1633,6 +1722,50 @@ class f {
       defaultRowHeights: a.defaultRowHeights
     });
   }
+  /**
+   * The `createByObjectArrayParam` static method is used to create a `TableFactory` object with the data contained in the `param` object.
+   * This method would call the `createByObjectArray` static method, which actually constructs the `TableModel` object with the provided data.
+   *
+   * @template T - Defines the type of the items contained in the rows.
+   *
+   * @param {Object} param - Method parameter as an object that carries several properties described below:
+   * @param {T[]} param.rows - Array of table row data that can be of any type.
+   * @param {string[][]} [param.header] - Optional array of arrays with the table header data.
+   * @param {string[][]} [param.footer] - Optional array of arrays with the table footer data.
+   * @param {number} [param.fixedLeftColumnCount] - Optional number detailing how many of the beginning columns are sticky to the left.
+   * @param {number} [param.fixedRightColumnCount] - Optional number detailing how many of the ending columns are sticky to the right.
+   * @param {boolean} [param.rowCheckboxVisible] - Optional flag that indicates whether checkboxes are visible in the rows.
+   * @param {DefaultRowHeightsIf} [param.defaultRowHeights] - Optional object defining default heights of rows in different sections of the table. Defaults to new `DefaultRowHeights()`.
+   * @param {ColumnDefIf[]} [param.columnDefs] - Optional array of column definitions, each is an object conforming to `ColumnDefIf` interface.
+   * @param {number[]} [param.columnSizes] - Optional array of numbers providing the specific sizes for columns.
+   *
+   * @returns A `TableFactory` object created by the `createByObjectArray` method.
+   *
+   * @example
+   * let param = {
+   *   rows: [{name: 'John', age: 30}, {name: 'Doe', age: 40}],
+   *   header: [['Name', 'Age']],
+   *   footer: [['Avg', '35']],
+   *   fixedLeftColumnCount: 1,
+   *   fixedRightColumnCount: 0,
+   *   rowCheckboxVisible: true,
+   *   defaultRowHeights: new DefaultRowHeights(40, 50, 40),
+   *   columnDefs: [
+   *     {
+   *       property: 'name',
+   *       headerLabel: 'Name',
+   *       width: 100
+   *     },
+   *     {
+   *       property: 'age',
+   *       headerLabel: 'Age',
+   *       width: 50
+   *     }
+   *   ],
+   *   columnSizes: [100, 50]
+   * };
+   * const tableModel = TableFactory.createByObjectArrayParam(param);
+   */
   static createByObjectArrayParam(e) {
     const r = e.rowCheckboxVisible !== void 0 ? e.rowCheckboxVisible : !1;
     return f.createByObjectArray(
@@ -1647,6 +1780,47 @@ class f {
       e.columnSizes ?? []
     );
   }
+  /**
+   * This public static factory method creates a `TableModel` instance using the provided parameters.
+   * Each parameter has a default value allowing for great flexibility in creating table models.
+   * The main parameters are the AreaModel instances for different table sections:
+   *
+   * @param headerAreaModel - This parameter of type `AreaModelIf` represents the header area of the table.
+   * The default value is a new instance of `AreaModelHidden`, indicating an invisible header.
+   *
+   * @param bodyAreaModel - This parameter of type `AreaModelIf` represents the body area of the table and is required.
+   * It needs to be passed as it contains all the row data that will be displayed in the table.
+   *
+   * @param footerAreaModel - This `AreaModelIf` type parameter represents the footer area of the table.
+   * Similar to `headerAreaModel`, the default value is a new instance of `AreaModelHidden`, indicating an invisible footer.
+   *
+   * Also, the method receives parameters for fixed columns, row checkbox visibility, default row heights, column definitions, column sizes, overriding column width, and column count:
+   *
+   * @param fixedLeftColumnCount - This value indicates the number of fixed columns on the left side of the table.
+   * The default value is `0`, no fixed column by default.
+   *
+   * @param fixedRightColumnCount - This value indicates the number of fixed columns on the right side of the table.
+   * Similarly to `fixedLeftColumnCount`, its default value is `0`.
+   *
+   * @param rowCheckboxVisible - This is a boolean that determines whether a checkbox will be visible for each row.
+   * The default value is `false`, indicating that checkboxes will not be displayed unless otherwise specified.
+   *
+   * @param defaultRowHeights - This object of type `DefaultRowHeightsIf` allows setting of the default row heights for the table sections.
+   * By default, it creates a new `DefaultRowHeights` instance with values of `34` for header, body and footer.
+   *
+   * @param columnDefs - Here, an array of `ColumnDefIf[]` needs to be passed to specify the column definitions.
+   *
+   * @param columnSizes - This is an array of `number[]` providing custom column sizes.
+   * If not defined, an empty array `[]` is used.
+   *
+   * @param overridingColumnWidth - This number sets a uniform width for all columns, overriding individual column sizes.
+   * Default value is `-1`, indicating that this feature is disabled by default.
+   *
+   * @param columnCount - This is the total column count.
+   *
+   * @return A new instance of `TableModel` is created using the provided parameters.
+   * If a parameter isn't provided, the default value is used.
+   */
   static createByAreaModels(e = new Z(), r, a = new Z(), t = 0, n = 0, m = !1, d = new R(), i, u = [], p = -1, c) {
     return new W(
       e,
@@ -1662,6 +1836,42 @@ class f {
       c
     );
   }
+  /**
+   * `TableFactory.createByAreaModelsParam` is a static method in the `TableFactory` class that creates a table model by area models and other optional parameters.
+   * This method allows more flexibility and control over table building by providing the option to decide the visibility and nature of the header, body, footer, columns, and rows in the table.
+   *
+   * @param `param` is an object that holds the configuration settings for creating the table model. Below are the properties that this object can have:
+   *   - `headerAreaModel`: Optional. An instance of `AreaModelIf` class to be used for creating the header of the table. If not provided, a new `AreaModelHidden` is created by default.
+   *   - `bodyAreaModel`: Mandatory. An instance of `AreaModelIf` class for body of the table.
+   *   - `footerAreaModel`: Optional. An instance of `AreaModelIf` class for table footer. If not provided, a new `AreaModelHidden` is created by default.
+   *   - `fixedLeftColumnCount`: Optional. Number of fixed columns on the left side of the table. Default is 0.
+   *   - `fixedRightColumnCount`: Optional. Number of fixed columns on the right side of the table. Default is 0.
+   *   - `rowCheckboxVisible`: Optional. Boolean that decides if the row checkboxes are visible or not. Defaults to `false`.
+   *   - `defaultRowHeights`: Optional. An instance of `DefaultRowHeightsIf` interface that specifies default row heights. No default value.
+   *   - `columnDefs`: Optional. Array of instance(s) of `ColumnDefIf` interface to define column properties. Defaults to an empty array.
+   *   - `columnSizes`: Optional. Array of numbers setting the sizes of the columns. Defaults to an empty array.
+   *   - `overridingColumnWidth`: Optional. Overrides the width of all columns with this value. Defaults to `-1` which means no width override.
+   *   - `columnCount`: Optional. Number setting the total count of columns. Defaults to 0.
+   *
+   * @returns a new instance of `TableModelIf` created by the `createByAreaModels` method of `TableFactory` using the provided parameters.
+   *
+   * Note: The area models (`headerAreaModel`, `bodyAreaModel`, `footerAreaModel`) should be initialized before being passed to this method. If not initialized, they might need to call their `init` method to ensure proper functioning.
+   *
+   * @example
+   * const tableModel = TableFactory.createByAreaModelsParam({
+   *    headerAreaModel: myHeaderModel,
+   *    bodyAreaModel: myBodyModel,
+   *    footerAreaModel: myFooterModel,
+   *    fixedLeftColumnCount: 2,
+   *    fixedRightColumnCount: 1,
+   *    rowCheckboxVisible: true,
+   *    defaultRowHeights: myDefaultHeights,
+   *    columnDefs: myColumnDefs,
+   *    columnSizes: [100, 100, 200],
+   *    overridingColumnWidth: 150,
+   *    columnCount: 3
+   * });
+   */
   static createByAreaModelsParam(e) {
     return f.createByAreaModels(
       e.headerAreaModel ?? new Z(),
@@ -1677,6 +1887,54 @@ class f {
       e.columnCount ?? 0
     );
   }
+  /**
+   * Class method `createByObjectArray` of the `TableFactory` class.
+   *
+   * This public, static method is intended to create a table model by an array of objects.
+   * This method is particularly useful when you are aiming to build a table from a set of data rows, header and footer information.
+   * The table can include both fixed and flexible columns and optional checkboxes for each row.
+   * The table layout can further be customized using the default row heights, column definitions, and column sizes parameters.
+   *
+   * @generic `T` - The generic type parameter for data rows.
+   *
+   * @param `rows` - This parameter is an array of typed data rows (type `T`) for the table body.
+   *
+   * @param `header` - This optional parameter is a two-dimensional string array. It defines the table header data. The default value is an empty array.
+   *
+   * @param `footer` - This optional parameter is a two-dimensional string array. It defines the table footer data. The default value is an empty array.
+   *
+   * @param `fixedLeftColumnCount` - This optional parameter specifies the count of fixed (non-scrollable) columns on the left side of the table. The default value is 0.
+   *
+   * @param `fixedRightColumnCount` - This optional parameter specifies the count of fixed (non-scrollable) columns on the right side of the table. The default value is 0.
+   *
+   * @param `rowCheckboxVisible` - This optional boolean parameter tells whether to display checkboxes for each row in the table. The default value is false.
+   *
+   * @param `defaultRowHeights` - This optional parameter is an instance of `DefaultRowHeightsIf` interface. It sets the default row heights for the header, body, and footer areas of the table.
+   *
+   * @param `columnDefs` - This optional parameter is an array of column definitions (`ColumnDefIf[]`). It helps to define the settings and properties of individual columns.
+   *
+   * @param `columnSizes` - This optional parameter is a number array. It helps to define the column widths. The default value is an empty array.
+   *
+   * The method further processes the header, footer, and body data to create respective models (`AreaModelIf`), and ultimately it creates and returns a new instance of `TableModel` containing all those prepared models, options, and properties.
+   *
+   * @returns It returns an instance of `TableModel` with all the provided/processed parameters.
+   *
+   * Note: You need to import the `AreaModelArrayOfArrays` and `AreaModelHidden` classes from the respective package/module before using this method.
+   *
+   * @example
+   * ```typescript
+   * // Given the following array of objects:
+   * const rows = [{field1: 'data11', field2: 'data12'}, {field1: 'data21', field2: 'data22'}];
+   *
+   * // And a set of column definitions:
+   * const columnDefs: ColumnDefIf[] = [{headerLabel: 'Field 1', property: 'field1'}, {headerLabel: 'Field 2', property: 'field2'}];
+   *
+   * // You can create a TableModel like following:
+   * let tableModel = TableFactory.createByObjectArray(rows, undefined, undefined, 0, 0, false, new DefaultRowHeights(), columnDefs);
+   * ```
+   *
+   * Reference: For more details regarding the `DefaultRowHeightsIf`, `ColumnDefIf`, `AreaModelIf`, and `AreaModelArrayOfArrays` classes/interfaces, please refer to the respective API documents.
+   */
   static createByObjectArray(e, r = [], a = [], t = 0, n = 0, m = !1, d = new R(), i, u = []) {
     let p;
     r != null && r.length ? p = new S("header", r, d.header, i) : i != null && i.length ? p = new S("header", [i.map((G) => G.headerLabel)], d.header, i) : p = new Z();

package/lib/createTimeTableModel.d.ts

@@ -44,6 +44,7 @@ export declare const tableOptions: {
     sortedOptions: import('../../../table/src').SortedOptions;
     sortOrder: import('../../../table/src').SortState[];
     shortcutActionIdMapping?: import('../../../table/src').ShortcutActionIdMapping | undefined;
+    resizeEventDebounceDelay: number;
     getEditRenderer?: import('../../../table/src').GetEditRenderer | undefined;
     getSelectionModel?: import('../../../table/src').GetT<import('../../../table/src').SelectionModelIf> | undefined;
     getFocusModel?: import('../../../table/src').GetT<import('../../../table/src').FocusModelIf> | undefined;

package/lib/treepeople/generateTreePeopleModel.d.ts

@@ -42,6 +42,7 @@ export declare function createTreePeopleTableOptions(addDemoSelection?: boolean)
     sortedOptions: import('../../../../table/src').SortedOptions;
     sortOrder: import('../../../../table/src').SortState[];
     shortcutActionIdMapping?: import('../../../../table/src').ShortcutActionIdMapping | undefined;
+    resizeEventDebounceDelay: number;
     getEditRenderer?: import('../../../../table/src').GetEditRenderer | undefined;
     getFocusModel?: import('../../../../table/src').GetT<import('../../../../table/src').FocusModelIf> | undefined;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guiexpert/demo-table-models",
-  "version": "1.0.23",
+  "version": "1.0.24",
   "type": "module",
   "main": "./index.js",
   "types": "./index.d.ts",
@@ -18,7 +18,7 @@
   },
   "dependencies": {
     "tslib": "^2.3.0",
-    "@guiexpert/table": "^1.1.29"
+    "@guiexpert/table": "^1.1.31"
   },
   "devDependencies": {
     "@types/node": "^20.11.17",