@mediusinc/mng-commons 5.3.0-rc.3 → 5.3.0-rc.5

package/fesm2022/mediusinc-mng-commons-table-api.mjs

@@ -51,18 +51,27 @@ class TableDataProvider extends TableDataProviderInst {
         return tableDataProviderWithService(serviceType);
     }
 }
-function tableDataProvider(type, serviceType) {
-    return new TableDataProviderInst(undefined, serviceType);
+function tableDataProvider(type, serviceTypeOrOpts, 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+opts) {
+    if (serviceTypeOrOpts === undefined || typeof serviceTypeOrOpts === 'function') {
+        return new TableDataProviderInst(undefined, serviceTypeOrOpts);
+    }
+    else {
+        return new TableDataProviderInst(undefined, undefined);
+    }
 }
-function tableDataProviderWithService(serviceType) {
+function tableDataProviderWithService(serviceType, 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+opts) {
     return new TableDataProviderInst(undefined, serviceType);
 }
 function tableDataProviderFromClass(type, serviceType) {
     return new TableDataProviderInst(type, serviceType);
 }
-function tableDataProviderFromModel(model, serviceType) {
-    return typeof serviceType !== 'undefined'
-        ? new TableDataProviderInst(model.type, serviceType)
+function tableDataProviderFromModel(model, serviceTypeOrOpts, opts) {
+    return typeof serviceTypeOrOpts === 'function'
+        ? new TableDataProviderInst(model.type, serviceTypeOrOpts)
         : new TableDataProviderInst(model.type, undefined);
 }
 
@@ -308,9 +317,10 @@ class ColumnDescriptor {
     }
     /**
      * Converts column to given type with additional arguments
-     * @param type column type enum
-     * @param displayType column display type
-     * @param args any additional arguments for column (optional)
+     *
+     * @param type Column type enum.
+     * @param displayType Column display type
+     * @param args Any additional arguments that might be needed for specific target type.
      */
     asType(type, displayType, ...args) {
         switch (type) {
@@ -329,6 +339,11 @@ class ColumnDescriptor {
                 return this;
         }
     }
+    /**
+     * Set column display as number.
+     *
+     * @param opts Options for number display.
+     */
     asNumber(opts) {
         this._columnType = ColumnTypeEnum.Number;
         this._columnDisplayType = ColumnDisplayTypeEnum.Number;
@@ -339,12 +354,24 @@ class ColumnDescriptor {
         this._locale = opts?.locale;
         return this;
     }
+    /**
+     * Set column display as currency.
+     *
+     * @param opts Options for currency display.
+     */
     asCurrency(opts) {
         return this.asCurrencyUnsafe({
             ...opts,
             currencyProperty: opts?.currencyProperty ? opts.currencyProperty : undefined
         });
     }
+    /**
+     * Set column display as currency.
+     *
+     * This function is UNSAFE!
+     *
+     * @param opts Options for currency display.
+     */
     asCurrencyUnsafe(opts) {
         this._columnType = ColumnTypeEnum.Number;
         this._columnDisplayType = ColumnDisplayTypeEnum.Currency;
@@ -358,12 +385,24 @@ class ColumnDescriptor {
         this._locale = opts?.locale;
         return this;
     }
+    /**
+     * Set column display as date.
+     *
+     * @param displayFormat Date display format (in Angular date formatting).
+     */
     asDate(displayFormat = 'dd.MM.yyyy') {
         this._columnType = ColumnTypeEnum.Date;
         this._columnDisplayType = ColumnDisplayTypeEnum.Date;
         this._displayFormat = displayFormat;
         return this;
     }
+    /**
+     * Set column display as boolean.
+     *
+     * @param yes Translation key for true value.
+     * @param no Translation key for false value.
+     * @param asIcon Use true/false texts as icon.
+     */
     asBoolean(yes, no, asIcon = false) {
         this._columnType = ColumnTypeEnum.Boolean;
         this._columnDisplayType = ColumnDisplayTypeEnum.Boolean;
@@ -372,38 +411,76 @@ class ColumnDescriptor {
         this._booleanNo = no;
         return this;
     }
+    /**
+     * Set column display as enum.
+     *
+     * @param enumDesc Enum descriptor for value display.
+     */
     asEnumUnsafe(enumDesc) {
         this._columnType = ColumnTypeEnum.Enum;
         this._columnDisplayType = ColumnDisplayTypeEnum.Enum;
         this._enum = enumDesc;
         return this;
     }
+    /**
+     * Set column display with custom component.
+     *
+     * @param customComponentType Component type to be used for display. Must implement {IColumnValueComponent}.
+     */
     asCustomComponent(customComponentType) {
         this._columnType = ColumnTypeEnum.Custom;
         this._columnDisplayType = ColumnDisplayTypeEnum.Component;
         this._customComponentType = customComponentType;
         return this;
     }
+    /**
+     * Sets columns display as HTML using Angular innerHTML.
+     */
     asHtml() {
         this._columnDisplayType = ColumnDisplayTypeEnum.Html;
         return this;
     }
+    /**
+     * Sets the class names for the column.
+     *
+     * @param className - The class name for the element column.
+     * @param headerClassName - The class name for the header element of the column.
+     * @param classNameMapFn - A function to return class name based on the current class name and row item value.
+     */
     withClassName(className, headerClassName, classNameMapFn) {
         this._className = className ?? '';
         this._headerClassName = headerClassName ?? '';
         this._classNameMapFn = classNameMapFn;
         return this;
     }
+    /**
+     * Sets the width for the column.
+     *
+     * @param width - The desired width in percents (relative to table width).
+     * @param minWidth - The minimum width of column in pixels.
+     * @param maxWidth - The maximum width of column in pixels.
+     */
     withWidth(width, minWidth, maxWidth) {
         this._width = width ?? null;
         this._minWidth = minWidth ?? null;
         this._maxWidth = maxWidth ?? null;
         return this;
     }
+    /**
+     * Sets the title for the column. If title is undefined, then the title will be calculated based on table model (i18nBase) and column property.
+     *
+     * @param title - The title of the column.
+     */
     withTitle(title) {
         this._title = title;
         return this;
     }
+    /**
+     * Enables button that copies column value to the clipboard.
+     *
+     * @param hasCopyToClipboard - Flag to enable/disable the feature.
+     * @param clipboardValueGetter - Optional getter function to adjust the value to be copied to clipboard.
+     */
     withCopyToClipboard(hasCopyToClipboard = true, clipboardValueGetter) {
         this._hasCopyToClipboard = hasCopyToClipboard;
         if (clipboardValueGetter) {
@@ -411,31 +488,81 @@ class ColumnDescriptor {
         }
         return this;
     }
+    /**
+     * Sets the template for displaying value.
+     *
+     * Use `{{}}` syntax for string interpolation within template.
+     * Use `item` key to access value of row item.
+     *
+     * Example interpolates row item's title within some text:
+     * ```
+     * This template shows {{item.title}} value in column.
+     * ```
+     *
+     * @param {string} template - The template to set.
+     *
+     * @usageNotes
+     * Display item's title property within some text:
+     *
+     * ```
+     * This template shows {{item.title}} value in column.
+     * ```
+     */
     withTemplate(template) {
         this._template = template;
         return this;
     }
+    /**
+     * Sets the getter function for adjusting the column value for display.
+     *
+     * @param {GetterFn<ColumnValue, TableModel>} getter - The getter function to be used.
+     */
     withGetter(getter) {
         this._getter = getter;
         return this;
     }
+    /**
+     * Show text in multiple lines (useful for displaying of long texts).
+     *
+     * @param isMultiline Enables/disabled the feature.
+     */
     withMultiline(isMultiline = true) {
         this._isMultiline = isMultiline;
         return this;
     }
+    /**
+     * Shows the whole display value as text (usefule when display values are expected to be to long and/or are overflown).
+     *
+     * @param valueAsTooltip Enables/disabled the feature.
+     */
     withValueAsTooltip(valueAsTooltip = true) {
         this._hasValueAsTooltip = valueAsTooltip;
         return this;
     }
+    /**
+     * Enables ordering of column.
+     *
+     * @param isReorderable Flag to enable/disable reordering.
+     */
     withReorderable(isReorderable = true) {
         this._isReorderable = isReorderable;
         return this;
     }
+    /**
+     * Enables toggling column visibility.
+     *
+     * @param isReorderable Flag to enable/disable visibility toggle.
+     */
     withToggleable(isToggleable = true, isVisible = true) {
         this._isToggleable = isToggleable;
         this._isVisible = isVisible;
         return this;
     }
+    /**
+     * Enables localization of column by displaying flag if the column value is localized (or just displaying default fallback text).
+     *
+     * @param existsProperty Property to mark
+     */
     localized(existsProperty) {
         if (existsProperty) {
             this._localizationExistsProperty = existsProperty;
@@ -445,6 +572,9 @@ class ColumnDescriptor {
         }
         return this;
     }
+    /**
+     * Copies current descriptor to a new instance.
+     */
     copy() {
         const descriptor = new ColumnDescriptor(this._property);
         this.copyFieldsTo(descriptor);
@@ -559,19 +689,41 @@ class SortDescriptor {
     get defaultOrder() {
         return this._defaultOrder;
     }
+    /**
+     * Shows sort on column for giver property.
+     *
+     * @param property Column property.
+     */
     withShowOnColumn(property) {
         return this.withShowOnColumnUnsafe(property);
     }
+    /**
+     * Shows sort on column for giver property.
+     *
+     * This function is UNSAFE!
+     *
+     * @param property Column property.
+     */
     withShowOnColumnUnsafe(property) {
         this._showOnColumn = property;
         return this;
     }
+    /**
+     * Sets the default sort for this descriptor.
+     *
+     * @param {boolean} enabled - Enables/disables the feature. Default is true.
+     * @param {boolean} [ascending] - If the sort is ascending. Default is true.
+     * @param {number} [order] - Order index in case of multiple default sorts.
+     */
     withDefaultSort(enabled = true, ascending, order) {
         this._defaultIsEnabled = enabled;
         this._defaultIsAscending = ascending ?? true;
         this._defaultOrder = order;
         return this;
     }
+    /**
+     * Copies current descriptor to a new instance.
+     */
     copy() {
         const descriptor = new SortDescriptor(this._property);
         descriptor._defaultIsEnabled = this._defaultIsEnabled;
@@ -673,12 +825,6 @@ class TableDescriptorInst {
     get size() {
         return this._size;
     }
-    get tableFullHeightOffset() {
-        return this._tableFullHeightOffset;
-    }
-    get rowHeight() {
-        return this._rowHeight;
-    }
     get hasHover() {
         return this._hasHover;
     }
@@ -734,7 +880,7 @@ class TableDescriptorInst {
         return this._rowExpandableComponentType;
     }
     /**
-     * Track property is used for the purpose of combined saving user preferences in localstorage if 2 tables have the same track properties they will share the same localstorage entry.
+     * Identifier is used for the purpose of combined saving user preferences in localstorage if 2 tables have the same track properties they will share the same localstorage entry.
      * Similarly, this property can also be used to differentiate two tables of the same model on the same url (so that they have separate entries in localstorage).
      * @param identifier
      */
@@ -742,112 +888,236 @@ class TableDescriptorInst {
         this._identifier = identifier;
         return this;
     }
+    /**
+     * Sets the track property (identifier of table row) for the table.
+     *
+     * @param {keyof TableModel} property - The property to track the row items by.
+     */
     withTrackProperty(property) {
         return this.withTrackPropertyUnsafe(property);
     }
+    /**
+     * Sets the track property (identifier of table row) for the table.
+     *
+     * This function is UNSAFE!
+     *
+     * @param {string} property - The property to set '_trackProperty' to.
+     */
     withTrackPropertyUnsafe(property) {
         this._trackProperty = property;
         return this;
     }
+    /**
+     * Retrieves the column descriptor for the given property.
+     *
+     * @param {keyof TableModel} property - The property for column descriptor.
+     *
+     * @return The column descriptor.
+     */
     getColumn(property) {
         return this.getColumnUnsafe(property);
     }
+    /**
+     * Retrieves the column descriptor for the given property.
+     *
+     * This function is UNSAFE!
+     *
+     * @param {keyof TableModel} property - The property for column descriptor.
+     *
+     * @return The column descriptor.
+     */
     getColumnUnsafe(property) {
         return this._columns.find(col => col.property === property) ?? null;
     }
+    /**
+     * Removes the column descriptor for the given property.
+     *
+     * @param {keyof TableModel} property - The property for column descriptor.
+     */
     removeColumn(property) {
         this.removeColumnUnsafe(property);
     }
+    /**
+     * Removes the column descriptor for the given property.
+     *
+     * This function is UNSAFE!
+     *
+     * @param {keyof TableModel} property - The property for column descriptor.
+     */
     removeColumnUnsafe(property) {
         const columnIdx = this._columns.findIndex(c => c.property === property);
         this._columns.splice(columnIdx, 1);
     }
+    /**
+     * Adds column descriptor to table columns.
+     *
+     * @param {ColumnDescriptor<ColumnModel, TableModel, ColumnValue>} column - The property for column descriptor.
+     */
     withColumn(column) {
         this._columns.push(column);
         return this;
     }
+    /**
+     * Adds a column to the table.
+     *
+     * @param {PropertyKey} property - The property key of the column in the table model.
+     *
+     * @returns The newly added column descriptor.
+     */
     addColumn(property) {
         const column = new ColumnDescriptor(property);
         this._columns.push(column);
         return column;
     }
+    /**
+     * Adds a column with enum display to the table.
+     *
+     * @param {PropertyKey} property - The property key of the table model.
+     * @param {EnumDescriptor<Enum>} enumDesc - The enum descriptor for column display.
+     * @return {ColumnDescriptor<Enum, TableModel, TableModel[PropertyKey]>} - The added column descriptor.
+     */
     addColumnEnum(property, enumDesc) {
         const column = new ColumnDescriptor(property);
         column.asEnumUnsafe(enumDesc);
         this._columns.push(column);
         return column;
     }
+    /**
+     * Adds a column to the table.
+     *
+     * This function is UNSAFE!
+     *
+     * @param {string} property - The property key of the column in the table model.
+     *
+     * @returns The newly added column descriptor.
+     */
     addColumnUnsafe(property) {
         const column = new ColumnDescriptor(property);
         this._columns.push(column);
         return column;
     }
+    /**
+     * Adds one or more columns to the table model.
+     *
+     * @param properties - An array of property names to add as columns.
+     */
     withColumns(...properties) {
         properties.forEach(p => this.addColumn(p));
         return this;
     }
-    withColumnDescriptors(...descriptors) {
-        descriptors.forEach(d => this.withColumn(d));
-        return this;
-    }
+    /**
+     * Set the pagination mode for the table.
+     *
+     * @param {TablePaginationModeEnum} paginationMode - The pagination mode to set. Must be one of the values from the TablePaginationModeEnum.
+     */
     withPaginationMode(paginationMode) {
         this._paginationMode = paginationMode;
         return this;
     }
+    /**
+     * Sets the number of rows per page for a paginated display.
+     *
+     * @param {number} rows - The default number of rows to display per page.
+     * @param {Array<number>} [options] - Rows per page options to be available in table paginator.
+     */
     withRowsPerPage(rows, options) {
         this._defaultNumRows = rows;
         this._rowsPerPageOptions = options;
         return this;
     }
+    /**
+     * Sets the title for an instance of the class.
+     *
+     * @param {string} [title] - The title value to be set. It undefiend, no title will be displayed.
+     */
     withTitle(title) {
         this._title = title;
         return this;
     }
+    /**
+     * Shows/hides the header row with column titles.
+     *
+     * @param {boolean} hideHeader - A boolean value indicating whether to hide the header.
+     */
     withHideHeader(hideHeader = true) {
         this._hideHeader = hideHeader;
         return this;
     }
+    /**
+     * Adjusts loading display with custom text and/or icon.
+     *
+     * @param {string} [text] - Text to be displayed when loading indicator is shown.
+     * @param {string | null} [icon] - Icon to be used when loading indicator is shown.
+     */
     withLoading(text, icon) {
         this._loadingText = text;
         this._loadingIcon = icon === undefined ? 'pi pi-spinner' : icon;
         return this;
     }
     /**
-     * Helper method that enables/disables reorderable property on all columns currently in the descriptor.
-     * @param columnsReorderable
+     * Retrieves the sort descriptor for a given property.
+     *
+     * @param {Sorts} property - The property to retrieve the sort for.
+     *
+     * @return {SortDescriptor<TableModel> | null} The sort descriptor or null.
      */
-    withCurrentColumnsReorderable(columnsReorderable = true) {
-        for (const col of this.columns) {
-            col.withReorderable(columnsReorderable);
-        }
-        return this;
-    }
-    /**
-     * Helper method that enables/disables toggleable property on all columns currently in the descriptor.
-     * @param columnsToggleable
-     */
-    withCurrentColumnsToggleable(columnsToggleable = true) {
-        for (const col of this.columns) {
-            col.withToggleable(columnsToggleable);
-        }
-        return this;
-    }
     getSort(property) {
         return this.getSortUnsafe(property);
     }
+    /**
+     * Retrieves the sort descriptor for a given property.
+     *
+     * This function is UNSAFE!
+     *
+     * @param {Sorts} property - The property to retrieve the sort for.
+     *
+     * @return {SortDescriptor<TableModel> | null} The sort descriptor or null.
+     */
     getSortUnsafe(property) {
         return this._sorts.find(s => s.property === property) ?? null;
     }
+    /**
+     * Removes the sort for a given property.
+     *
+     * @param {Sorts} property - The property to remove the sort for.
+     */
     removeSort(property) {
         return this.removeSortUnsafe(property);
     }
+    /**
+     * Removes the sort for a given property.
+     *
+     * This function is UNSAFE!
+     *
+     * @param {Sorts} property - The property to remove the sort for.
+     */
     removeSortUnsafe(property) {
         const sortIdx = this._sorts.findIndex(c => c.property === property);
         this._sorts.splice(sortIdx, 1);
     }
+    /**
+     * Adds sort for the given property.
+     *
+     * @param property Property to add the sort for.
+     * @param isDefault If default sorting is enabled.
+     * @param ascending If default sort should be ascending.
+     *
+     * @return Created sort descriptor.
+     */
     addSort(property, isDefault = false, ascending) {
         return this.addSortUnsafe(property, isDefault, ascending);
     }
+    /**
+     * Adds sort for the given property.
+     *
+     * This function is UNSAFE!
+     *
+     * @param property Property to add the sort for.
+     * @param isDefault If default sorting is enabled.
+     * @param ascending If default sort should be ascending.
+
+     * @return Created sort descriptor.
+     */
     addSortUnsafe(property, isDefault = false, ascending) {
         const sort = new SortDescriptor(property);
         if (isDefault) {
@@ -859,16 +1129,50 @@ class TableDescriptorInst {
         this._sorts.push(sort);
         return sort;
     }
+    /**
+     * Adds sort for the given property.
+     *
+     * @param property Property to add the sort for.
+     * @param isDefault If default sorting is enabled.
+     * @param ascending If default sort should be ascending.
+     */
     withSort(property, isDefault = false, ascending) {
         return this.withSortUnsafe(property, isDefault, ascending);
     }
+    /**
+     * Adds sort for the given property.
+     *
+     * This function is UNSAFE!
+     *
+     * @param property Property to add the sort for.
+     * @param isDefault If default sorting is enabled.
+     * @param ascending If default sort should be ascending.
+     */
     withSortUnsafe(property, isDefault = false, ascending) {
         this.addSortUnsafe(property, isDefault, ascending);
         return this;
     }
+    /**
+     * Sets the default sorting for the property.
+     *
+     * @param property - The property to set default sort for.
+     * @param ascending - If the sorting should be ascending (default: true).
+     * @param order - The order for this default sort (default: 0).
+     * @param enabled - Enables/disabled the default sort.
+     */
     withDefaultSort(property, ascending, order, enabled) {
         return this.withDefaultSortUnsafe(property, ascending, order, enabled);
     }
+    /**
+     * Sets the default sorting for the property.
+     *
+     * This function is UNSAFE!
+     *
+     * @param property - The property to set default sort for.
+     * @param ascending - If the sorting should be ascending (default: true).
+     * @param order - The order for this default sort (default: 0).
+     * @param enabled - Enables/disabled the default sort.
+     */
     withDefaultSortUnsafe(property, ascending, order, enabled) {
         let sort = this._sorts.find(s => s.property === property);
         if (!sort) {
@@ -878,39 +1182,115 @@ class TableDescriptorInst {
         sort.withDefaultSort(enabled ?? true, ascending, order);
         return this;
     }
+    /**
+     * Add sorts for more properties.
+     *
+     * @param properties Properties to add the sorts for.
+     */
     withSorts(...properties) {
         return this.withSortsUnsafe(...properties);
     }
+    /**
+     * Add sorts for more properties.
+     *
+     * This function is UNSAFE!
+     *
+     * @param properties Properties to add the sorts for.
+     */
     withSortsUnsafe(...properties) {
         properties.forEach(p => {
             this._sorts.push(new SortDescriptor(p));
         });
         return this;
     }
+    /**
+     * Gets filter descriptor for given property.
+     *
+     * @param property Filter property
+     *
+     * @return Filter descriptor for property or null if not exists.
+     */
     getFilter(property) {
         return this.getFilterUnsafe(property);
     }
+    /**
+     * Gets filter descriptor for given property.
+     *
+     * This function is UNSAFE!
+     *
+     * @param property Filter property
+     *
+     * @return Filter descriptor for property or null if not exists.
+     */
     getFilterUnsafe(property) {
         return this._filters.find(s => s.property === property) ?? null;
     }
+    /**
+     * Removes filter descriptor for given property.
+     *
+     * @param property Filter property
+     */
     removeFilter(property) {
         return this.removeFilterUnsafe(property);
     }
+    /**
+     * Removes filter descriptor for given property.
+     *
+     * This function is UNSAFE!
+     *
+     * @param property Filter property
+     */
     removeFilterUnsafe(property) {
         const filterIdx = this._filters.findIndex(c => c.property === property);
         this._filters.splice(filterIdx, 1);
     }
+    /**
+     * Creates filter descriptor for the given property.
+     *
+     * @param property Filter property.
+     *
+     * @return Created filter descriptor.
+     */
     addFilter(property) {
         return this.addFilterUnsafe(property);
     }
+    /**
+     * Creates filter descriptor for the given property.
+     *
+     * This function is UNSAFE!
+     *
+     * @param property Filter property.
+     *
+     * @return Created filter descriptor.
+     */
     addFilterUnsafe(property) {
         const filter = new FilterDescriptor(property);
         this._filters.push(filter);
         return filter;
     }
+    /**
+     * Creates filter lookup descriptor for the given property.
+     *
+     * @param property Filter property.
+     * @param provider Lookup provider.
+     * @param optionsValueProperty Property on lookup provider's item (FilterModel) that will be used as filter value.
+     *
+     * @return Created filter lookup descriptor.
+     */
     addFilterLookup(property, provider, optionsValueProperty) {
         return this.addFilterLookupUnsafe(property, provider, optionsValueProperty);
     }
+    /**
+     * Creates filter lookup descriptor for the given property.
+     *
+     * This function is UNSAFE!
+     *
+     * @param property Filter property.
+     * @param provider Lookup provider.
+     * @param optionsValueProperty Property on lookup provider's item (FilterModel) that will be used as filter value.
+     *
+     * @return Created filter lookup descriptor.
+     */
     addFilterLookupUnsafe(property, provider, optionsValueProperty) {
         const filter = new FilterLookupDescriptor(property, {
             dataProvider: provider,
@@ -919,26 +1299,86 @@ class TableDescriptorInst {
         this._filters.push(filter);
         return filter;
     }
+    /**
+     * Creates filter lookup enum descriptor for the given property.
+     *
+     * @param property Filter property.
+     * @param enumDesc Descriptor for enum.
+     * @param options Optional options of enum values to be available to filter by.
+     *
+     * @return Created filter lookup enum descriptor.
+     */
     addFilterLookupEnum(property, enumDesc, options) {
         return this.addFilterLookupEnumUnsafe(property, enumDesc, options);
     }
+    /**
+     * Creates filter lookup enum descriptor for the given property.
+     *
+     * This function is UNSAFE!
+     *
+     * @param property Filter property.
+     * @param enumDesc Descriptor for enum.
+     * @param options Optional options of enum values to be available to filter by.
+     *
+     * @return Created filter lookup enum descriptor.
+     */
     addFilterLookupEnumUnsafe(property, enumDesc, options) {
         const filter = new FilterLookupEnumDescriptor(property, enumDesc, options);
         this._filters.push(filter);
         return filter;
     }
+    /**
+     * Creates filter descriptor from column. The column must exist on table descriptor.
+     *
+     * @param property Column property to add filter for.
+     * @param displayType Optional display type setting.
+     * @param forceSimple Forces simple creation of filter (no lookup or lookup enum filters).
+     *
+     * @throws {CommonsInternalError} If column for property doesn't exist.
+     *
+     * @return Created filter descriptor
+     */
     addFilterFromColumn(property, displayType, forceSimple = false) {
         return this.addFilterFromColumnUnsafe(property, displayType, forceSimple);
     }
+    /**
+     * Creates filter descriptors from columns. The columns must exist on table descriptor.
+     *
+     * @param properties Column properties to add filters for.
+     *
+     * @throws {CommonsInternalError} If column for property doesn't exist.
+     */
     withFiltersFromColumns(...properties) {
         return this.withFiltersFromColumnsUnsafe(...properties);
     }
+    /**
+     * Creates filter descriptors from columns. The columns must exist on table descriptor.
+     *
+     * This function is UNSAFE!
+     *
+     * @param properties Column properties to add filters for.
+     *
+     * @throws {CommonsInternalError} If column for property doesn't exist.
+     */
     withFiltersFromColumnsUnsafe(...properties) {
         properties.forEach(p => {
             this.addFilterFromColumnUnsafe(p);
         });
         return this;
     }
+    /**
+     * Creates filter descriptor from column. The column must exist on table descriptor.
+     *
+     * This function is UNSAFE!
+     *
+     * @param property Column property to add filter for.
+     * @param displayType Optional display type setting.
+     * @param forceSimple Forces simple creation of filter (no lookup or lookup enum filters).
+     *
+     * @throws {CommonsInternalError} If column for property doesn't exist.
+     *
+     * @return Created filter descriptor
+     */
     addFilterFromColumnUnsafe(property, displayType, forceSimple = false) {
         const column = this.getColumnUnsafe(property);
         if (!column) {
@@ -949,6 +1389,18 @@ class TableDescriptorInst {
             filter.withDisplayType(displayType);
         return filter;
     }
+    /**
+     * Creates filter descriptor from provided column descriptor.
+     *
+     * This function is UNSAFE!
+     *
+     * @param column Column descriptor.
+     * @param forceSimple Forces simple creation of filter (no lookup or lookup enum filters).
+     *
+     * @throws {CommonsInternalError} If column for property doesn't exist.
+     *
+     * @return Created filter descriptor
+     */
     addFilterFromColumnDescriptorUnsafe(column, forceSimple = false) {
         let filterDescriptor = new FilterDescriptor(column.property);
         let filterType;
@@ -984,42 +1436,90 @@ class TableDescriptorInst {
         this._filters.push(filterDescriptor);
         return filterDescriptor;
     }
+    /**
+     * Adds filter descriptor for the given property.
+     *
+     * @param property Filter property.
+     * @param filter Descriptor for property.
+     */
     withFilter(property, filter) {
         if (filter.property !== property) {
             throw new CommonsInternalError(`Filter property "${property}" and Filter descriptor property "${filter.property}" do not match.`);
         }
         return this.withFilterUnsafe(filter);
     }
+    /**
+     * Adds filter descriptor for the given property.
+     *
+     * This function is UNSAFE!
+     *
+     * @param filter Descriptor for property.
+     */
     withFilterUnsafe(filter) {
         this._filters.push(filter);
         return this;
     }
+    /**
+     * Sets classes for table component.
+     *
+     * @param className Class names.
+     */
     withClassName(className) {
         this._className = className;
         return this;
     }
+    /**
+     * Sets table sizing.
+     *
+     * @param size Table size.
+     */
     withSize(size = TableSizeEnum.Normal) {
         this._size = size;
         return this;
     }
-    withTableFullHeightOffset(tableFullHeightOffset) {
-        this._tableFullHeightOffset = tableFullHeightOffset;
+    /**
+     * Enables hover effect on table rows.
+     *
+     * @param hover Enables/disables the hover.
+     */
+    withHover(hover = true) {
+        this._hasHover = hover;
         return this;
     }
-    withRowHeight(rowHeight) {
-        this._rowHeight = rowHeight;
+    /**
+     * Enables gridlines on table.
+     *
+     * @param gridlines Enables/disables the gridlines.
+     */
+    withGridlines(gridlines = true) {
+        this._hasGridlines = gridlines;
         return this;
     }
-    withHover(hover) {
-        this._hasHover = hover;
+    /**
+     * Enables/disables reorderable property on all columns currently in the descriptor.
+     *
+     * @param {boolean} [columnsReorderable] - Boolean flag to set reordering on columns to.
+     */
+    withCurrentColumnsReorderable(columnsReorderable = true) {
+        for (const col of this.columns) {
+            col.withReorderable(columnsReorderable);
+        }
         return this;
     }
-    withGridlines(gridlines) {
-        this._hasGridlines = gridlines;
+    /**
+     * Enables/disables toggleable property on all columns currently in the descriptor.
+     *
+     * @param {boolean} [columnsToggleable] - Boolean flag to set toggleable on columns to.
+     */
+    withCurrentColumnsToggleable(columnsToggleable = true) {
+        for (const col of this.columns) {
+            col.withToggleable(columnsToggleable);
+        }
         return this;
     }
     /**
-     * Method that enables/disabled column resize feature with columnResizeMode on all columns.
+     * Enables/disabled column resize feature with columnResizeMode on all columns.
+     *
      * @param resizableColumns True if enabled
      * @param columnResizeMode 'fit' or 'expand' mode
      */
@@ -1030,6 +1530,7 @@ class TableDescriptorInst {
     }
     /**
      * Sets column to (un)frozen.
+     *
      * @param selectionColumnFrozen True to freeze selection column, false to unfreeze it.
      * @param actionColumnFrozen True to freeze action column, false to unfreeze it.
      */
@@ -1038,24 +1539,50 @@ class TableDescriptorInst {
         this._actionColumnFrozen = actionColumnFrozen;
         return this;
     }
+    /**
+     * Sets the class name for rows in the table.
+     *
+     * @param {string} rowClassName - The CSS class name to be applied to each row.
+     * @param {function} [classNameMapFn] - Optional function to map the class name dynamically based on row's item and current class name.
+     */
     withRowClassName(rowClassName, classNameMapFn) {
         this._rowClassName = rowClassName;
         this._rowClassNameMapFn = classNameMapFn;
         return this;
     }
+    /**
+     * Sets header row class name.
+     *
+     * @param headerClassName Class name.
+     */
     withHeaderClassName(headerClassName) {
         this._headerClassName = headerClassName;
         return this;
     }
+    /**
+     * Enables localization of the table.
+     */
     withLocalized() {
         this._isLocalized = true;
         return this;
     }
-    withLocalizationLocaleProperty(localizationLocaleProperty) {
+    /**
+     * Sets locale property for localization.
+     *
+     * @param property Locale property
+     */
+    withLocalizationLocaleProperty(property) {
         this._isLocalized = true;
-        this._localizationLocaleProperty = localizationLocaleProperty;
+        this._localizationLocaleProperty = property;
         return this;
     }
+    /**
+     * Enables row expanding.
+     *
+     * @param property Property to check if row can be expanded.
+     * @param colSpan set custom row span for expanded row.
+     * @param componentType Component to be displayed on row expand.
+     */
     withRowExpandable(property, colSpan, componentType) {
         this._rowExpandable = true;
         if (property) {
@@ -1069,6 +1596,11 @@ class TableDescriptorInst {
         }
         return this;
     }
+    /**
+     * Enables row reordering.
+     *
+     * @param reordable Enables/disables feature.
+     */
     withRowReorderable(reordable = true) {
         this._rowReorderable = reordable;
         return this;
@@ -1081,8 +1613,6 @@ class TableDescriptorInst {
         obj._sorts = this._sorts.map(s => s.copy());
         obj._className = this._className;
         obj._size = this._size;
-        obj._tableFullHeightOffset = this._tableFullHeightOffset;
-        obj._rowHeight = this._rowHeight;
         obj._hasHover = this._hasHover;
         obj._hasGridlines = this._hasGridlines;
         obj._hasResizableColumns = this._hasResizableColumns;
@@ -1099,6 +1629,9 @@ class TableDescriptorInst {
         obj._rowExpandableComponentType = this._rowExpandableComponentType;
         obj._rowReorderable = this._rowReorderable;
     }
+    /**
+     * Copies current descriptor to a new instance.
+     */
     copy() {
         const descriptor = new TableDescriptorInst(this.model.copy());
         this.copyFieldsTo(descriptor);
@@ -1432,11 +1965,17 @@ function tableDynamicDescriptor(modelOrOpts) {
         : new TableDynamicDescriptorInst(new ModelDescriptor(undefined, modelOrOpts?.id, modelOrOpts?.title, modelOrOpts?.i18nBase));
 }
 
+function tableToDataProvider(descriptor, serviceType) {
+    return typeof serviceType !== 'undefined'
+        ? new TableDataProviderInst(undefined, serviceType)
+        : new TableDataProviderInst(undefined, undefined);
+}
+
 // data providers
 
 /**
  * Generated bundle index. Do not edit.
  */
 
-export { ColumnDescriptor, ColumnDisplayTypeEnum, ColumnDynamicDescriptor, ColumnTypeEnum, SortDescriptor, TableDataProvider, TableDataProviderInst, TableDescriptor, TableDescriptorInst, TableDynamicColumnsModeEnum, TableDynamicDescriptor, TableDynamicDescriptorInst, TablePaginationModeEnum, TableSizeEnum, columnToDateNumberOrBoolean, expandClassAttributeDefWithTableDef, getColumnDisplayTypeFromColumnType, getColumnTypeFromClassAttributeDefType, getTableClassAttributeDef, modifyTableClassAttributeColumnEnum, modifyTableClassAttributeColumnType, modifyTableClassAttributeColumnTypeUnsafe, modifyTableColumnFilterLookup, modifyTableColumnFilterLookupUnsafe, tableDataProvider, tableDataProviderFromClass, tableDataProviderFromModel, tableDataProviderWithService, tableDescriptor, tableDescriptorFromClass, tableDescriptorFromClassAttrsDef, tableDescriptorModifyEnumColumnUnsafe, tableDynamicDescriptor, upsertTableColumnFromAttributeDef };
+export { ColumnDescriptor, ColumnDisplayTypeEnum, ColumnDynamicDescriptor, ColumnTypeEnum, SortDescriptor, TableDataProvider, TableDataProviderInst, TableDescriptor, TableDescriptorInst, TableDynamicColumnsModeEnum, TableDynamicDescriptor, TableDynamicDescriptorInst, TablePaginationModeEnum, TableSizeEnum, columnToDateNumberOrBoolean, expandClassAttributeDefWithTableDef, getColumnDisplayTypeFromColumnType, getColumnTypeFromClassAttributeDefType, getTableClassAttributeDef, modifyTableClassAttributeColumnEnum, modifyTableClassAttributeColumnType, modifyTableClassAttributeColumnTypeUnsafe, modifyTableColumnFilterLookup, modifyTableColumnFilterLookupUnsafe, tableDataProvider, tableDataProviderFromClass, tableDataProviderFromModel, tableDataProviderWithService, tableDescriptor, tableDescriptorFromClass, tableDescriptorFromClassAttrsDef, tableDescriptorModifyEnumColumnUnsafe, tableDynamicDescriptor, tableToDataProvider, upsertTableColumnFromAttributeDef };
 //# sourceMappingURL=mediusinc-mng-commons-table-api.mjs.map