@guiexpert/table 1.1.1 → 1.1.2

package/lib/table/action/action-id.type.d.ts

@@ -1,2 +1,14 @@
+/**
+ * An array of action identifiers.
+ *
+ * @type {ReadonlyArray<string>}
+ */
 export declare const actionIds: readonly ["START_EDITING", "TOGGLE_SELECTION", "SELECT_ALL", "DESELECT_ALL", "NAVIGATE_LEFT", "NAVIGATE_RIGHT", "NAVIGATE_UP", "NAVIGATE_DOWN"];
+/**
+ * Represents an action ID.
+ *
+ * @typedef {string} ActionId
+ * @memberof module:myModule
+ * @see module:myModule.actionIds
+ */
 export type ActionId = typeof actionIds[number];

package/lib/table/action/on-action-triggered.if.d.ts

@@ -1,4 +1,11 @@
 import { ActionId } from "./action-id.type";
 export interface OnActionTriggeredIf {
+    /**
+     * Triggers an action based on the provided action ID.
+     *
+     * @param {ActionId} actionId - The ID of the action to be triggered.
+     *
+     * @return {boolean} - Returns true if the action was successfully triggered; otherwise, false.
+     */
     onActionTriggered(actionId: ActionId): boolean;
 }

package/lib/table/action/osx-shortcut-actionId-mapping.d.ts

@@ -1,4 +1,9 @@
 import { ActionId } from "./action-id.type";
