@avoraui/av-data-table 0.0.5 → 0.0.6

package/index.d.ts

@@ -1,213 +0,0 @@
-import * as i0 from '@angular/core';
-import { OnInit, OnChanges, EventEmitter, SimpleChanges } from '@angular/core';
-import { ControlValueAccessor } from '@angular/forms';
-import { PageEvent } from '@angular/material/paginator';
-
-interface Headers {
-    label: string;
-    align: 'left' | 'center' | 'right';
-}
-interface Columns {
-    field: string;
-    align: 'left' | 'center' | 'right';
-    color?: string;
-}
-
-declare class AvDataTable implements OnInit, OnChanges, ControlValueAccessor {
-    PageSize: number;
-    PageSizeOptions: Array<number>;
-    currentPage: number;
-    TableHeaders: Headers[];
-    TableColumns: Columns[];
-    protected TableData: any[];
-    Data: any[];
-    EnableActionColumn: boolean;
-    EnableButtonDelete: boolean;
-    EnableButtonModify: boolean;
-    onModify: EventEmitter<{
-        index: number;
-        modifiedItem: any;
-        disabled: boolean;
-    }>;
-    onNewItemAdded: EventEmitter<{
-        index: number;
-        dataSize: number;
-        removedItem: any;
-    }>;
-    onItemRemoved: EventEmitter<{
-        index: number;
-        dataSize: number;
-        removedItem: any;
-        disabled: boolean;
-    }>;
-    DisableRemove: boolean;
-    DisableModify: boolean;
-    gridTemplateColumns: string;
-    private onChange;
-    private onTouched;
-    constructor();
-    /**
-     * Lifecycle hook that is called after Angular has initialized all data-bound properties of a directive.
-     * This method is used to perform initialization logic for the component.
-     *
-     * It executes the following:
-     * - Initializes the paginator for managing paginated data display.
-     * - Calculates the grid template for layout adjustments.
-     * - Synchronizes data sources to ensure the component has up-to-date data.
-     *
-     * @return {void} This method does not return any value.
-     */
-    ngOnInit(): void;
-    /**
-     * Initializes the paginator configuration. Sets default values for PageSize, PageSizeOptions,
-     * and currentPage if they are undefined, null, or invalid. Ensures the PageSize is included
-     * in the PageSizeOptions array and sorts the options in ascending order.
-     *
-     * @return {void} Does not return a value.
-     */
-    initializePaginator(): void;
-    /**
-     * Handles changes to the component's input properties during the lifecycle of the component.
-     *
-     * This method is triggered whenever an input property bound to the component changes. It processes
-     * updates to properties such as `Data`, `PageSize`, `PageSizeOptions`, and `currentPage`, and
-     * ensures the internal state is kept in sync with the new inputs. Additionally, it updates the paginator
-     * and adjusts the current page as necessary.
-     *
-     * @param {SimpleChanges} changes - A collection of SimpleChange objects representing the changed properties.
-     * Each `SimpleChange` object provides information like the current and previous values as well as a flag
-     * indicating if it is the first change to this input.
-     * @return {void} - This method does not return any value.
-     */
-    ngOnChanges(changes: SimpleChanges): void;
-    /**
-     * Retrieves a subset of data from the full dataset based on the current page and page size.
-     *
-     * @return {Array} A portion of the TableData array corresponding to the current page.
-     */
-    getPaginatedData(): Array<any>;
-    /**
-     * Handles changes in the pagination state, such as changing the current page or the page size.
-     *
-     * @param {PageEvent} event - The event triggered by a pagination action that contains the updated page index and page size.
-     * @return {void} This method does not return anything.
-     */
-    pageChange(event: PageEvent): void;
-    /**
-     * Calculates the actual index in the dataset based on the paginated index.
-     *
-     * @param {number} paginatedIndex - The index within the current page of paginated data.
-     * @return {number} The actual index in the entire dataset.
-     */
-    getActualIndex(paginatedIndex: number): number;
-    /**
-     * Synchronizes external data source with the internal TableData.
-     * If the external Data differs from the current TableData, the TableData
-     * is updated with the values from Data and a change notification is triggered.
-     *
-     * @return {void} This method does not return a value.
-     */
-    syncDataSources(): void;
-    /**
-     * Updates the form value by notifying changes and updating external data if available.
-     * This method triggers the onChange callback with the current table data
-     * and notifies that the form field has been touched. Additionally, it updates
-     * the external data reference to ensure proper change detection in the parent components.
-     *
-     * @return {void} No return value.
-     */
-    updateFormValue(): void;
-    /**
-     * Calculates and sets the grid template for a layout based on the number of displayed headers
-     * and the presence of an action column. The grid template determines the column structure with
-     * equal fractions for data columns and a fixed width for the action column if enabled.
-     *
-     * @return {void} Does not return a value. Sets the `gridTemplateColumns` property to the calculated template.
-     */
-    calculateGridTemplate(): void;
-    /**
-     * Retrieves the headers that should be displayed in the table.
-     * The method includes or excludes the "action" column based on the value of `EnableActionColumn`.
-     *
-     * @return {TableProp[]} An array of headers to be displayed in the table. If `EnableActionColumn` is false, the "action" column is excluded.
-     */
-    getDisplayedHeaders(): Headers[];
-    /**
-     * Generates and returns an object representing CSS classes for a header based on its alignment property.
-     *
-     * @param {TableProp} header - An object containing header properties, including an alignment property ('center', 'right', or 'left').
-     * @return {Object} An object mapping class names to a boolean indicating their applicability based on the alignment of the header.
-     */
-    getHeaderFieldClasses(header: Headers): object;
-    /**
-     * Generates a mapping of CSS classes for a data field based on the alignment property of the given column.
-     *
-     * @param {Columns} column - The column object containing alignment information.
-     * @return {Object} An object where the keys are class names, and the values are booleans indicating whether each class applies.
-     */
-    getDataFieldClasses(column: Columns): object;
-    /**
-     * Retrieves the color property from the given column object.
-     *
-     * @param {Columns} column - The column object containing the color property.
-     * @return {string} The color associated with the column.
-     */
-    getDataFiledColor(column: Columns): any;
-    /**
-     * Retrieves the value of a specified column from the given item.
-     *
-     * @param {any} item - The object containing the data to extract the value from.
-     * @param {Columns} column - The column definition, including the field name or path.
-     * @return {string} The value of the specified column for the given item. If the field is not found, an empty string is returned.
-     */
-    getValueForColumn(item: any, column: Columns): string;
-    /**
-     * Retrieves a nested value from a given object based on a dot-separated path string.
-     * If the path does not exist or the value is undefined/null, it returns a placeholder '-'.
-     * If accessing an array, it maps the values at the given key and processes them.
-     *
-     * @param {any} object - The object from which the nested value is extracted.
-     * @param {string} path - The dot-separated string representing the path to the desired value.
-     * @return {any} The value found at the given path, an array joined into a string, or '-' if not found.
-     */
-    getNestedValue(object: any, path: string): any;
-    /**
-     * Removes an item from the data table at the specified index.
-     *
-     * @param {number} actualIndex - The index of the item to remove from the data table.
-     * @return {void} This method does not return a value.
-     */
-    removeItem(actualIndex: number): void;
-    /**
-     * Modifies an item at the specified index in the dataset. If the modification is disabled, emits an event without making any changes.
-     *
-     * @param {number} actualIndex - The index of the item to be modified in the dataset.
-     * @return {void} This method does not return a value.
-     */
-    modifyItem(actualIndex: number): void;
-    /**
-     * Registers a callback function to be called whenever the value changes.
-     *
-     * @param {any} fn - The function to be executed on a value change.
-     * @return {void} This method does not return a value.
-     */
-    registerOnChange(fn: any): void;
-    /**
-     * Registers a callback function that should be called when the control is touched.
-     *
-     * @param {any} fn - The callback function to execute when the control is touched.
-     * @return {void} This method does not return a value.
-     */
-    registerOnTouched(fn: any): void;
-    /**
-     * Writes a new value to the table data and resets to the first page.
-     *
-     * @param {any[]} value - The array of data to be written to the table.
-     * @return {void} Does not return a value.
-     */
-    writeValue(value: any[]): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<AvDataTable, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<AvDataTable, "av-data-table", never, { "PageSize": { "alias": "PageSize"; "required": false; }; "PageSizeOptions": { "alias": "PageSizeOptions"; "required": false; }; "currentPage": { "alias": "currentPage"; "required": false; }; "TableHeaders": { "alias": "TableHeaders"; "required": false; }; "TableColumns": { "alias": "TableColumns"; "required": false; }; "Data": { "alias": "Data"; "required": false; }; "EnableActionColumn": { "alias": "EnableActionColumn"; "required": false; }; "EnableButtonDelete": { "alias": "EnableButtonDelete"; "required": false; }; "EnableButtonModify": { "alias": "EnableButtonModify"; "required": false; }; "DisableRemove": { "alias": "DisableRemove"; "required": false; }; "DisableModify": { "alias": "DisableModify"; "required": false; }; }, { "onModify": "onModify"; "onNewItemAdded": "onNewItemAdded"; "onItemRemoved": "onItemRemoved"; }, never, never, true, never>;
-}
-
-export { AvDataTable };