@guiexpert/table 1.1.13 → 1.1.15

package/index.js

@@ -516,6 +516,14 @@ class Ae {
   repaint() {
     this.tableScope.repaint();
   }
+  /**
+   * Repaints the table scope with hard repaint.
+   * Repaints the UI by resetting the size of the wrapper div,
+   * adjusting the containers and rows, and performing additional adjustments
+   * after scrolling.
+   *
+   * @return {void}
+   */
   repaintHard() {
     this.tableScope.repaintHard();
   }
@@ -569,6 +577,23 @@ class Ae {
       this.tableScope.focusModel()
     );
   }
+  /**
+   * Retrieves the current scope of the table.
+   *
+   * @returns {TableScope} The current scope of the table.
+   */
+  getTableScope() {
+    return this.tableScope;
+  }
+  /**
+   * Retrieves the selection model of the table.
+   *
+   * @return {SelectionModelIf | undefined} The selection model of the table,
+   * or undefined if no selection model is available.
+   */
+  getSelectionModel() {
+    return this.tableScope.selectionModel();
+  }
 }
 class q {
   constructor(e) {
@@ -807,6 +832,11 @@ class Te {
       o.createDivWithClass("ge-table-footer-border", i)
     );
   }
+  /**
+   * Adjusts the containers and rows of the table based on the current state.
+   *
+   * @return {void}
+   */
   adjustContainersAndRows() {
     const e = this.tableModel.getPadding(), t = this.hostElement.clientWidth, o = this.hostElement.clientHeight;
     this.dom.applyStyle(this.scrollViewport, {
@@ -879,8 +909,21 @@ class Te {
       })
     ) : this.dom.applyDisplayNoneStyle(this.borderFooterTop), this.adjustAfterScrolling();
   }
+  /**
+   * Adjusts the position or appearance of elements after scrolling.
+   * This method must be overwritten in child classes.
+   *
+   * @return {void}
+   */
   adjustAfterScrolling() {
   }
+  /**
+   * Resets the size of the wrapper div based on the content dimensions.
+   *
+   * @protected
+   *
+   * @returns {void} Returns nothing.
+   */
   resetSizeOfWrapperDiv() {
     const e = `${this.tableModel.getContentWidthInPixel()}px`, t = `${this.tableModel.getContentHeightInPixel() + 1}px`;
     this.dom.setStyle(this.contentWrapperDiv, "width", e), this.dom.setStyle(this.contentWrapperDiv, "height", t);
@@ -976,6 +1019,14 @@ class _e extends Te {
   isEditing() {
     return this.editing;
   }
+  /**
+   * Resets the editor renderer by clearing its values and state.
+   *
+   * @function resetEditorRenderer
+   * @memberof ClassName
+   *
+   * @returns {void}
+   */
   resetEditorRenderer() {
     this.editorRenderer = void 0, this.editorRendererRow = -1, this.editorRendererColumn = -1, this.editing = !1;
   }
@@ -992,6 +1043,12 @@ class _e extends Te {
       t == null || t.clear(), e && this.repaint();
     }
   }
+  /**
+   * Initializes and renders the editor for a specified row and column index.
+   *
+   * @param {number} rowIdx - The index of the row.
+   * @param {number} colIdx - The index of the column.
+   */
   initRenderEditor(e, t) {
     var s;
     let o = (s = this.tableModel.getColumnDef(t)) == null ? void 0 : s.getEditRenderer;
@@ -1003,12 +1060,28 @@ class _e extends Te {
       } else
         this.resetEditorRenderer();
   }
+  /**
+   * Adjusts the content after scrolling and initiates a repaint of the component.
+   *
+   * @return {void}
+   */
   repaint() {
     this.adjustAfterScrolling();
   }
+  /**
+   * Repaints the UI by resetting the size of the wrapper div,
+   * adjusting the containers and rows, and performing additional adjustments
+   * after scrolling.
+   *
+   * @return {void} This method does not return any value.
+   */
   repaintHard() {
     this.resetSizeOfWrapperDiv(), this.adjustContainersAndRows(), this.adjustAfterScrolling();
   }
+  /**
+   * Adjusts the table after scrolling. This method performs various adjustments
+   * to the table's appearance and behavior after a scroll event occurs.
+   */
   adjustAfterScrolling() {
     var e;
     for (const t of this.removables)
@@ -1031,10 +1104,23 @@ class _e extends Te {
       "ge-table-body-west-vertical-border"
     ));
   }
+  /**
+   * Checks if the scroll position should be saved and saves it.
+   *
+   * @return {void}
+   */
   checkForScrollPosSaving() {
     var e, t;
     this.storeScrollPosStateService && ((t = (e = this.tableOptions) == null ? void 0 : e.autoRestoreOptions) != null && t.autoRestoreScrollPosition) && this.storeScrollPosStateService.updateScrollOffset([this.scrollLeft, this.scrollTop]);
   }
+  /**
+   * Updates the cells in the table with the provided values and optionally repaints all cells.
+   *
+   * @param {TableCellUpdateEventIf[]} events - The array of events containing information about the cells to update.
+   * @param {boolean} repaintAll - Optional. If true, repaints all cells after updating. Defaults to false.
+   *
+   * @returns {void}
+   */
   updateCells(e, t = !1) {
     e.forEach(
       (o) => {
@@ -1042,6 +1128,15 @@ class _e extends Te {
       }
     ), t && this.repaint();
   }
+  /**
+   * Rerenders the content of a table cell based on the given parameters.
+   *
+   * @param {TableCellUpdateEventIf} area - The area of the table.
+   * @param {number} rowIndex - The index of the row.
+   * @param {number} columnIndex - The index of the column.
+   * @param {any} value - The new value to be displayed in the cell.
+   * @param {string[]} cssClasses - An array of CSS classes to be applied to the cell.
+   */
   rerenderCellContent({ area: e, rowIndex: t, columnIndex: o, value: s, cssClasses: i }) {
     const r = this.tableModel.getAreaModel(e), n = 'div[data-col-index="' + o + '"][data-row-index="' + t + '"][data-area="' + e + '"]', l = document.querySelector(n);
     if (l) {
@@ -1061,6 +1156,13 @@ class _e extends Te {
           this.dom.setStyle(l, b, m[b]);
     }
   }
+  /**
+   * Stores the widths of all columns in the table.
+   *
+   * @protected
+   * @function storeColumnWidths
+   * @returns {void}
+   */
   storeColumnWidths() {
     const e = this.tableModel.getColumnDefs();
     e != null && e.length && (this.storedColumnWidths = e.map((t, o) => this.tableModel.getColumnWidth(o)));
@@ -1073,6 +1175,15 @@ class _e extends Te {
     }
     return [void 0, void 0];
   }
+  /**
+   * Retrieves the specified area from the grid layout.
+   *
+   * @param {string} areaIdent - The identifier for the area ('header', 'body', or 'footer').
+   * @param {string} sideIdent - The identifier for the side of the area ('west', 'center', or 'east').
+   * @protected
+   * @returns {HTMLElement} - The requested area element.
+   * @throws {Error} - If the area identifier or side identifier is incorrect.
+   */
   getArea(e, t) {
     if (e === "header") {
       if (t === "west")
@@ -1098,10 +1209,24 @@ class _e extends Te {
     }
     throw Error(`Wrong area identifier: row:${e}, col:${t}`);
   }
+  /**
+   * Adjusts the body of the table.
+   *
+   * @protected
+   * @return {void}
+   */
   adjustBody() {
     const e = this.areaBodyCenterGeo.height - this.tableModel.getContentHeightInPixel(), t = this.scrollFactorY * e;
     this.dom.setStyle(this.contentDiv, "top", `${this.scrollTop}px`), this.dom.setStyle(this.contentDiv, "left", `${this.scrollViewport.scrollLeft}px`), this.adjustArea("body", t);
   }
+  /**
+   * Returns a number value extracted from the specified attribute of the source element.
+   *
+   * @param {HTMLElement} srcElement - The source element from which to extract the attribute value.
+   * @param {string} key - The attribute key to extract the value from.
+   * @returns {number} - The extracted number value, or -1 if the attribute was not found or not a valid number.
+   * @protected
+   */
   getNumberByAttr(e, t) {
     var o;
     if (e) {
@@ -1111,6 +1236,14 @@ class _e extends Te {
     }
     return -1;
   }
+  /**
+   * Retrieves the value of the specified attribute from the nearest ancestor element that has the attribute.
+   *
+   * @param {HTMLElement} srcElement - The source element from which to start searching for the nearest ancestor element.
+   * @param {string} key - The name of the attribute to retrieve.
+   * @returns {string} The value of the specified attribute, or an empty string if the attribute is not found.
+   * @protected
+   */
   getStringByAttr(e, t) {
     var o;
     if (e) {
@@ -1120,6 +1253,14 @@ class _e extends Te {
     }
     return "";
   }
+  /**
+   * Adjusts the layout and positioning of the specified area in the table.
+   * This method is used internally and should not be called directly.
+   *
+   * @param {AreaIdent} areaIdent - The identifier of the area to adjust (e.g. header, body, footer).
+   * @param {number} [yStart=0] - The starting y-position for the layout adjustments.
+   * @protected
+   */
   adjustArea(e, t = 0) {
     var g;
     const o = this.getArea(e, "west"), s = this.getArea(e, "center"), i = this.getArea(e, "east"), r = s.child.clientHeight;
@@ -1260,6 +1401,15 @@ class _e extends Te {
       parent: i
     });
   }
+  /**
+   * Finds the row index of an important rowspan cell in a given area model.
+   *
+   * @param {AreaModelIf} areaModel - The area model to search in.
+   * @param {number} rowIndex - The current row index.
+   * @param {number} colIndex - The current column index.
+   * @returns {number} - The row index of the important rowspan cell, or -1 if not found.
+   * @protected
+   */
   findRowOfImportantRowspanCell(e, t, o) {
     const s = e.getMaxRowspan();
     for (let i = t - 1; i > -1; i--) {
@@ -1271,6 +1421,13 @@ class _e extends Te {
     }
     return -1;
   }
+  /**
+   * Adjusts the columns to fit the width of the row's parent element.
+   *
+   * @param {ArgsAdjustColumnsToRowParentParams} params - The parameters for adjusting the columns.
+   * @protected
+   * @return {void}
+   */
   adjustColumnsToRowParent({
     areaIdent: e,
     sideIdent: t,
@@ -1337,6 +1494,15 @@ class _e extends Te {
     }
     this.tableOptions.verticalBorderVisible && this.dom.addVerticalBorder(new $(b - 1, 1, s.height, 0), i);
   }
+  /**
+   * Retrieves the column index of the tree arrow column in the table.
+   *
+   * @protected
+   *
+   * @returns {0 | 1} The column index of the tree arrow column.
+   *                Returns 0 if the checkbox is not visible,
+   *                otherwise returns 1.
+   */
   getTreeArrowColumnIndex() {
     return this.tableOptions.showCheckboxWihoutExtraColumn ? 0 : this.tableModel.isRowCheckboxVisible() ? 1 : 0;
   }
@@ -1397,23 +1563,53 @@ class _e extends Te {
         this.dom.setStyle(S, v, G[v]);
     return [S, E];
   }
+  /**
+   * Applies CSS classes to an HTML element.
+   *
+   * @param {HTMLDivElement} ele - The HTML element to which CSS classes will be applied.
+   * @param {Object.<string, boolean>} cssClasses - An object containing CSS class names as keys and boolean values indicating whether to apply or remove the class.
+   * @protected
+   */
   applyCssClasses(e, t = {}) {
     e && Object.entries(t).forEach(([o, s]) => {
       s ? this.dom.addClass(o, e) : this.dom.removeClass(o, e);
     });
   }
+  /**
+   * Retrieves the column widths of a table within a specified range.
+   *
+   * @param {number} startIndex - The index of the first column to retrieve the width of.
+   * @param {number} endIndex - The index of the last column to retrieve the width of.
+   *
+   * @return {number[]} An array containing the widths of the columns within the specified range.
+   */
   getColumnWidths(e, t) {
     const o = [];
     for (let s = e; s <= t; s++)
       o.push(this.tableModel.getColumnWidth(s));
     return o;
   }
+  /**
+   * Retrieves the heights of rows within a specified range.
+   *
+   * @param {number} startIndex - The index of the first row in the range.
+   * @param {number} endIndex - The index of the last row in the range.
+   * @param {AreaModelIf} areaModel - The area model.
+   * @return {number[]} - An array containing the heights of the rows within the specified range.
+   */
   getRowHeights(e, t, o) {
     const s = [];
     for (let i = e; i <= t; i++)
       s.push(o.getRowHeight(i));
     return s;
   }
+  /**
+   * Adjusts the position and size of the hover row based on the mouse move event.
+   *
+   * @param {GeMouseEvent} mouseMoveEvent - The mouse move event.
+   *
+   * @return {void}
+   */
   adjustHoverRows(e) {
     if (this.tableOptions.hoverRowVisible && e.rowIndex > -1) {
       const t = this.hostElement.clientWidth, o = this.tableModel.getAreaModel("body").getRowHeight(e.rowIndex), s = e.rowTop + this.areaHeaderCenter.parent.clientHeight - this.scrollTop;
@@ -1427,11 +1623,26 @@ class _e extends Te {
     } else
       this.hideHoverRow();
   }
+  /**
+   * Hides the hover row by applying 'display: none' style to it.
+   *
+   * @protected
+   * @function
+   * @name hideHoverRow
+   * @memberof ClassName
+   *
+   * @returns {void}
+   */
   hideHoverRow() {
     this.dom.applyStyle(this.hoverRow, {
       display: "none"
     });
   }
+  /**
+   * Adjusts the position and size of the hover column based on the mouse move event.
+   *
+   * @param {GeMouseEvent} mouseMoveEvent - The mouse move event object.
+   */
   adjustHoverColumns(e) {
     if (this.tableOptions.hoverColumnVisible && e.rowIndex > -1) {
       const t = this.hostElement.clientHeight, o = this.tableModel.getColumnWidth(e.columnIndex), s = this.areaBodyWestGeo.width, i = e.columnLeft + this.tableModel.getPadding().left - this.scrollLeft - s;
@@ -1445,6 +1656,15 @@ class _e extends Te {
     } else
       this.hideHoverColumn();
   }
+  /**
+   * Hide hover column.
+   *
+   * This method hides the hover column by applying a style of 'display: none'
+   * to the element representing the hover column.
+   *
+   * @protected
+   * @memberof ClassName
+   */
   hideHoverColumn() {
     this.dom.applyStyle(this.hoverColumn, {
       display: "none"
@@ -1461,6 +1681,13 @@ class _e extends Te {
   debounce(e, t = 1e3) {
     this.debounceTimeout && clearTimeout(this.debounceTimeout), this.debounceTimeout = setTimeout(e.bind(this), t);
   }
+  /**
+   * Adjusts the dragging column during a mouse move event.
+   *
+   * @param {GeMouseEvent} mouseMoveEvent - The mouse move event.
+   * @param {number} sourceColumnIndex - The index of the source column.
+   * @param {boolean} firstDraggingRendering - Indicates if it's the first rendering of the dragging column.
+   */
   adjustDraggingColumn(e, t, o) {
     var s, i;
     if (this.dragging) {
@@ -1476,10 +1703,25 @@ class _e extends Te {
     } else
       this.hideDraggingColumn();
   }
+  /**
+   * Renders the content of a dragging column.
+   *
+   * @param {GeoData} columnGeo - The geographic data of the column.
+   *
+   * @returns {number} The y-coordinate of the rendered content.
+   */
   renderContentOfDraggingColumn(e) {
     const t = this.renderContentOfDraggingColumnForArea(e, "header", 0);
     this.renderContentOfDraggingColumnForArea(e, "body", t);
   }
+  /**
+   * Renders the content of the dragging column for a specific area.
+   *
+   * @param {GeoData} columnGeo - The geometry data of the dragging column.
+   * @param {AreaIdent} areaIdent - The identifier of the area.
+   * @param {number} [y=0] - The starting y-position.
+   * @return {number} The final y-position after rendering all the content.
+   */
   renderContentOfDraggingColumnForArea(e, t, o = 0) {
     const s = "center", i = this.tableModel.getAreaModel(t), r = i == null ? void 0 : i.getRowCount();
     if (r) {
@@ -1509,17 +1751,50 @@ class _e extends Te {
     }
     return o;
   }
+  /**
+   * Hides the dragging column by applying a 'display: none' style to it.
+   * This method is protected and can only be accessed within the class.
+   *
+   * @return {void}
+   */
   hideDraggingColumn() {
     this.dom.applyStyle(this.draggingColumn, {
       display: "none"
     });
   }
+  /**
+   * Renders a draggable target div element.
+   *
+   * @param {HTMLDivElement} parent - The parent element where the target div will be appended to.
+   * @param {number} left - The left position of the target div in pixels.
+   * @param {number} top - The top position of the target div in pixels.
+   * @param {number} width - The width of the target div in pixels.
+   * @param {number} height - The height of the target div in pixels.
+   * @return {HTMLDivElement} - The rendered draggable target div element.
+   */
   renderDragTargetDiv(e, t, o, s, i) {
     const r = this.dom.applyStylePosistionAbsolute(
       this.dom.createDivWithClass("ge-table-drop-zone", e)
     );
     return this.dom.setStyle(r, "left", `${t}px`), this.dom.setStyle(r, "top", `${o}px`), this.dom.setStyle(r, "width", `${s}px`), this.dom.setStyle(r, "height", `${i}px`), r;
   }
+  /**
+   * Render selected background div.
+   *
+   * @private
+   * @param {boolean} skip - Whether to skip rendering.
+   * @param {boolean} renderSelection - Whether to render the selection.
+   * @param {SideIdent} sideIdent - The side identifier.
+   * @param {AreaModelIf} areaModel - The area model.
+   * @param {number} rowIndex - The row index.
+   * @param {number} index - The index.
+   * @param {HTMLDivElement} parent - The parent div element.
+   * @param {number} left - The left position.
+   * @param {number} top - The top position.
+   * @param {number} width - The width of the div.
+   * @param {number} height - The height of the div.
+   * @returns {boolean} - Whether the cell is selected.
+   */
   renderSelectedBackgroundDiv(e, t, o, s, i, r, n, l, d, a, h) {
     let u = !1;
     if (!e && t && s.isSelectable(i, r) && this.getSelectionModel) {
@@ -1538,6 +1813,25 @@ class _e extends Te {
     }
     return u;
   }
+  /**
+   * Renders a cell in the grid.
+   *
+   * @param {ArgsRenderCell} args - The arguments for rendering the cell.
+   * @param {AreaModel} args.areaModel - The area model of the grid.
+   * @param {string} args.areaIdent - The identifier of the area.
+   * @param {string} args.sideIdent - The identifier of the side.
+   * @param {number} args.rowIndex - The index of the row.
+   * @param {number} args.columnIndex - The index of the column.
+   * @param {number} args.left - The left position of the cell.
+   * @param {number} args.top - The top position of the cell.
+   * @param {number} args.width - The width of the cell.
+   * @param {number} args.height - The height of the cell.
+   * @param {HTMLElement} args.parent - The parent element of the cell.
+   * @param {boolean} args.cellSelected - Indicates if the cell is selected.
+   * @param {boolean} args.lastRowOfModel - Indicates if the cell is in the last row of the model.
+   *
+   * @returns {void}
+   */
   renderCell({
     areaModel: e,
     areaIdent: t,
@@ -1567,6 +1861,20 @@ class _e extends Te {
     });
     h && this.dom.addClass(`ge-table-${t}-${o}-selected-range`, m), b && this.cleanupFunctions[t].push(b);
   }
+  /**
+   * Render the header cell resize handle.
+   *
+   * @param {ArgsRenderHeaderCellResizeHandle} args - The arguments for rendering the handle.
+   * @param {number} args.rowIndex - The index of the row.
+   * @param {number} args.columnIndex - The index of the column.
+   * @param {number} args.cellLeft - The left position of the cell.
+   * @param {number} args.cellTop - The top position of the cell.
+   * @param {number} args.cellWidth - The width of the cell.
+   * @param {number} args.cellHeight - The height of the cell.
+   * @param {HTMLElement} args.parent - The parent element to append the handle to.
+   *
+   * @return {void}
+   */
   renderHeaderCellResizeHandle({ rowIndex: e, columnIndex: t, cellLeft: o, cellTop: s, cellWidth: i, cellHeight: r, parent: n }) {
     const l = this.dom.domService, d = this.tableOptions.columnResizeHandleWidthInPx ?? 2, a = l.createElement("div");
     l.setAttribute(a, "data-col-index", `${t}`), l.setAttribute(a, "data-row-index", `${e}`), l.setAttribute(a, "data-area", "header"), l.setAttribute(a, "data-ge-action", "resize-column"), l.addClass(a, "ge-table-column-resize-handle"), l.setStyle(a, "display", "clip"), l.setStyle(a, "position", "absolute"), l.setStyle(a, "cursor", "col-resize"), l.setStyle(a, "left", `${o + i - d}px`), l.setStyle(a, "top", `${s}px`), l.setStyle(a, "width", `${d}px`), l.setStyle(a, "height", `${r}px`), l.appendChild(n, a);
@@ -1863,6 +2171,9 @@ class Ge {
   selectAll() {
     this.allSelected = !0;
   }
+  isAllSelected() {
+    return this.allSelected;
+  }
   addSelection(e) {
     this.addRange(e);
   }
@@ -1878,6 +2189,18 @@ class Ge {
   isSelected(e, t) {
     return this.getSelectionCount(e, t) > 0;
   }
+  /**
+   * Retrieves the merged row indices from the given range selection.
+   *
+   * @returns {number[]} Array of merged row indices
+   */
+  getMergedRowIndices() {
+    const e = [];
+    for (const t of this.ranges)
+      for (let o = t.r1; o <= t.r2; o++)
+        !e.includes(o) && !this.isInNegativeRange(o, 0) && e.push(o);
+    return e;
+  }
   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));
   }

package/lib/table/ele-scope.d.ts

@@ -36,7 +36,25 @@ export declare class EleScope {
     protected areaBodyCenterGeo: GeoData;
     protected areaBodyEastGeo: GeoData;
     constructor(hostElement: HTMLDivElement, tableModel: TableModelIf, dom: ConvenienceDomService, tableOptions: TableOptionsIf);
+    /**
+     * Adjusts the containers and rows of the table based on the current state.
+     *
+     * @return {void}
+     */
     adjustContainersAndRows(): void;
+    /**
+     * Adjusts the position or appearance of elements after scrolling.
+     * This method must be overwritten in child classes.
+     *
+     * @return {void}
+     */
     adjustAfterScrolling(): void;
+    /**
+     * Resets the size of the wrapper div based on the content dimensions.
+     *
+     * @protected
+     *
+     * @returns {void} Returns nothing.
+     */
     protected resetSizeOfWrapperDiv(): void;
 }