+/**
+ * Class representing the mapping of OS X shortcut actions to action IDs.
+ *
+ * @class OsxShortcutActionIdMapping
+ */
 export declare class OsxShortcutActionIdMapping {
     get(): {
         [key: string]: ActionId;

package/lib/table/action/shortcut-actionid-mapping.type.d.ts

@@ -1,4 +1,8 @@
 import { ActionId } from "./action-id.type";
+/**
+ * Represents a mapping of shortcut action IDs.
+ * @typedef {Object.<string, ActionId>} ShortcutActionIdMapping
+ */
 export type ShortcutActionIdMapping = {
     [key: string]: ActionId;
 };

package/lib/table/action/shortcut.service.d.ts

@@ -1,5 +1,8 @@
 import { TableScope } from "../table-scope";
 import { OnActionTriggeredIf } from "./on-action-triggered.if";
+/**
+ * Represents a service for managing shortcuts and triggering actions based on keyboard events.
+ */
 export declare class ShortcutService {
     protected tableScope: TableScope;
     private shortcutActionIdMapping;

package/lib/table/action/windows-shortcut-actionId-mapping.d.ts

@@ -1,4 +1,7 @@
 import { ActionId } from "./action-id.type";
+/**
+ * Class representing a mapping of Windows shortcut keys to action IDs.
+ */
 export declare class WindowsShortcutActionIdMapping {
     get(): {
         [key: string]: ActionId;

package/lib/table/color/color-rgb.if.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Represents a color in RGB format.
+ *
+ * @interface
+ */
 export interface ColorRgbIf {
     r: number;
     g: number;

package/lib/table/color/three-color-gradient-arg.if.d.ts

@@ -1,4 +1,9 @@
 import { ColorRgbIf } from "./color-rgb.if";
+/**
+ * Interface for defining the arguments of a three-color gradient.
+ *
+ * @interface
+ */
 export interface ThreeColorGradientArgIf {
     minValue: number;
     minColor: ColorRgbIf;

package/lib/table/color/two-color-gradient-arg.if.d.ts

@@ -1,4 +1,8 @@
 import { ColorRgbIf } from "./color-rgb.if";
+/**
+ * Interface representing arguments for a two-color gradient.
+ * @interface
+ */
 export interface TwoColorGradientArgIf {
     minValue: number;
     minColor: ColorRgbIf;

package/lib/table/data/common/aligns.d.ts

@@ -7,16 +7,39 @@ export declare const bodyCenter: {
 export declare const bodyRight: {
     body: string[];
 };
+/**
+ * Predefined CSS classes for aligning text to the left within a table for all three areas.
+ *
+ * @property {Array.<string>} header - The CSS class(es) for aligning text to the left in the table header.
+ * @property {Array.<string>} body - The CSS class(es) for aligning text to the left in the table body.
+ * @property {Array.<string>} footer - The CSS class(es) for aligning text to the left in the table footer.
+ */
 export declare const allLeft: {
     header: string[];
     body: string[];
     footer: string[];
 };
+/**
+ * Predefined CSS classes for aligning text to the center of the table cells for all three areas.
+ *
+ * @typedef {Object} AllCenter
+ * @property {Array.<string>} header - The alignment classes for the table header.
+ * @property {Array.<string>} body - The alignment classes for the table body.
+ * @property {Array.<string>} footer - The alignment classes for the table footer.
+ */
 export declare const allCenter: {
     header: string[];
     body: string[];
     footer: string[];
 };
+/**
+ * Predefined CSS classes for aligning text to the right of the table cells for all three areas.
+ *
+ * @type {Object}
+ * @property {Array} header - An array containing CSS classes for aligning text right in the table header.
+ * @property {Array} body - An array containing CSS classes for aligning text right in the table body.
+ * @property {Array} footer - An array containing CSS classes for aligning text right in the table footer.
+ */
 export declare const allRight: {
     header: string[];
     body: string[];

package/lib/table/data/common/area-map-factory.d.ts

@@ -1,5 +1,11 @@
 import { AreaObjectMap } from "./area-map";
 import { CellRendererIf } from "../../renderer/cell-render.if";
 export declare class AreaMapFactory {
+    /**
+     * A factory that creates a new AreaObjectMap with the given body renderer.
+     *
+     * @param {CellRendererIf} bodyRenderer - The renderer for the body of the map.
+     * @returns {AreaObjectMap<CellRendererIf>} The newly created AreaObjectMap.
+     */
     static body(bodyRenderer: CellRendererIf): AreaObjectMap<CellRendererIf>;
 }

package/lib/table/data/common/area-map.d.ts

@@ -1,4 +1,11 @@
 import { AreaObjectMapType } from "./area-map.type";
+/**
+ * An object map as container for all three areas.
+ *
+ * @template T - The type of objects stored in the map.
+ * @class
+ * @implements {AreaObjectMapType<T>}
+ */
 export declare class AreaObjectMap<T> implements AreaObjectMapType<T> {
     header?: T | undefined;
     body?: T | undefined;

package/lib/table/data/common/args-adjust-columns-to-row-parent-params.d.ts

@@ -2,6 +2,10 @@ import { AreaIdent } from "../tablemodel/area-ident.type";
 import { SideIdent } from "../side-ident.type";
 import { AreaModelIf } from "../tablemodel/areamodel/area-model.if";
 import { GeoData } from "../geo-data";
+/**
+ * Represents the parameters required for adjusting columns to the row parent.
+ * @interface ArgsAdjustColumnsToRowParentParams
+ */
 export interface ArgsAdjustColumnsToRowParentParams {
     areaIdent: AreaIdent;
     sideIdent: SideIdent;

package/lib/table/data/common/args-render-cell-div.d.ts

@@ -1,6 +1,23 @@
 import { AreaModelIf } from "../tablemodel/areamodel/area-model.if";
 import { AreaIdent } from "../tablemodel/area-ident.type";
 import { SideIdent } from "../side-ident.type";
+/**
+ * Represents the arguments required to render a cell div.
+ *
+ * @interface ArgsRenderCellDiv
+ * @property {AreaModelIf} areaModel - The area model for the cell.
+ * @property {AreaIdent} areaIdent - The identifier of the area.
+ * @property {SideIdent} sideIdent - The identifier of the side.
+ * @property {number} rowIndex - The index of the row.
+ * @property {number} index - The index of the cell.
+ * @property {number} left - The left position of the cell.
+ * @property {number} width - The width of the cell.
+ * @property {number} height - The height of the cell.
+ * @property {number} top - The top position of the cell.
+ * @property {HTMLDivElement} parent - The parent element of the cell.
+ * @property {boolean} lastRowOfModel - Indicates if the cell is in the last row of the model.
+ * @property {boolean} gammaRange - Indicates if the gamma range is enabled.
+ */
 export interface ArgsRenderCellDiv {
     areaModel: AreaModelIf;
     areaIdent: AreaIdent;

package/lib/table/data/common/boolean-function.d.ts

@@ -1,3 +1,15 @@
 export type BooleanFunction = () => boolean;
+/**
+ * Represents a function that always returns true.
+ *
+ * @function
+ * @returns {boolean} - Always returns true
+ */
 export declare const TrueFn: () => boolean;
+/**
+ * Represents a function that always returns `false`.
+ *
+ * @function
+ * @returns {boolean} Always returns `false`.
+ */
 export declare const FalseFn: () => boolean;

package/lib/table/data/common/cell-range.d.ts

@@ -4,6 +4,15 @@ export declare class CellRange {
     r2: number;
     c2: number;
     gammaRange: boolean;
+    /**
+     * Represents a constructor for a class.
+     * @constructor
+     * @param {number} r1 - The value for r1.
+     * @param {number} c1 - The value for c1.
+     * @param {number} r2 - The value for r2.
+     * @param {number} c2 - The value for c2.
+     * @param {boolean} [gammaRange=false] - The value for gammaRange. Defaults to false. gammaRange will be used for AreaModelCellGroups, but it's not implemented yet!
+     */
     constructor(r1: number, c1: number, r2: number, c2: number, gammaRange?: boolean);
     static create(params: {
         rowIndex1: number;

package/lib/table/data/common/checkbox-column-def.d.ts

@@ -2,6 +2,11 @@ import { SizeIf } from "./size.if";
 import { ColumnDefIf } from "../tablemodel/column/column-def.if";
 import { CellRendererIf } from "../../renderer/cell-render.if";
 import { AreaObjectMapType } from "./area-map.type";
+/**
+ * A pre-defined column definition for a checkbox representation.
+ *
+ * @implements {ColumnDefIf}
+ */
 export declare class CheckboxColumnDef implements ColumnDefIf {
     type: string;
     property: string;

package/lib/table/data/common/checked-type.d.ts

@@ -1 +1,6 @@
+/**
+ * Represents a checked type.
+ *
+ * @typedef {'none' | 'semi' | 'full'} CheckedType
+ */
 export type CheckedType = "none" | "semi" | "full";

package/lib/table/data/common/event/ge-cell-indices.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Represents the indices (position) of a cell in a table area.
+ */
 export declare class GeCellIndices {
     rowIndex: number;
     columnIndex: number;

package/lib/table/data/common/event/ge-key-event.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Represents a keyboard event.
+ *
+ * @class GeKeyEvent
+ */
 export declare class GeKeyEvent {
     status: "down" | "up";
     originalEvent?: KeyboardEvent | undefined;

package/lib/table/data/common/event/ge-model-change-event.d.ts

@@ -1,4 +1,7 @@
 import { GeCellIndices } from "./ge-cell-indices";
+/**
+ * Indicates that changes have occurred in the given cells.
+ */
 export declare class GeModelChangeEvent {
     cells: GeCellIndices[];
     constructor(cells: GeCellIndices[]);

package/lib/table/data/common/event/ge-mouse-event.d.ts

@@ -1,5 +1,8 @@
 import { AreaIdent } from "../../tablemodel/area-ident.type";
 import { SideIdent } from "../../side-ident.type";
+/**
+ * Represents a mouse event in the table.
+ */
 export declare class GeMouseEvent {
     rowIndex: number;
     rowTop: number;

package/lib/table/data/common/event/input/table-cell-update-event.d.ts

@@ -1,5 +1,17 @@
 import { TableCellUpdateEventIf } from "./table-cell-update-event.if";
 import { AreaIdent } from "../../../tablemodel/area-ident.type";
+/**
+ * Represents an event that occurs when a table cell is updated.
+ *
+ * @class
+ * @implements TableCellUpdateEventIf
+ *
+ * @param {AreaIdent} area - The identification of the area where the cell belongs.
+ * @param {number} rowIndex - The index of the row where the cell is located.
+ * @param {number} columnIndex - The index of the column where the cell is located.
+ * @param {any} value - The new value for the cell.
+ * @param {Object.<string, boolean>} cssClasses - An object containing CSS classes to be applied to the cell.
+ */
 export declare class TableCellUpdateEvent implements TableCellUpdateEventIf {
     area: AreaIdent;
     rowIndex: number;

package/lib/table/data/common/event/input/table-cell-update-event.if.d.ts

@@ -1,9 +1,50 @@
 import { AreaIdent } from "../../../tablemodel/area-ident.type";
+/**
+ * One event defines one table cell update operation.
+ * You can send an array of these event via TableApi#updateCells(events: TableCellUpdateEventIf[], repaintAll: boolean = false).
+ */
 export interface TableCellUpdateEventIf {
+    /**
+     * Represents an area identifier ("header" | "body" | "footer"), which defines the part of the table.
+     *
+     * @typedef {number} AreaIdent
+     */
     area: AreaIdent;
+    /**
+     * Represents the index of a row of the table.
+     *
+     * @typedef {number} rowIndex
+     */
     rowIndex: number;
+    /**
+     * Represents the index of a column in a data table.
+     *
+     * @typedef {number} columnIndex
+     */
     columnIndex: number;
+    /**
+     * The value can be any data type.
+     * It can store a string, number, boolean, object, function, or null.
+     * It is a flexible variable that can hold any value.
+     *
+     * This valie will be set to the area model for the cell (rowIndex, columnIndex).
+     *
+     * @type {*} - Represents any data type
+     */
     value: any;
+    /**
+     * Represents a collection of CSS classes with their corresponding boolean values.
+     * For each key-value pair of the object with a truthy value the corresponding key is used as a class name.
+     * For each key-value pair of the object with a falsy value the corresponding key will be removed from the class list of the cell div (dom node).
+     * Example:
+     *    {
+     *       low: val >= 0 && val <=5,
+     *       medium: val > 5 && val <= 10,
+     *       high: val > 10
+     *    }
+     *
+     * @typedef {Object.<string, boolean>} CssClasses
+     */
     cssClasses: {
         [key: string]: boolean;
     };

package/lib/table/data/common/filter-function.d.ts

@@ -1 +1,9 @@
+/**
+ * Represents a filter function that is used to determine if an element should be included in a filtered array.
+ * @template T The type of the elements in the array.
+ * @param {T} value The current element being evaluated.
+ * @param {number} index The index of the current element being evaluated.
+ * @param {T[]} array The array that the filter function was called upon.
+ * @returns {unknown} The result of the filter function evaluation: `true` if the element should be included, `false` otherwise.
+ */
 export type FilterFunction<T> = (value: T, index: number, array: T[]) => unknown;

package/lib/table/data/common/get-t.d.ts

@@ -1 +1,7 @@
+/**
+ * Represents a function that retrieves a value of type T.
+ * Returns the value of type T if it exists, otherwise undefined.
+ *
+ * @template T - The type of the value to be retrieved.
+ */
 export type GetT<T> = () => T | undefined;

package/lib/table/data/common/index-and-px.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Represents an index and pixel value pair.
+ */
 export declare class IndexAndPx {
     index: number;
     px: number;

package/lib/table/data/common/size.if.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Represents a size with a value and unit. At the moment only unit 'px' is implemented in the calculations.
+ * @interface
+ */
 export interface SizeIf {
     value: number;
     unit: "px" | "%";

package/lib/table/data/common/sort-item.d.ts

@@ -1,4 +1,7 @@
 import { SortState } from "./sort-state.type";
+/**
+ * Represents a sortable column with its sort order..
+ */
 export declare class SortItem {
     columnIndex: number;
     sortState: SortState;

package/lib/table/data/common/sort-state.type.d.ts

@@ -1 +1,7 @@
+/**
+ * Represents the sort state of a list or table.
+ * It can take one of the following values: "asc", "desc", or "" (empty string).
+ *
+ * @typedef {("asc" | "desc" | "")} SortState
+ */
 export type SortState = "asc" | "desc" | "";

package/lib/table/data/common/tree-arrow.type.d.ts

@@ -1 +1,8 @@
+/**
+ * Represents the arrow type for a tree node in a hierarchical structure.
+ *
+ * The arrow type determines the visual representation of the arrow icon associated with a tree node.
+ *
+ * @typedef {("none" | "hidden" | "collapsed" | "expanded")} TreeArrowType
+ */
 export type TreeArrowType = "none" | "hidden" | "collapsed" | "expanded";

package/lib/table/data/common/tree-row-if.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Represents a (table) row in a tree structure. It's a container object for T with additional tree node information.@template T - The type of data stored in each row.
+ */
 export interface TreeRowIf<T> {
     type?: 'TreeRow' | '';
     data: T;

package/lib/table/data/common/tree-row.d.ts

@@ -1,4 +1,8 @@
 import { TreeRowIf } from "./tree-row-if";
+/**
+ * Represents a (table) row in a tree structure. It's a container object for T with additional tree node information.
+ * @template T - The type of data stored in the row.
+ */
 export declare class TreeRow<T> implements TreeRowIf<T> {
     data: T;
     expanded: boolean;

package/lib/table/data/div-scope.type.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Represents a DivScope object.
+ *
+ * @typedef {{
+ *   parent: HTMLDivElement,
+ *   child: HTMLDivElement,
+ *   cache: { [key: number]: HTMLDivElement }
+ * }} DivScope
+ */
 export type DivScope = {
     parent: HTMLDivElement;
     child: HTMLDivElement;

package/lib/table/data/event/mouse-target-data.d.ts

@@ -1,6 +1,9 @@
 import { AreaIdent } from "../tablemodel/area-ident.type";
 import { AreaModelIf } from "../tablemodel/areamodel/area-model.if";
 import { TableScope } from "../../table-scope";
+/**
+ * Represents data about a mouse target. It's a helper class to extract all information from the target HTMLElement.
+ */
 export declare class MouseTargetData {
     rowIdx: number;
     colIdx: number;

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

@@ -1,3 +1,6 @@
+/**
+ * Represents geometric data with left, width, height, top coordinates and an optional index.
+ */
 export declare class GeoData {
     left: number;
     width: number;

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

@@ -1,3 +1,16 @@
+/**
+ * Represents an Icon with content, css style and css classes.
+ *
+ * Example:
+ *
+ * new Icon(
+ *    ">",
+ *    "transform: rotate(90deg) translate(66%, -66%); transform-origin: 0 0;",
+ *    ["gt-table-tree-arrow-expanded"]
+ * )
+ *
+ * @interface
+ */
 export interface IconIf {
     content: string;
     style: string;

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

@@ -1,4 +1,8 @@
 import { IconIf } from "./icon.if";
+/**
+ * Represents a class that defines sorted icons, which will displayed in the header (if column is sortable).
+ * @interface
+ */
 export interface SortedOptionsIf {
     iconAsc: IconIf;
     iconDesc: IconIf;