@guiexpert/table 1.1.0 → 1.1.2

package/lib/table/data/options/table-options.if.d.ts

@@ -9,34 +9,220 @@ import { SelectionModelIf } from "../../selection/selection-model.if";
 import { GetT } from "../common/get-t";
 import { FocusModelIf } from "../../focus/focus-model.if";
 import { ShortcutActionIdMapping } from "../../action/shortcut-actionid-mapping.type";
+/**
+ * Represents the options for configuring a table.
+ *
+ * | Class Property                   | Description                                                                                   |
+ * |----------------------------------|-----------------------------------------------------------------------------------------------|
+ * | headerSeparatorBorderVisible     | Indicates whether the header separator border is visible.                                      |
+ * | footerSeparatorBorderVisible     | Indicates whether the footer separator border is visible or not.                                |
+ * | fixedEastSeparatorBorderVisible  | Determines whether the fixed east separator border is visible.                                  |
+ * | fixedWestSeparatorBorderVisible  | Indicates whether the fixed west separator border should be visible.                            |
+ * | verticalBorderVisible            | Indicates whether the vertical border is visible.                                               |
+ * | horizontalBorderVisible          | Represents the visibility of the horizontal border.                                             |
+ * | overflowX                        | Determines the behavior of horizontal overflow for the table body (scroll port).               |
+ * | overflowY                        | Determines the behavior of vertical overflow for the table body (scroll port).                 |
+ * | tableTopBorderVisible            | Indicates whether the top border of a table is visible or hidden.                                |
+ * | tableBottomBorderVisible         | Specifies whether the bottom border of a table is visible.                                       |
+ * | hoverRowVisible                  | Flag indicating whether the hover color of a row is visible or not in general.                  |
+ * | hoverColumnVisible               | Flag indicating whether the hover color of a column is visible or not in general.               |
+ * | columnsResizable                 | Represents whether the columns are resizable.                                                    |
+ * | columnsDraggable                 | Flag indicating whether the columns are draggable.                                               |
+ * | columnResizeHandleWidthInPx      | The width of the column resize handle in pixels.                                                 |
+ * | headerVerticalSeparator          | Represents whether a vertical separator should be displayed in a header.                        |
+ * | footerVerticalSeparator          | Indicates whether a vertical separator should be displayed in the footer.                       |
+ * | defaultRowHeights                | Represents the default row heights for a given table.                                            |
+ * | headerToggleExpandCollapseIcons  | Indicates whether to show toggle icons in the header.                                            |
+ * | treeOptions                      | Represents the options for configuring a tree.                                                   |
+ * | showCheckboxWihoutExtraColumn    | Indicates whether to show checkbox without an extra column.                                       |
+ * | externalFilterFunction           | Represents the external filter function used to filter table rows.                                |
+ * | sortedOptions                    | Represents a sorted options object.                                                              |
+ * | sortOrder                        | Represents the sort order of the columns.                                                        |
+ * | autoRestoreOptions               | Represents auto restoration options.                                                             |
+ * | getEditRenderer                  | Retrieves the edit renderer for a specific action.                                                |
+ * | getSelectionModel                | Retrieves the selection model for a specific object.                                              |
+ * | getFocusModel                    | Retrieves the focus model of the component.                                                       |
+ * | shortcutActionIdMapping          | Represents a mapping of shortcut action IDs.                                                     |
+ */
 export interface TableOptionsIf {
+    /**
+     * Indicates whether the header separator border is visible.
+     *
+     * @type {boolean}
+     */
     headerSeparatorBorderVisible: boolean;
+    /**
+     * Indicates whether the footer separator border is visible or not.
+     *
+     * @type {boolean}
+     */
     footerSeparatorBorderVisible: boolean;
+    /**
+     * Determines whether the fixed east separator border is visible.
+     *
+     * @type {boolean}
+     */
     fixedEastSeparatorBorderVisible: boolean;
+    /**
+     * Indicates whether the fixed west separator border should be visible.
+     *
+     * @type {boolean}
+     */
     fixedWestSeparatorBorderVisible: boolean;
+    /**
+     * Indicates whether the vertical border is visible.
+     *
+     * @type {boolean}
+     */
     verticalBorderVisible: boolean;
+    /**
+     * Represents the visibility of the horizontal border.
+     *
+     * @type {boolean}
+     */
     horizontalBorderVisible: boolean;
+    /**
+     * The value of the css `overflowX` determines the behavior of horizontal overflow for the table body (scroll port).
+     *
+     * @typedef {'auto' | 'scroll'} OverflowX
+     */
     overflowX: "auto" | "scroll";
+    /**
+     * The value of the css `overflowX` determines the behavior of vertical overflow for the table body (scroll port).
+     *
+     * @typedef {'auto' | 'scroll'} OverflowX
+     */
     overflowY: "auto" | "scroll";
+    /**
+     * Indicates whether the top border of a table is visible or hidden.
+     *
+     * @type {boolean}
+     */
     tableTopBorderVisible: boolean;
+    /**
+     * Specifies whether the bottom border of a table is visible.
+     *
+     * @type {boolean}
+     */
     tableBottomBorderVisible: boolean;
+    /**
+     * Flag indicating whether the hover color of a row is visible or not in general.
+     * If true, the row get the hover background color while the mouse is over the row.
+     *
+     * @type {boolean}
+     */
     hoverRowVisible: boolean;
+    /**
+     * Flag indicating whether the hover color of a column is visible or not in general.
+     * If true, the column get the hover background color while the mouse is over the column.
+     *
+     * @typedef {boolean} hoverColumnVisible
+     */
     hoverColumnVisible: boolean;
+    /**
+     * Represents whether the columns are resizable.
+     *
+     * @type {boolean}
+     */
     columnsResizable: boolean;
+    /**
+     * Flag indicating whether the columns are draggable.
+     *
+     * @type {boolean}
+     */
     columnsDraggable: boolean;
+    /**
+     * The width of the column resize handle in pixels.
+     *
+     * @type {number}
+     */
     columnResizeHandleWidthInPx: number;
+    /**
+     * Represents whether a vertical separator should be displayed in a header.
+     *
+     * @type {boolean}
+     * @since 1.0.0
+     */
     headerVerticalSeparator: boolean;
+    /**
+     * Indicates whether a vertical separator should be displayed in the footer.
+     *
+     * @type {boolean}
+     */
     footerVerticalSeparator: boolean;
+    /**
+     * Represents the default row heights (for header, body and footer) for a given table.
+     *
+     * @typedef {number[]} DefaultRowHeightsIf
+     * @description An array of numbers representing the default height for each row in a table.
+     */
     defaultRowHeights: DefaultRowHeightsIf;
     headerToggleExpandCollapseIcons: boolean;
+    /**
+     * Represents the options for configuring a tree.
+     *
+     * @typedef {Object} TreeOptions
+     * @property {number} [maxDepth] - Maximum depth of the tree.
+     * @property {boolean} [allowDuplicates] - Indicates if duplicate items are allowed in the tree.
+     * @property {string[]} [colors] - An array of color options for styling the tree.
+     */
     treeOptions: TreeOptionsIf;
+    /**
+     * Indicates whether to show checkbox without an extra column.
+     * If true and the row is checkable, a checkbox is rendered in the first column.
+     * If false and the row is checkable, a checkbox is rendered in an extra column left to the first column.
+     *
+     * @type {boolean}
+     */
     showCheckboxWihoutExtraColumn: boolean;
+    /**
+     * Represents the external filter function that will be used to filter the table rows.
+     *
+     * @typedef {FilterFunction<any> | undefined} externalFilterFunction
+     */
     externalFilterFunction: FilterFunction<any> | undefined;
+    /**
+     * Represents a sorted options object.
+     *
+     * @class
+     * @classdesc The SortedOptions represents a class that defines sorted icons, which will displayed in the header (if column is sortable).
+     */
     sortedOptions: SortedOptionsIf;
+    /**
+     * Represents the sort order of the columns.
+     *
+     * @typedef {SortState[]} sortOrder
+     */
     sortOrder: SortState[];
     autoRestoreOptions?: AutoRestoreOptionsIf<any>;
+    /**
+     * Retrieves the edit renderer for a specific action.
+     *
+     * @function
+     * @name getEditRenderer
+     * @param {string} action - The action for which to retrieve the edit renderer.
+     * @returns {GetEditRenderer} - The edit renderer for the specified action.
+     */
     getEditRenderer?: GetEditRenderer;
+    /**
+     * Retrieves the selection model for a specific object.
+     *
+     * @param {SelectionModelIf} targetObj - The target object to retrieve the selection model from.
+     * @return {GetT<SelectionModelIf>} - The selection model for the given object.
+     */
     getSelectionModel?: GetT<SelectionModelIf>;
+    /**
+     * Retrieves the focus model of the component.
+     *
+     * @returns {GetT<FocusModelIf>} The focus model of the component.
+     */
     getFocusModel?: GetT<FocusModelIf>;
+    /**
+     * Represents a mapping of shortcut action IDs.
+     *
+     * @typedef {Object} ShortcutActionIdMapping
+     * @property {string} [shortcutId] - The ID of the shortcut.
+     * @property {string} [actionId] - The ID of the action associated with the shortcut.
+     */
     shortcutActionIdMapping?: ShortcutActionIdMapping;
 }

