@acorex/components 18.5.16 → 18.6.0

package/data-table/lib/columns/row-command-column.component.d.ts

@@ -14,34 +14,117 @@ export declare abstract class AXBaseRowCommandColumnComponent extends AXDataTabl
     get cssClass(): string;
     onItemClick: EventEmitter<AXRowCommandItemClickEvent>;
 }
+/**
+ * A column for displaying dropdown command buttons in a data table.
+ *
+ * @category Components
+ */
 export declare class AXRowDropdownCommandColumnComponent extends AXBaseRowCommandColumnComponent {
+    /**
+     *  @ignore
+     */
     private _cellTemplate;
+    /**
+     * Returns the template used for rendering cell content.
+     * This method provides the cell template used in the data table column, falling back to a default template if none is provided.
+     */
     get renderCellTemplate(): TemplateRef<unknown>;
+    /**
+     *  @ignore
+     */
     private _contentHeaderTemplate;
+    /**
+     * Returns the template used for rendering the header content.
+     * This method provides the header template used in the data table column.
+     */
     get renderHeaderTemplate(): TemplateRef<unknown>;
     footerTemplate: TemplateRef<unknown>;
+    /**
+     *  @ignore
+     */
     private _contentFooterTemplate;
+    /**
+     * Returns the template used for rendering the footer content.
+     * This method provides the footer template used in the data table column.
+     */
     get renderFooterTemplate(): TemplateRef<unknown>;
+    /**
+     * Returns the name identifier for the column component.
+     */
     get name(): string;
+    /**
+     *  @ignore
+     */
     protected _items: AXRowCommandItem[];
     items: AXRowCommandItem[] | ((rowData: unknown) => AXRowCommandItem[] | Promise<AXRowCommandItem[]>);
+    /**
+     *  @ignore
+     */
     protected handleOnOpened(rowData: any): Promise<void>;
+    /**
+     *  @ignore
+     */
     protected handleOnClosed(): void;
+    /**
+     *  @ignore
+     */
     protected handleOnItemClick(e: AXItemClickEvent<AXButtonItemComponent>, data: unknown): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXRowDropdownCommandColumnComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXRowDropdownCommandColumnComponent, "ax-dropdown-command-column", never, { "width": { "alias": "width"; "required": false; }; "caption": { "alias": "caption"; "required": false; }; "fixed": { "alias": "fixed"; "required": false; }; "footerTemplate": { "alias": "footerTemplate"; "required": false; }; "items": { "alias": "items"; "required": false; }; }, { "onItemClick": "onItemClick"; }, never, never, false, never>;
 }
