@guiexpert/demo-table-models 1.0.7 → 1.0.9

package/index.js

@@ -36,6 +36,15 @@ class fe {
   }
 }
 class T {
+  /**
+   * Represents a constructor for a class.
+   * @constructor
+   * @param {number} r1 - The value for r1.
+   * @param {number} c1 - The value for c1.
+   * @param {number} r2 - The value for r2.
+   * @param {number} c2 - The value for c2.
+   * @param {boolean} [gammaRange=false] - The value for gammaRange. Defaults to false. gammaRange will be used for AreaModelCellGroups, but it's not implemented yet!
+   */
   constructor(e, r, a, t, n = !1) {
     this.r1 = e, this.c1 = r, this.r2 = a, this.c2 = t, this.gammaRange = n;
   }
@@ -674,28 +683,80 @@ class _ {
   init() {
     this.recalcSize(this.parentSize), this.overridingColumnWidth === -1 && this.calcXPositions(), this.headerAreaModel && this.headerAreaModel.init(), this.bodyAreaModel && this.bodyAreaModel.init(), this.footerAreaModel && this.footerAreaModel.init();
   }
+  /**
+   * Retrieves the count of columns in the current instance.
+   *
+   * @return {number} The count of columns.
+   */
   getColumnCount() {
     return this.columnCount;
   }
+  /**
+   * Sets the width in pixel of a column (by columnIndex) in a table.
+   *
+   * @param {number} columnIndex - The index of the column.
+   * @param {number} width - The desired width of the column.
+   * @return {void}
+   */
   setColumnWidth(e, r) {
     var a;
     r = Math.max(0, r), this.overridingColumnWidth !== -1 && (this.overridingColumnWidth = r), e > -1 && e < ((a = this.columnSizes) == null ? void 0 : a.length) && (this.columnSizes[e] = r), this.recalcContentWidthInPx();
   }
+  /**
+   * Retrieves the width of a column specified by its index.
+   *
+   * @param {number} columnIndex - The index of the desired column.
+   * @return {number} - The width of the specified column.
+   */
   getColumnWidth(e) {
     var a;
     const r = this.getColumnDef(e);
     return r && r.isVisible && !r.isVisible() ? 0 : this.overridingColumnWidth !== -1 ? this.overridingColumnWidth : e > -1 && e < ((a = this.columnSizes) == null ? void 0 : a.length) ? this.columnSizes[e] : 0;
   }
+  /**
+   * Retrieves the x position for a given column index.
+   *
+   * @param {number} columnIndex - The index of the column.
+   * @return {number} - The x position of the column.
+   */
   getXPosByColumnIndex(e) {
     return e === 0 ? 0 : this.overridingColumnWidth > -1 ? this.overridingColumnWidth * e : this.xPositions[e];
   }
+  /**
+   * Recalculates the size (width, height, padding)  of the elements based on the client width.
+   *
+   * @param {number} clientWidth - The width of the client area.
+   *
+   * @return {void} - This method does not return a value.
+   */
   recalcSize(e) {
     this.recalcColumnWidthes(e), this.recalcHeightAndPadding();
   }
+  /**
+   * Recalculates the height and padding for the body area.
+   *
+   * This method retrieves the area model for the "body" area,
+   * and updates the rowCount property with the row count of the model.
+   *
+   * The contentHeightInPx property is then updated with the height of the "body" area.
+   *
+   * The method calls the recalcContentWidthInPx() method to recalculate the content width.
+   *
+   * Finally, the method calls the recalcPadding() method to recalculate the padding.
+   *
+   * @return {void}
+   */
   recalcHeightAndPadding() {
     const e = this.getAreaModel("body");
     this.rowCount = e.getRowCount(), this.contentHeightInPx = this.getAreaHeight("body"), this.recalcContentWidthInPx(), this.recalcPadding();
   }
+  /**
+   * Recalculates the padding of an element based on the width and height of its surrounding areas.
+   *
+   * @method recalcPadding
+   *
+   * @returns {void}
+   */
   recalcPadding() {
     const e = this.getSideAreaWidth("west"), r = this.getSideAreaWidth("east"), a = this.getAreaHeight("header"), t = this.getAreaHeight("footer");
     this.padding = new re(
@@ -705,21 +766,55 @@ class _ {
       e
     );
   }
+  /**
+   * Retrieves the padding value.
+   *
+   * @returns {Padding} The padding value.
+   */
   getPadding() {
     return this.padding;
   }
+  /**
+   * Returns the height of the content in pixels.
+   *
+   * @returns {number} The height of the content in pixels.
+   */
   getContentHeightInPixel() {
     return this.contentHeightInPx;
   }
+  /**
+   * Returns the width of the content in pixels.
+   *
+   * @returns {number} The width of the content in pixels.
+   */
   getContentWidthInPixel() {
     return this.contentWidthInPx;
   }
+  /**
+   * Returns the height of the specified row in the given row area identifier.
+   *
+   * @param {AreaIdent} rowAreaIdent - The row area identifier.
+   * @param {number} rowIndex - The index of the row.
+   * @return {number} - The height of the specified row.
+   */
   getRowHeight(e, r) {
     return this.getAreaModel(e).getRowHeight(r);
   }
+  /**
+   * Retrieves the model for the given row area identifier.
+   *
+   * @param {AreaIdent} rowAreaIdent - The identifier of the row area.
+   * @return {AreaModelIf} - The model of the specified row area.
+   */
   getModel(e) {
     return this.getAreaModel(e);
   }
+  /**
+   * Calculates the height of the area identified by the given area identifier.
+   *
+   * @param {AreaIdent} areaIdent - The identifier of the area.
+   * @return {number} - The height of the area.
+   */
   getAreaHeight(e) {
     const r = this.getModel(e), a = r.getRowCount();
     if (this.defaultRowHeights[e])
@@ -729,6 +824,12 @@ class _ {
       t = t + r.getRowHeight(n);
     return t;
   }
+  /**
+   * Returns the total width of the side area identified by sideIdent.
+   *
+   * @param {SideIdent} sideIdent - The identifier of the side area ("west" | "center" | "east").
+   * @return {number} - The total width in pixels of the side area.
+   */
   getSideAreaWidth(e) {
     const [r, a] = this.getSideStartAndEndColumnIndex(e);
     let t = 0;
@@ -736,21 +837,50 @@ class _ {
       t = t + this.getColumnWidth(n);
     return t;
   }
+  /**
+   * Retrieves the start and end column indices based on the given side identifier.
+   *
+   * @param {SideIdent} sideIdent - The side identifier, which can be "west", "east", or "center".
+   * @return {[number, number]} - An array containing the start and end column indices.
+   */
   getSideStartAndEndColumnIndex(e) {
     const r = this.getFixedLeftColumnCount(), a = this.getFixedRightColumnCount();
     let t = 0, n = this.columnCount - 1;
     return e === "west" ? n = r - 1 : e === "east" ? t = this.columnCount - a : (t = r, n = this.columnCount - a - 1), [t, n];
   }
+  /**
+   * Returns the column definition at the specified index.
+   *
+   * @param {number} index - The index of the column definition to retrieve.
+   * @returns {ColumnDefIf | undefined} - The column definition at the specified index, or undefined if no ColumnDef is specified for the given column
+   */
   getColumnDef(e) {
     if (e < this.columnDefs.length)
       return this.columnDefs[e];
   }
+  /**
+   * Retrieves the count of fixed left columns.
+   *
+   * @returns {number} The count of fixed left columns.
+   */
   getFixedLeftColumnCount() {
     return this.fixedLeftColumnCount;
   }
+  /**
+   * Returns the number of fixed right columns.
+   *
+   * @returns {number} The number of fixed right columns.
+   */
   getFixedRightColumnCount() {
     return this.fixedRightColumnCount;
   }
+  /**
+   * Retrieves the area model (header, body or footer) based on the area identification.
+   *
+   * @param {AreaIdent} area - The identifier of the area.
+   * @return {AreaModelIf} The area model corresponding to the given area identification.
+   * @throws {Error} If the area identification is invalid.
+   */
   getAreaModel(e) {
     if (e === "header")
       return this.headerAreaModel;
@@ -760,38 +890,103 @@ class _ {
       return this.footerAreaModel;
     throw new Error("Wrong ident.");
   }
+  /**
+   * Returns the body area model.
+   *
+   * @returns {AreaModelIf} The body area model.
+   */
   getBodyModel() {
     return this.bodyAreaModel;
   }
+  /**
+   * Checks if the footer is visible.
+   *
+   * @returns {boolean} True if the footer is visible, false otherwise.
+   */
   isFooterVisibe() {
     var e;
     return (((e = this.footerAreaModel) == null ? void 0 : e.getRowCount()) ?? 0) > 0;
   }
+  /**
+   * Checks if the header area is visible.
+   * @return {boolean} Returns true if the header area is visible, otherwise false.
+   */
   isHeaderVisibe() {
     var e;
     return (((e = this.headerAreaModel) == null ? void 0 : e.getRowCount()) ?? 0) > 0;
   }
+  /**
+   * Checks whether the row checkbox is visible.
+   *
+   * @returns {boolean} True if the row checkbox is visible, otherwise false.
+   */
   isRowCheckboxVisible() {
     return this.rowCheckboxVisible;
   }
+  /**
+   * This method is called when an external filter is changed.
+   *
+   * @param {FilterFunction<T>} predictFn - The function used to predict whether an element should be filtered or not.
+   * @return {void}
+   */
   externalFilterChanged(e) {
     this.getAreaModel("body").externalFilterChanged(e);
   }
+  /**
+   * Sorts the items using the given sortItems array.
+   *
+   * @param {SortItem[]} sortItems - An array of sort items to sort the items.
+   * @return {boolean} - Returns true if the sorting is successful, otherwise false.
+   */
   doSort(e) {
     return this.getAreaModel("body").doSort(e);
   }
+  /**
+   * Returns an array of ColumnDefIf objects or undefined.
+   *
+   * @return {ColumnDefIf[] | undefined} An array of ColumnDefIf objects or undefined.
+   */
   getColumnDefs() {
     return this.columnDefs;
   }
+  /**
+   * Retrieves the property key of the table row business object associated with the specified column index.
+   * It's only available when columnDefs are specified.
+   *
+   * @param {number} columnIndex - The index of the column to retrieve the property from.
+   * @return {string} The property associated with the specified column index.
+   */
   getColumnProperty(e) {
-    return this.columnDefs[e].property;
+    return this.columnDefs ? this.columnDefs[e].property : "";
   }
+  /**
+   * Retrieves the row object from the body model at the specified index.
+   *
+   * @param {number} rowIndex - The index of the row to retrieve.
+   *
+   * @return {any} The row object at the specified index.
+   */
   getBodyRowByIndex(e) {
     return this.getBodyModel().getRowByIndex(e);
   }
+  /**
+   * Checks if a column at the given index is sortable.
+   *
+   * @param {number} columnIndex - The index of the column to check.
+   *
+   * @returns {boolean} - `true` if the column is sortable, `false` otherwise.
+   */
   isSortable(e) {
     return this.columnDefs && e < this.columnDefs.length && this.columnDefs[e].sortable ? this.columnDefs[e].sortable() : !1;
   }
+  /**
+   * Moves a column in the column order.
+   *
+   * @param {number} sourceColumnIndex - The index of the column to be moved.
+   * @param {number} targetColumnIndex - The index where the column should be moved to.
+   *
+   * @returns {void}
+   */
   changeColumnOrder(e, r) {
     var a, t, n;
     this.arrayMove(this.columnDefs, e, r), this.arrayMove(this.columnSizes, e, r), (a = this.headerAreaModel) == null || a.changeColumnOrder(e, r), (t = this.bodyAreaModel) == null || t.changeColumnOrder(e, r), (n = this.footerAreaModel) == null || n.changeColumnOrder(e, r), this.calcXPositions();
@@ -219151,11 +219346,13 @@ const H = [
         children: [
           {
             data: "Gold A",
-            property: "GOLD_A"
+            property: "GOLD_A",
+            visibility: "inverted"
           },
           {
             data: "Gold B",
-            property: "GOLD_B"
+            property: "GOLD_B",
+            visibility: "inverted"
           }
         ]
       },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guiexpert/demo-table-models",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "type": "module",
   "main": "./index.js",
   "types": "./index.d.ts",