package/lib/table/data/side-ident.type.d.ts

@@ -1 +1,4 @@
+/**
+ * Represents a class that identifies a (vertical) side of the table.
+ */
 export type SideIdent = "west" | "center" | "east";

package/lib/table/data/table-model-and-options.d.ts

@@ -1,6 +1,9 @@
 import { TableModelAndOptionsIf } from "./table-model-and-options.if";
 import { TableModelIf } from "./tablemodel/table-model.if";
 import { TableOptions } from "./options/table-options";
+/**
+ * Container object for one table model and one table options object.
+ */
 export declare class TableModelAndOptions implements TableModelAndOptionsIf {
     tableModel: TableModelIf;
     tableOptions: TableOptions;

package/lib/table/data/table-model-and-options.if.d.ts

@@ -1,5 +1,8 @@
 import { TableModelIf } from "./tablemodel/table-model.if";
 import { TableOptions } from "./options/table-options";
+/**
+ * Interface for a container object for one table model and one table options object.
+ */
 export interface TableModelAndOptionsIf {
     tableModel: TableModelIf;
     tableOptions: TableOptions;

package/lib/table/data/tablemodel/area-ident.type.d.ts

@@ -1,5 +1,5 @@
 /**
- * The AreaIdent is an identifier for the three areas : header, boder, and footer.
+ * The AreaIdent is an identifier for the three areas : header, body, and footer.
  */
 export type AreaIdent = "header" | "body" | "footer";
 /**

package/lib/table/data/tablemodel/areamodel/area-model-array-of-arrays.d.ts

@@ -2,6 +2,10 @@ import { AbstractAreaModel } from "./abstract-area-model";
 import { AreaIdent } from "../area-ident.type";
 import { ColumnDefIf } from "../column/column-def.if";
 import { FilterFunction } from "../../common/filter-function";
+/**
+ * Represents a model for an area containing a two-dimensional array of data.
+ * @template T - The type of data in the array.
+ */
 export declare class AreaModelArrayOfArrays<T> extends AbstractAreaModel<T[][]> {
     areaIdent: AreaIdent;
     readonly arr: T[][];

package/lib/table/data/tablemodel/areamodel/area-model-hidden.d.ts

@@ -6,7 +6,7 @@ import { FilterFunction } from "../../common/filter-function";
 import { SortItem } from "../../common/sort-item";
 import { AreaIdent } from "../area-ident.type";
 /**
- * An unvisible model, which is used internally for hiding a header.
+ * An invisible model, which is used internally for hiding a header.
  */
 export declare class AreaModelHidden implements AreaModelIf {
     areaIdent: AreaIdent;

package/lib/table/data/tablemodel/areamodel/area-model-object-array-with-columndefs.d.ts

@@ -1,6 +1,11 @@
 import { AreaModelObjectyArray } from "./area-model-object-array";
 import { ColumnDefIf } from "../column/column-def.if";
 import { AreaIdent } from "../area-ident.type";
+/**
+ * Represents an array of objects with column definitions for an area model.
+ *
+ * @template T - The type of objects in the array.
+ */
 export declare class AreaModelObjectArrayWithColumndefs<T> extends AreaModelObjectyArray<T> {
     areaIdent: AreaIdent;
     protected readonly rows: T[];

package/lib/table/data/tablemodel/areamodel/area-model-object-array.d.ts

@@ -4,6 +4,10 @@ import { AreaIdent } from "../area-ident.type";
 import { FilterFunction } from "../../common/filter-function";
 import { SorterService } from "../../../service/sorter.service";
 import { SortItem } from "../../common/sort-item";
+/**
+ * Represents an area model defined by an object array.
+ * @template T - The type of objects in the array
+ */
 export declare class AreaModelObjectyArray<T> extends AbstractAreaModel<T> {
     areaIdent: AreaIdent;
     protected readonly rows: T[];

package/lib/table/data/tablemodel/areamodel/area-model-tree.d.ts

@@ -6,6 +6,12 @@ import { FilterFunction } from "../../common/filter-function";
 import { SorterService } from "../../../service/sorter.service";
 import { SortItem } from "../../common/sort-item";
 import { TreeRowIf } from "../../common/tree-row-if";
+/**
+ * Represents a  tree-based table model.
+ * Extends the AbstractAreaModel class.
+ *
+ * @template S - The type of the row data.
+ */
 export declare class AreaModelTree<S> extends AbstractAreaModel<TreeRow<S>> {
     areaIdent: AreaIdent;
     readonly rows: TreeRowIf<S>[];

package/lib/table/data/tablemodel/areamodel/area-model.d.ts

@@ -5,6 +5,9 @@ import { SortItem } from "../../common/sort-item";
 import { FilterFunction } from "../../common/filter-function";
 import { CellRendererIf } from "../../../renderer/cell-render.if";
 import { CheckedType } from "../../common/checked-type";
+/**
+ * Represents the area model (header, body or footer) for the table.
+ */
 export declare class AreaModel implements AreaModelIf {
     areaIdent: AreaIdent;
     rowSelectionModel: CheckboxModelIf<any> | undefined;

package/lib/table/data/tablemodel/areamodel/col-and-rowspan-model.d.ts

@@ -1,6 +1,9 @@
 import { CellRange } from "../../common/cell-range";
 import { AreaModelIf } from "./area-model.if";
 import { TableModelIf } from "../table-model.if";
+/**
+ * Represents a model for handling colspan and rowspan in a table.
+ */
 export declare class ColAndRowspanModel {
     protected tableModel: TableModelIf;
     protected areaModel: AreaModelIf;

package/lib/table/data/tablemodel/column/column-def.d.ts

@@ -7,6 +7,9 @@ import { BooleanFunction } from "../../common/boolean-function";
 import { SortState } from "../../common/sort-state.type";
 import { GetEditRenderer } from "../../../renderer/edit/edit-cell-renderer.type";
 import { editInputPipe } from "../../../renderer/edit/edit-input-pipe.if";
+/**
+ * Represents a column definition for one column of the table.
+ */
 export declare class ColumnDef implements ColumnDefIf {
     property: string;
     headerLabel: string;

package/lib/table/data/tablemodel/column/column-def.if.d.ts

@@ -5,21 +5,134 @@ import { BooleanFunction } from "../../common/boolean-function";
 import { SortState } from "../../common/sort-state.type";
 import { GetEditRenderer } from "../../../renderer/edit/edit-cell-renderer.type";
 import { editInputPipe } from "../../../renderer/edit/edit-input-pipe.if";
+/**
+ * Represents a column definition of one table column.
+ */
 export interface ColumnDefIf {
+    /**
+     * Represents a property name of the table row element.
+     * @typedef {String} VariableProperty
+     */
     property: string;
+    /**
+     * Represents the label for a header.
+     *
+     * @typedef {string} headerLabel
+     */
     headerLabel: string;
+    /**
+     * Represents the size of a column along the width dimension.
+     *
+     * @typedef {number} Width
+     */
     width: SizeIf;
+    /**
+     * Represents the minimum width of a column.
+     *
+     * @typedef {SizeIf} minWidth
+     * @property {number} width - The minimum width value.
+     * @property {string} unit - The unit of measurement for the minimum width value.
+     *                           Default value is 'px' if not specified.
+     */
     minWidth: SizeIf;
+    /**
+     * Represents the maximum width of a column.
+     *
+     * @typedef {number} SizeIf
+     */
     maxWidth: SizeIf;
+    /**
+     * @typedef {Object} AreaObjectMapType
+     * @template T
+     * @property {Object.<string, T>} map - A mapping of strings to values of type T
+     */
     rendererMap: AreaObjectMapType<CellRendererIf>;
+    /**
+     * Represents an object that maps an area to a collection of objects.
+     *
+     * @typedef {Object.<string, string[]>} AreaObjectMapType
+     */
     classes: AreaObjectMapType<string[]>;
+    /**
+     * Determines whether or not a column can be sorted.
+     *
+     * @param {boolean} sortable - Specifies if an item is sortable.
+     * @returns {boolean} - Indicating whether the item is sortable or not.
+     */
     sortable?: BooleanFunction;
+    /**
+     * Determines if the sort icon is visible.
+     *
+     * @typedef {BooleanFunction} sortIconVisible
+     * @returns {boolean} Indicates whether the sort icon is visible.
+     */
     sortIconVisible?: BooleanFunction;
+    /**
+     * Represents a function that compares two values for sorting purposes.
+     * The function takes two arguments of type T, compares them, and returns a number.
+     * If the result is negative, it means 'a' comes before 'b' in the sorted order.
+     * If the result is positive, it means 'b' comes before 'a' in the sorted order.
+     * If the result is zero, it means the two values are considered equal for sorting purposes.
+     *
+     * @typeparam T The type of values being compared.
+     *
+     * @param a The first value to be compared.
+     * @param b The second value to be compared.
+     *
+     * @returns A number indicating the relative order of 'a' and 'b'.
+     */
     sortComparator?: <T>(a: T, b: T) => number;
+    /**
+     * Represents the state of sorting for a list.
+     *
+     * @typedef {Object} SortState
+     *
+     * @property {string} [sortKey] - The key to sort the list by. If not provided, no sorting will be applied.
+     * @property {boolean} [reverse] - Indicates whether the list should be sorted in reverse order. Defaults to false.
+     */
     sortState?: SortState;
+    /**
+     * Represents the order of multiple sort states.
+     *
+     * @typedef {SortState[]} SortStatesOrder
+     */
     sortStatesOrder?: SortState[];
+    /**
+     * Determines if a column is editable or not.
+     *
+     * @param {any} variable - The variable to check.
+     * @returns {boolean} - Returns true if the variable is editable, false otherwise.
+     */
     editable?: BooleanFunction;
+    /**
+     * Determines if the column is visible or not.
+     *
+     * @typedef {Function} isVisible
+     * @returns {boolean} - If the element is visible, returns true. Otherwise, returns false.
+     */
     isVisible?: BooleanFunction;
+    /**
+     * Retrieves the edit renderer for the column.
+     *
+     * @name getEditRenderer
+     * @function
+     * @param {HTMLElement} element - The element for which to retrieve the edit renderer.
+     * @returns {EditRenderer | null} - The edit renderer for the specified element, or null if not found.
+     */
     getEditRenderer?: GetEditRenderer;
+    /**
+     * Represents an edit input pipe.
+     *
+     * @typedef {object} editInputPipe
+     * @property {string} name - The name of the edit input pipe.
+     * @property {number} id - The unique identifier of the edit input pipe.
+     * @property {boolean} isActive - Indicates whether the edit input pipe is active.
+     * @property {function} execute - Executes the edit input pipe operation.
+     * @property {function} addFilter - Adds a filter to the edit input pipe.
+     * @property {function} removeFilter - Removes a filter from the edit input pipe.
+     * @property {function} clearFilters - Clears all filters from the edit input pipe.
+     * @property {function} setPriority - Sets the priority of the edit input pipe.
+     * @property {function} getStatus - Retrieves the current status of the edit input pipe.
+     */
     editInputPipe?: editInputPipe;
 }

package/lib/table/data/tablemodel/padding.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Represents padding values for the top, right, bottom, and left sides of an element.
+ */
 export declare class Padding {
     top: number;
     right: number;