+/**
+ * A column for displaying command buttons in a data table.
+ *
+ * @category Components
+ */
 export declare class AXRowCommandColumnComponent extends AXBaseRowCommandColumnComponent {
+    /**
+     *  @ignore
+     */
     private _cellTemplate;
+    /**
+     * Returns the template used for rendering the cell content.
+     * Uses the specified cell template if provided; otherwise, falls back to a default template.
+     */
     get renderCellTemplate(): TemplateRef<unknown>;
+    /**
+     *  @ignore
+     */
     private _contentHeaderTemplate;
+    /**
+     * Returns the template used for rendering the header content.
+     * Overrides the base implementation to provide a specific template for the command column.
+     */
     get renderHeaderTemplate(): TemplateRef<unknown>;
+    /**
+     * Template used for rendering the footer content of the column.
+     */
     footerTemplate: TemplateRef<unknown>;
+    /**
+     *  @ignore
+     */
     private _contentFooterTemplate;
+    /**
+     * Gets the template used for rendering the footer content of the column.
+     * Returns `footerTemplate` if provided; otherwise, returns `_contentFooterTemplate`.
+     */
     get renderFooterTemplate(): TemplateRef<unknown>;
+    /**
+     * Gets the unique name identifier for the command column.
+     */
     get name(): string;
+    /**
+   * Defines the command items to display in the column.
+   * @defaultValue []
+   */
     items: AXRowCommandItem[] | ((rowData: unknown) => AXRowCommandItem[]);
+    /**
+     *  @ignore
+     */
     protected getItems(rowData: unknown): AXRowCommandItem[];
+    /**
+     *  @ignore
+     */
     protected handleOnItemClick(e: MouseEvent, item: AXRowCommandItem, data: unknown): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXRowCommandColumnComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXRowCommandColumnComponent, "ax-command-column", never, { "width": { "alias": "width"; "required": false; }; "caption": { "alias": "caption"; "required": false; }; "fixed": { "alias": "fixed"; "required": false; }; "footerTemplate": { "alias": "footerTemplate"; "required": false; }; "items": { "alias": "items"; "required": false; }; }, { "onItemClick": "onItemClick"; }, never, never, false, never>;

package/data-table/lib/columns/row-index-column.component.d.ts

@@ -1,22 +1,73 @@
 import { OnInit, TemplateRef } from '@angular/core';
 import { AXDataTableColumnComponent } from './data-table-column';
 import * as i0 from "@angular/core";
+/**
+ * Component for displaying row indices in a data table column.
+ *
+ * @category Components
+ */
 export declare class AXRowIndexColumnComponent extends AXDataTableColumnComponent implements OnInit {
     private grid;
     private unsubscriber;
+    /**
+     *  @ignore
+     */
     private _cellTemplate;
+    /**
+     * Provides the cell template for custom rendering if defined.
+     */
     get renderCellTemplate(): TemplateRef<unknown>;
+    /**
+     *  @ignore
+     */
     private _contentHeaderTemplate;
+    /**
+     * Provides the header template for custom rendering if defined.
+     */
     get renderHeaderTemplate(): TemplateRef<unknown>;
+    /**
+     * Template used for rendering the footer content of the column.
+     */
     footerTemplate: TemplateRef<unknown>;
+    /**
+     *  @ignore
+     */
     private _contentFooterTemplate;
+    /**
+     * Returns the template used for rendering the footer of the column.
+     * This method returns the `footerTemplate` if it is provided; otherwise, it defaults to the `_contentFooterTemplate`. This allows for custom footer content while falling back to a default template if no custom template is specified.
+     */
     get renderFooterTemplate(): TemplateRef<unknown>;
+    /**
+     * Gets the unique identifier name for the column.
+     */
     get name(): string;
+    /**
+   * Determines whether the index should be zero-padded.
+   * @defaultValue false
+   */
     padZero: boolean;
+    /**
+     *  @ignore
+     */
     protected formatCount: number;
+    /**
+     *  @ignore
+     */
     ngOnInit(): void;
+    /**
+   * Disables sorting for this column.
+   *
+   * @defaultValue false
+   */
     allowSorting: boolean;
+    /**
+   * Indicates whether loading is enabled for this component.
+   */
     get loadingEnabled(): boolean;
+    /**
+     * Gets the CSS class applied to the component.
+     */
     get cssClass(): string | undefined;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXRowIndexColumnComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXRowIndexColumnComponent, "ax-index-column", never, { "width": { "alias": "width"; "required": false; }; "caption": { "alias": "caption"; "required": false; }; "fixed": { "alias": "fixed"; "required": false; }; "footerTemplate": { "alias": "footerTemplate"; "required": false; }; "padZero": { "alias": "padZero"; "required": false; }; }, {}, never, never, false, never>;

package/data-table/lib/columns/row-select-column.component.d.ts

@@ -1,21 +1,68 @@
 import { TemplateRef } from '@angular/core';
 import { AXDataTableColumnComponent } from './data-table-column';
 import * as i0 from "@angular/core";
+/**
+ * Column component that provides checkboxes for row selection in a data table.
+ *
+ * @category Components
+ */
 export declare class AXRowSelectColumnComponent extends AXDataTableColumnComponent {
     private grid;
+    /**
+     *  @ignore
+     */
     private _cellTemplate;
+    /**
+     * Gets the template used to render cells in the column.
+     */
     get renderCellTemplate(): TemplateRef<unknown>;
+    /**
+     *  @ignore
+     */
     private _contentHeaderTemplate;
+    /**
+     * Gets the template used to render the column header.
+     */
     get renderHeaderTemplate(): TemplateRef<unknown>;
+    /**
+     *  @ignore
+     */
     private _contentFooterTemplate;
+    /**
+     * Gets the template used to render the column footer.
+     */
     get renderFooterTemplate(): TemplateRef<unknown>;
+    /**
+     * Gets the unique identifier for the column.
+     */
     get name(): string;
+    /**
+     *  @ignore
+     */
     private getDataSourceKey;
+    /**
+     *  @ignore
+     */
     protected isSelected(item: unknown): boolean;
+    /**
+     *  @ignore
+     */
     protected checkAllSelected(rows: any): any;
+    /**
+     *  @ignore
+     */
     protected checkAnySelected(rows: any): any;
+    /**
+     *  @ignore
+     */
     protected handleChange(item: unknown): void;
+    /**
+     *  @ignore
+     */
     protected handleSelectAll(rows: any): void;
+    /**
+     * Indicates whether loading is enabled for the column.
+     */
     get loadingEnabled(): boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXRowSelectColumnComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXRowSelectColumnComponent, "ax-select-column", never, { "width": { "alias": "width"; "required": false; }; "caption": { "alias": "caption"; "required": false; }; "fixed": { "alias": "fixed"; "required": false; }; }, {}, never, never, false, never>;

package/data-table/lib/data-table/data-table.component.d.ts

@@ -4,19 +4,57 @@ import { AfterViewInit, EventEmitter, OnInit, QueryList, Signal, TemplateRef, Wr
 import { AXBaseDataTable, AXColumnsOrderChangedEvent, AXDataTableRowClick, AXDataTableRowDbClick } from '../base-data-table.class';
 import { AXDataTableColumnComponent } from '../columns/data-table-column';
 import * as i0 from "@angular/core";
+/**
+ * Component for displaying and managing a data table with advanced features.
+ *
+ * @category Components
+ */
 export declare class AXDataTableComponent extends AXBaseDataTable implements OnInit, AfterViewInit {
     private _unsubscriber;
     private _zone;
+    /**
+     *  @ignore
+     */
     dataPager: any;
+    /**
+     *  @ignore
+     */
     protected rtl: boolean;
+    /**
+     *  @ignore
+     */
     protected displayedRows: WritableSignal<any[]>;
+    /**
+     *  @ignore
+     */
     protected page: WritableSignal<number>;
+    /**
+     *  @ignore
+     */
     protected pageSize: WritableSignal<number>;
+    /**
+     *  @ignore
+     */
     protected isLoading: WritableSignal<boolean>;
+    /**
+     *  @ignore
+     */
     protected columnsList: WritableSignal<any[]>;
+    /**
+     *  @ignore
+     */
     protected endFixedColumnsList: Signal<any[]>;
+    /**
+     *  @ignore
+     */
     protected startFixedColumnsList: Signal<any[]>;
+    /**
+     *  @ignore
+     */
     protected normalColumnsList: Signal<any[]>;
+    /**
+     *  @ignore
+     */
     protected resizeColumnProp: {
         startX: number;
         startWidth: number;
@@ -24,51 +62,213 @@ export declare class AXDataTableComponent extends AXBaseDataTable implements OnI
         newColumnWidth: number;
         thElement: any;
     };
+    /**
+     *  @ignore
+     */
     protected hasItems: boolean;
+    /**
+     *  @ignore
+     */
     protected totalRows: number;
+    /**
+     *  @ignore
+     */
     protected currentPage: number;
+    /**
+     *  @ignore
+     */
     protected totalPages: number;
+    /**
+     *  @ignore
+     */
     protected startRowIndex: number;
+    /**
+     * Template for custom row content.
+     */
     rowTemplate?: TemplateRef<unknown>;
+    /**
+     * Template to display when the table is empty.
+     */
     emptyTemplate?: TemplateRef<unknown>;
+    /**
+     * Defines if alternative row styling should be applied.
+     *
+     * @defaultValue `true`
+     */
     alternative: boolean;
+    /**
+     * Indicates if the table header should be displayed.
+     *
+     * @defaultValue `true`
+     */
     showHeader: boolean;
+    /**
+     * Indicates if the table header should be fixed.
+     *
+     * @defaultValue `true`
+     */
     fixedHeader: boolean;
+    /**
+    * Indicates if the table footer should be displayed.
+    *
+    * @defaultValue `false`
+    */
     showFooter: boolean;
+    /**
+   * Indicates if the table footer should be fixed.
+   *
+   * @defaultValue `true`
+   */
     fixedFooter: boolean;
+    /**
+   * Specifies the height of each item in the table.
+   *
+   * @defaultValue `40`
+   */
     itemHeight: number | 'auto';
+    /**
+    * Enables or disables row reordering.
+    *
+    * @defaultValue `false`
+    */
     allowReordering: boolean;
+    /**
+   * Enables or disables paging.
+   *
+   * @defaultValue `true`
+   */
     paging: boolean;
+    /**
+   * Specifies how data should be fetched.
+   *
+   * @defaultValue `'auto'`
+   */
     fetchDataMode: 'auto' | 'manual';
+    /**
+   * Configuration for loading state.
+   *
+   * @defaultValue `{ enabled: true, animation: true }`
+   */
     loading: {
         enabled: boolean;
         animation: boolean;
         loadingTemplate?: TemplateRef<unknown>;
     };
+    /**
+     *  @ignore
+     */
     private _focusedRow;
+    /**
+   * Gets the currently focused row.
+   */
     get focusedRow(): unknown;
+    /**
+   * Sets the currently focused row and emits the change event.
+   *
+   * @param v - The row to be focused.
+   */
     set focusedRow(v: unknown);
+    /**
+   * Emits when the focused row changes.
+   *
+   * @event
+   */
     focusedRowChange: EventEmitter<unknown>;
+    /**
+   * Emits when a row is clicked.
+   *
+   * @event onRowClick
+   */
     onRowClick: EventEmitter<AXDataTableRowClick>;
+    /**
+   * Emits when a row is double-clicked.
+   *
+   * @event onRowDbClick
+   */
     onRowDbClick: EventEmitter<AXDataTableRowDbClick>;
+    /**
+   * Emits when the order of columns changes.
+   *
+   * @event onColumnsOrderChanged
+   */
     onColumnsOrderChanged: EventEmitter<AXColumnsOrderChangedEvent>;
+    /**
+     *  @ignore
+     */
     private clickSubject;
+    /**
+     *  @ignore
+     */
     protected columns: QueryList<AXDataTableColumnComponent>;
+    /**
+     *  @ignore
+     */
     ngOnInit(): void;
+    /**
+     *  @ignore
+     */
     ngAfterViewInit(): void;
+    /**
+     *  @ignore
+     */
     protected drop(event: CdkDragDrop<any, any, any>): void;
+    /**
+     *  @ignore
+     */
     protected handleRowClick(event: MouseEvent, item: unknown): void;
+    /**
+     *  @ignore
+     */
     private handleRowSingleClick;
+    /**
+     *  @ignore
+     */
     protected onPageChanged(event: AXDataPagerChangedEvent): void;
+    /**
+     *  @ignore
+     */
     protected handleRowDoubleClick(e: MouseEvent, item: unknown): void;
+    /**
+   * Handles the click event on a column header.
+   * Toggles the sorting direction or removes the sort if already sorted.
+   *
+   * @param e - The mouse event triggered by the click.
+   * @param column - The column that was clicked.
+   * @ignore
+   */
     handleColumnClick(e: MouseEvent, column: AXDataTableColumnComponent): void;
+    /**
+     *  @ignore
+     */
     protected getSort(column: AXDataTableColumnComponent): string | undefined;
+    /**
+   * Refreshes the data in the data source and resets the data pager to the first page.
+   * @ignore
+   */
     refresh(): void;
+    /**
+     *  @ignore
+     */
     protected calculateRowIndex(index: number): number;
+    /**
+     *  @ignore
+     */
     protected onResizeColumnStart(event: MouseEvent, columnIndex: number): void;
+    /**
+     *  @ignore
+     */
     private onResizeColumnMove;
+    /**
+     *  @ignore
+     */
     private onResizeColumnEnd;
+    /**
+     *  @ignore
+     */
     private resetResizingProcess;
+    /**
+     *  @ignore
+     */
     private calculateStickyColumnsPositions;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXDataTableComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXDataTableComponent, "ax-data-table", never, { "dataSource": { "alias": "dataSource"; "required": false; }; "rowTemplate": { "alias": "rowTemplate"; "required": false; }; "emptyTemplate": { "alias": "emptyTemplate"; "required": false; }; "alternative": { "alias": "alternative"; "required": false; }; "showHeader": { "alias": "showHeader"; "required": false; }; "fixedHeader": { "alias": "fixedHeader"; "required": false; }; "showFooter": { "alias": "showFooter"; "required": false; }; "fixedFooter": { "alias": "fixedFooter"; "required": false; }; "itemHeight": { "alias": "itemHeight"; "required": false; }; "allowReordering": { "alias": "allowReordering"; "required": false; }; "paging": { "alias": "paging"; "required": false; }; "fetchDataMode": { "alias": "fetchDataMode"; "required": false; }; "loading": { "alias": "loading"; "required": false; }; "focusedRow": { "alias": "focusedRow"; "required": false; }; }, { "selectedRowsChange": "selectedRowsChange"; "focusedRowChange": "focusedRowChange"; "onRowClick": "onRowClick"; "onRowDbClick": "onRowDbClick"; "onColumnsOrderChanged": "onColumnsOrderChanged"; }, ["columns"], ["ax-header", "ax-footer"], false, never>;