@acorex/components 20.1.34 → 20.1.36

package/fesm2022/acorex-components-data-table.mjs

@@ -37,6 +37,11 @@ class AXBaseDataTable extends MXBaseComponent {
         this.selectedRowsChange = new EventEmitter();
         this._selectedRows = signal([], ...(ngDevMode ? [{ debugName: "_selectedRows" }] : []));
     }
+    /**
+     * Gets the data source key field name.
+     *
+     * @returns string - The key field name for the data source.
+     */
     getDataSourceKey() {
         return this.dataSource.config.key || 'id';
     }
@@ -49,6 +54,12 @@ class AXBaseDataTable extends MXBaseComponent {
             this.selectedRowsChange.emit(v);
         }
     }
+    /**
+     * Expands a row to show its children.
+     *
+     * @param row - The row data to expand.
+     * @returns Promise<void> - Promise that resolves when expansion is complete.
+     */
     async expandRow(row) {
         if (row.data['__meta__.expanded'] || row.data.children != undefined) {
             this.dataSource.onItemExpanded.next({
@@ -72,11 +83,23 @@ class AXBaseDataTable extends MXBaseComponent {
             });
         }
     }
+    /**
+     * Refreshes the children of a specific item.
+     *
+     * @param id - The ID of the item whose children should be refreshed.
+     * @returns Promise<void> - Promise that resolves when refresh is complete.
+     */
     async refreshItemChildren(id) {
         this.dataSource.onItemRefreshChildren.next({
             id,
         });
     }
+    /**
+     * Selects one or more rows.
+     *
+     * @param rows - The rows to select.
+     * @returns void - No return value.
+     */
     selectRows(...rows) {
         const key = this.getDataSourceKey();
         const selectRowIds = this.selectedRows.map((sr) => (typeof sr === 'object' ? sr[key] : sr));
@@ -84,6 +107,12 @@ class AXBaseDataTable extends MXBaseComponent {
         this.selectedRows = this.selectedRows.concat(newRows);
         //this.selectedRows = _.uniq(this.selectedRows.concat(rows));
     }
+    /**
+     * Unselects one or more rows.
+     *
+     * @param rows - The rows to unselect.
+     * @returns void - No return value.
+     */
     unSelectRows(...rows) {
         const key = this.getDataSourceKey();
         const removedRowIds = rows.map((sr) => (typeof sr === 'object' ? sr[key] : sr));
@@ -150,6 +179,12 @@ class AXDataTableColumnResizableDirective {
         this.onMouseUpBound = this.onMouseUp.bind(this);
         this.resize$.pipe(debounceTime(10)).subscribe((event) => this.onMouseMove(event));
     }
+    /**
+     * Handles mouse down events to initiate column resizing.
+     *
+     * @param event - The mouse down event.
+     * @returns void - No return value.
+     */
     onMouseDown(event) {
         if (isPlatformBrowser(this.platformID)) {
             event.stopPropagation();
@@ -162,14 +197,32 @@ class AXDataTableColumnResizableDirective {
             this.cdr.detach(); // Detach the change detector
         }
     }
+    /**
+     * Handles raw mouse move events and forwards them to the debounced resize stream.
+     * This method acts as a bridge between the raw DOM event and the debounced onMouseMove method.
+     *
+     * @param event - The raw mouse move event.
+     * @returns void - No return value.
+     */
     onMouseMoveRaw(event) {
         this.resize$.next(event);
     }
+    /**
+     * Handles mouse move events during column resizing.
+     *
+     * @param event - The mouse move event.
+     * @returns void - No return value.
+     */
     onMouseMove(event) {
         const newWidth = this.startWidth + (event.pageX - this.startX);
         this.renderer.setStyle(this.el?.nativeElement?.parentElement, 'width', `${newWidth}px`);
         this.column.width = `${newWidth}px`;
     }
+    /**
+     * Handles mouse up events to complete column resizing.
+     *
+     * @returns void - No return value.
+     */
     onMouseUp() {
         if (isPlatformBrowser(this.platformID)) {
             this.document.removeEventListener('mousemove', this.onMouseMoveRawBound);
@@ -1600,8 +1653,11 @@ class AXDataTableComponent extends AXBaseDataTable {
         return undefined;
     }
     /**
-     * Refreshes the data in the data source and resets the data pager to the first page.
-     * @ignore
+     * Refreshes the data table with optional reset options.
+     *
+     * @param options - Configuration options for refresh operation.
+     * @param options.reset - Whether to reset pagination state.
+     * @returns void - No return value.
      */
     refresh(options = { reset: true }) {
         this.dataSource.refresh(options);