@adaptabletools/adaptable-cjs 23.0.4 → 23.0.5-canary.1

package/src/Api/Internal/EventInternalApi.js

@@ -39,7 +39,6 @@ class EventInternalApi extends ApiBase_1.ApiBase {
             const visibleInNewState = this.getDashboardApi().internalApi.isToolbarInActiveTab(toolbarName, newDashboardState);
             const visibleInOldState = this.getDashboardApi().internalApi.isToolbarInActiveTab(toolbarName, oldDashboardState);
             if (visibleInNewState && visibleInOldState) {
-                // check for dashboard collapse/expand/hidden changes
                 return ((oldDashboardState.IsCollapsed && !newDashboardState.IsCollapsed) ||
                     (oldDashboardState.IsHidden && !newDashboardState.IsHidden));
             }
@@ -49,7 +48,6 @@ class EventInternalApi extends ApiBase_1.ApiBase {
             const visibleInNewState = this.getDashboardApi().internalApi.isToolbarInActiveTab(toolbarName, newDashboardState);
             const visibleInOldState = this.getDashboardApi().internalApi.isToolbarInActiveTab(toolbarName, oldDashboardState);
             if (visibleInNewState && visibleInOldState) {
-                // check for dashboard collapse/expand/hidden changes
                 return ((!oldDashboardState.IsCollapsed && newDashboardState.IsCollapsed) ||
                     (!oldDashboardState.IsHidden && newDashboardState.IsHidden));
             }

package/src/Api/Internal/ExportInternalApi.js

@@ -12,26 +12,19 @@ const Helper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/Helper
 const PopupRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/PopupRedux"));
 const InternalRedux_1 = require("../../Redux/ActionsReducers/InternalRedux");
 class ExportInternalApi extends ApiBase_1.ApiBase {
-    /**
-     * Value Items for Report Name Selection
-     */
     getAllAvailableReportNames() {
         return this.getExportApi()
             .getAllReports()
             .map((report) => report.Name);
     }
     isDataChangeInReport(cellDataChangedInfo, report) {
-        // for All Data Report any data change is true so get out asap
         if (report.Name == 'All Data') {
             return true;
         }
-        // Start with the DataChanged Column and go through all possibilities
         switch (report.ReportColumnScope) {
             case 'AllColumns':
-                // has to be relevant so continue to rows
                 break;
             case 'ScopeColumns':
-                // use the Scope object which will tell us if the Column is relevant
                 if (!this.getAdaptableApi().columnScopeApi.isColumnInScopeColumns(cellDataChangedInfo.column, report.Scope)) {
                     return false;
                 }
@@ -45,27 +38,23 @@ class ExportInternalApi extends ApiBase_1.ApiBase {
                 }
                 break;
             case 'VisibleColumns':
-                //  hope that visible column property is updated whenever the layout changes... (need to check!)
                 if (!cellDataChangedInfo.column.visible) {
                     return false;
                 }
                 break;
         }
-        // now do rows
         switch (report.ReportRowScope) {
             case 'AllRows':
                 return true;
             case 'ExpressionRows':
-                return true; // TODO this is the only difficult one - do we check AdapTableQL?  if we can then that is good as we can then do a delta after all...
+                return true;
             case 'SelectedRows':
-                // CellSelection
                 let selectedCellInfo = this.getAdaptableApi().gridApi.getSelectedCellInfo();
                 if (selectedCellInfo && selectedCellInfo.gridCells) {
                     if (selectedCellInfo.gridCells.find((gc) => gc.primaryKeyValue == cellDataChangedInfo.primaryKeyValue)) {
                         return true;
                     }
                 }
-                // Row Selection
                 let selectedRowInfo = this.getAdaptableApi().gridApi.getSelectedRowInfo();
                 if (selectedRowInfo && selectedRowInfo.gridRows) {
                     if (selectedRowInfo.gridRows.find((gr) => gr.primaryKeyValue == cellDataChangedInfo.primaryKeyValue)) {
@@ -247,8 +236,6 @@ class ExportInternalApi extends ApiBase_1.ApiBase {
                 Id: 'export-destination-form',
                 Form: customDestination?.form,
                 prepareContext: (context) => {
-                    // we want to give the current popup time to close
-                    // and we reopen with a delay in case this button action causes another popup
                     return new Promise((resolve) => {
                         setTimeout(() => {
                             const preparedContext = {
@@ -346,8 +333,6 @@ class ExportInternalApi extends ApiBase_1.ApiBase {
                 type: 'csv',
             };
         }
-        // theoretically 'VisualExcel' is not a valid export format for this function and should be suppressed from UI
-        // but just in case, we handle it here and return a "raw", unstyled Excel file
         if (exportFormat === 'Excel' || exportFormat === 'VisualExcel') {
             const excelExportConverter = this.buildExcelConverter(exportContext.report.Name, exportFormat, exportContext.destination);
             const excelData = excelExportConverter(reportData);

package/src/Api/Internal/ExpressionInternalApi.js

@@ -5,11 +5,6 @@ const tslib_1 = require("tslib");
 const ApiBase_1 = require("../Implementation/ApiBase");
 const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
 class ExpressionInternalApi extends ApiBase_1.ApiBase {
-    /**
-     * Checks if a column is referenced in a given Expression
-     * @param columnId Column to Check
-     * @param expression Expression to Lookup
-     */
     isColumnReferencedInExpression(columnId, expression) {
         const colIds = this.getExpressionApi().getColumnsFromExpression(expression);
         return colIds.some((c) => c === columnId);
@@ -48,9 +43,6 @@ class ExpressionInternalApi extends ApiBase_1.ApiBase {
         }
         if (predicates) {
             context.predicates = predicates;
-            // need to find a way to get the columns in the predicates
-            // cand do later
-            //        this.getAdaptableApi().columnScopeApi.getColumnsInScope();
         }
         return !evaluateExpressionExternallyFn(context);
     }
@@ -71,21 +63,6 @@ class ExpressionInternalApi extends ApiBase_1.ApiBase {
             ...field,
             label: field.label || field.name,
         }));
-        // const existingFields = new Set<string>();
-        // Exclude fields already in options
-        // optionFields.forEach((field) => existingFields.add(field.value));
-        // const queriableColumns = this.getColumnApi().getQueryableColumns();
-        // Exclude queriable columns
-        // queriableColumns.forEach((column) => existingFields.add(column.field));
-        // const dataFields = this.getFieldsFromData(data).reduce<AdaptableField[]>((acc, field) => {
-        //   if (!existingFields.has(field)) {
-        //     acc.push({
-        //       label: field,
-        //       value: field,
-        //     });
-        //   }
-        //   return acc;
-        // }, []);
         return optionFields;
     }
     getFieldType(field) {

package/src/Api/Internal/Fdc3InternalApi.js

@@ -162,14 +162,12 @@ class Fdc3InternalApi extends ApiBase_1.ApiBase {
     handleIntentResolution(intentResolution, context, raisedIntent, app) {
         const relevantRaiseIntentConfig = this.getAllRaiseIntentConfigs().find((config) => config.intentType === raisedIntent && config.contextType === context.type);
         if (typeof relevantRaiseIntentConfig?.handleIntentResolution === 'function') {
-            // call intent specific resolution handler
             relevantRaiseIntentConfig.handleIntentResolution({
                 ...this.getAdaptableInternalApi().buildBaseContext(),
                 intentResolution,
             });
         }
         else {
-            // call global resolution handler (if any)
             this.getFdc3Options().intents?.handleIntentResolution?.({
                 ...this.getAdaptableInternalApi().buildBaseContext(),
                 intentResolution,
@@ -225,7 +223,6 @@ class Fdc3InternalApi extends ApiBase_1.ApiBase {
         const defaultConfig = this.getAdaptableInternalApi()
             .getFdc3Service()
             .getUiControlsDefaultConfiguration();
-        // @ts-ignore
         const intentIcon = defaultConfig?.intents[intentType]?.icon ?? {
             name: 'fdc3',
         };
@@ -235,14 +232,12 @@ class Fdc3InternalApi extends ApiBase_1.ApiBase {
         const defaultConfig = this.getAdaptableInternalApi()
             .getFdc3Service()
             .getUiControlsDefaultConfiguration();
-        // @ts-ignore
         const contextIcon = defaultConfig?.contexts[contextType]?.icon ?? {
             name: 'fdc3',
         };
         return contextIcon;
     }
     mapRowValueToContextData(rowNode, contextMapping = {}) {
-        // recursively map the row node values to the context data
         const mapContext = (obj) => {
             return Object.keys(obj).reduce((mappedData, contextKey) => {
                 const valueReference = obj[contextKey];
@@ -253,20 +248,16 @@ class Fdc3InternalApi extends ApiBase_1.ApiBase {
                     mappedData[contextKey] = mapContext(valueReference);
                 }
                 else {
-                    // map value from row node
-                    // first validate refs
                     if (typeof valueReference !== 'string' ||
                         (!valueReference.startsWith(Fdc3Options_1.ColumnRefTypePrefix) &&
                             !valueReference.startsWith(Fdc3Options_1.FieldRefTypePrefix))) {
                         this.logError(`Invalid FDC3 value reference for '${contextKey}': ${valueReference}`);
                         return mappedData;
                     }
-                    // '_coldId.columnId'
                     if (valueReference.startsWith(Fdc3Options_1.ColumnRefTypePrefix)) {
                         const columnId = valueReference.replace(Fdc3Options_1.ColumnRefTypePrefix, '');
                         mappedData[contextKey] = this.getGridApi().getRawValueFromRowNode(rowNode, columnId);
                     }
-                    // '_field.fieldName'
                     if (valueReference.startsWith(Fdc3Options_1.FieldRefTypePrefix)) {
                         const fieldId = valueReference.replace(Fdc3Options_1.FieldRefTypePrefix, '');
                         mappedData[contextKey] = this.getAdaptableInternalApi().getValueUsingField(rowNode.data, fieldId);

package/src/Api/Internal/FlashingCellInternalApi.js

@@ -7,16 +7,11 @@ const Helper_1 = require("../../Utilities/Helpers/Helper");
 const AlertRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/AlertRedux"));
 const FlashingCellService_1 = require("../../Utilities/Services/FlashingCellService");
 class FlashingCellInternalApi extends ApiBase_1.ApiBase {
-    /**
-     * Merges a Flashing Cell Definition with default values
-     * @param flashingCellDefinition Flashing Cell Definition to Merge
-     */
     mergeFlashingCellDefinitionWithDefaults(flashingCellDefinition) {
         let flashingDefaults = this.getFlashingCellOptions();
         if (!flashingDefaults) {
             return flashingCellDefinition;
         }
-        // deep clone it, otherwise we will mutate&share(!!) the global flashingCellOptions object
         flashingDefaults = (0, Helper_1.cloneObject)(flashingDefaults);
         if (!flashingCellDefinition.DownChangeStyle && flashingDefaults.defaultDownChangeStyle) {
             flashingCellDefinition.DownChangeStyle = flashingDefaults.defaultDownChangeStyle;

package/src/Api/Internal/FormatColumnInternalApi.js

@@ -20,134 +20,70 @@ function getParentGroup(source) {
             return undefined;
         }
         const currentProvidedColumnGroup = current.getProvidedColumnGroup();
-        // for columns that don't belong to groups or belong to a group that doesn't have full depth
-        // there are artificial parent groups created by ag-grid
-        // so for the current column group, lets grab the leaf columns
-        // and if the only leaf column is the source column, then we can continue
-        // and do another iteration where we go up one level
         if (currentProvidedColumnGroup) {
             const leafColumns = current.getLeafColumns();
             if (leafColumns.length === 1 && leafColumns[0] === source) {
                 continue;
             }
-            // otherwise, we have found the parent group corresponding to the source column
             return currentProvidedColumnGroup;
         }
     }
     return undefined;
 }
 class FormatColumnInternalApi extends ApiBase_1.ApiBase {
-    /**
-     * Retrieves all Format Columns in Adaptable State with the `Style` property set
-     * @returns format columns
-     */
     getAllFormatColumnWithStyle(config) {
         return this.getFormatColumnApi()
             .getFormatColumns(config)
             .filter((fc) => fc.Style);
     }
-    /**
-     * Retrieves all Format Columns in Adaptable State with `DisplayFormat` property set
-     * @returns format columns
-     */
     getAllFormatColumnWithDisplayFormat(config) {
         return this.getFormatColumnApi()
             .getFormatColumns(config)
             .filter((fc) => fc.DisplayFormat);
     }
-    /**
-     * Get all FormatColumns which are defined for this column and have a custom AdaptableStyle
-     * @param column
-     * @param config
-     * @returns list of FormatColumn
-     *
-     * Precedence rule: a Format Column never **wins** against an active Styled
-     * Column for any property the Styled Column claims (via its `Font` or
-     * `Cell` slot). The slice-level merging is applied downstream in
-     * `AgGridColumnAdapter.getFormatColumnAndStyledColumnCellStyle`; this API
-     * still returns every Format Column whose scope matches the column.
-     */
     getFormatColumnsWithStyleForColumn(column, config) {
         const formatColumns = this.getAllFormatColumnWithStyle()
             .filter((formatColumn) => {
-            // FormatColumn default target is 'cell', so if no target is specified, we assume 'cell'
             const fcTarget = formatColumn.Target ?? 'cell';
             return fcTarget === config.target;
         })
             .filter((formatColumn) => config?.includeSuspended || !formatColumn.IsSuspended);
         return this.getFormatColumnWithColumnInScope(formatColumns, column);
     }
-    /**
-     * Gets Format Column if any for given Column which includes Style element with ClassName
-     * @param column The Column for which to retrieve the Format Column
-     * @returns format columns
-     */
     getFormatColumnWithStyleClassNameForColumn(column, config) {
         return this.getFormatColumnsWithStyleForColumn(column, config).filter((formatColumn) => StringExtensions_1.default.IsNotNullOrEmpty(formatColumn?.Style?.ClassName));
     }
     getFormatColumnWithColumnInScope(formatColumns, column) {
         return this.getFormatColumnInColumnScope(formatColumns).filter((scopedFormatColumn) => this.getColumnScopeApi().isColumnInScope(column, scopedFormatColumn.Scope));
     }
-    // TODO is this really needed, I don't think it achieves anything
     getFormatColumnInColumnScope(formatColumns) {
-        // we need to maintain the format columns order, therefore we will extract all 3 scope types in a single iteration
         return formatColumns.filter((fc) => {
-            return (
-                // this.getFormatColumnsWithColumnScope(formatColumns)
-                (this.getColumnScopeApi().scopeHasColumns(fc.Scope) ||
-                    // this.getFormatColumnsWithDataTypeScope(formatColumns)
-                    this.getColumnScopeApi().scopeHasDataType(fc.Scope) ||
-                    // this.getFormatColumnsWithAllScope(formatColumns)
-                    this.getColumnScopeApi().scopeIsAll(fc.Scope) || this.getColumnScopeApi().scopeHasColumnType(fc.Scope))
-            );
+            return (this.getColumnScopeApi().scopeHasColumns(fc.Scope) ||
+                this.getColumnScopeApi().scopeHasDataType(fc.Scope) ||
+                this.getColumnScopeApi().scopeIsAll(fc.Scope) ||
+                this.getColumnScopeApi().scopeHasColumnType(fc.Scope));
         });
     }
-    /**
-     * Get all FormatColumns which are defined for this column and have a custom DisplayFormat
-     * @param column
-     * @param config
-     * @returns list of FormatColumn
-     */
     getFormatColumnsWithDisplayFormatForColumn(column, config) {
         const formatColumns = this.getAllFormatColumnWithDisplayFormat()
             .filter((formatColumn) => {
-            // FormatColumn default target is 'cell', so if no target is specified, we assume 'cell'
             const fcTarget = formatColumn.Target ?? 'cell';
             return fcTarget === config.target;
         })
             .filter((formatColumn) => config?.includeSuspended || !formatColumn.IsSuspended);
         return this.getFormatColumnWithColumnInScope(formatColumns, column);
     }
-    /**
-     * Format value according to format options.
-     *
-     * @param customDisplayFormatterContext context that includes value to format
-     * @param options formatter options
-     */
     getNumberFormattedValue(value, node, column, options) {
         const preparedValue = this.applyCustomFormatters(value, node, column, options);
         return DisplayFormatHelper_1.default.NumberFormatter(preparedValue, options, node, column, this.getAdaptableApi());
     }
-    /**
-     * Format value according to format options.
-     *
-     * @param value  context that includes value to format
-     * @param options formatter options
-     */
     getStringFormattedValue(value, node, column, options) {
         const preparedValue = this.applyCustomFormatters(value, node, column, options);
         return DisplayFormatHelper_1.default.StringFormatter(preparedValue, options, node, column, this.getAdaptableApi());
     }
-    /**
-     * Format value according to format options.
-     *
-     * @param customDisplayFormatterContext  context that includes value to format
-     * @param options formatter options
-     */
     getDateFormattedValue(value, node, abColumn, options) {
         const preparedValue = this.applyCustomFormatters(value, node, abColumn, options);
         const dateFormatterOptions = options;
-        // only use DateFormatter if we have a pattern
         return dateFormatterOptions.Pattern
             ? DisplayFormatHelper_1.default.DateFormatter(preparedValue, options)
             : preparedValue;
@@ -158,7 +94,6 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
             return value;
         }
         const customFormattersFromOptions = this.getFormatColumnOptions()?.customDisplayFormatters ?? [];
-        // formatters are applied in the order they are defined in the options
         const customFormatters = customFormattersFromOptions.filter((customFormatterOption) => columnCustomFormatters.includes(customFormatterOption.id));
         const customDisplayFormatterContext = ObjectFactory_1.default.CreateCustomDisplayFormatterContext(value, node, abColumn, this.getAdaptableApi());
         return customFormatters.reduce((context, formatter) => {
@@ -168,10 +103,6 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
             return context.cellValue;
         }, customDisplayFormatterContext);
     }
-    /**
-     * Returns all Predicates appropriate for the given Scope
-     * @param scope Scope to check
-     */
     getFormatColumnDefsForScope(scope) {
         return this.getAdaptableApi()
             .predicateApi.internalApi.getFormatColumnPredicateDefs(scope)
@@ -200,7 +131,6 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
             columnGroupLeafColumns.length === 1 &&
             columnGroupLeafColumns[0] === agGridColumn;
         if (columnIsTopLevel) {
-            // for top-level columns don't apply formatColumns that have an explicit ColumnGroupScope defined
             return false;
         }
         if (formatColumn.ColumnGroupScope === 'Both') {
@@ -208,15 +138,7 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
         }
         return formatColumn.ColumnGroupScope === columnGroupScope;
     }
-    /**
-     * Checks if format column is relevant for a given cell (intersection of given AdaptableColumn and RowNode)
-     *
-     * @param formatColumn
-     * @param column
-     * @param params
-     */
     formatColumnShouldRenderInCell(formatColumn, column, rowNode, cellValue, pivotResultColumn) {
-        // suspended is important to be first
         if (formatColumn.IsSuspended) {
             return false;
         }
@@ -250,7 +172,6 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
         if (!formatColumn.Rule) {
             return true;
         }
-        // first run the predicate
         if (formatColumn.Rule.Predicates && formatColumn.Rule?.Predicates?.length) {
             const predicateDefHandlerContext = {
                 value: cellValue,
@@ -262,19 +183,12 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
                 ...this.getAdaptableInternalApi().buildBaseContext(),
             };
             return this.evaluatePredicate(formatColumn, predicateDefHandlerContext);
-        } // then run the Expression
+        }
         else if (formatColumn.Rule.BooleanExpression) {
             return this.evaluateExpression(formatColumn, rowNode, column, pivotResultColumn);
         }
-        // nothing has passed then return false
         return false;
     }
-    /**
-     * Checks if format column is relevant for a given Column Header
-     *
-     * @param formatColumn
-     * @param column
-     */
     formatColumnShouldRenderInHeader(formatColumn, column) {
         if (formatColumn.IsSuspended) {
             return false;
@@ -301,20 +215,9 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
             return false;
         }
     }
-    /**
-     * Extract from the given FormatColumns the one which is the most relevant  for a given cell (intersection of given AdaptableColumn and RowNode)
-     *
-     * @param formatColumns
-     * @param column
-     * @param params
-     */
     getMostRelevantFormatColumnForColumn(formatColumns, column, params) {
         return formatColumns.find((formatColumn) => this.formatColumnShouldRenderInCell(formatColumn, column, params.node, params.value));
     }
-    /**
-     * Retrieves all Format Columns which have an Expression
-     * @returns Format Columns with Expression
-     */
     getFormatColumnsWithExpression(config) {
         return this.getFormatColumnApi()
             .getFormatColumns(config)
@@ -325,9 +228,6 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
             .getFormatColumns(config)
             .filter((fc) => fc.Rule?.Predicates?.some((p) => columnSet.has(p.ColumnId)));
     }
-    /**
-     * Retrieves the columns that need rerendering based on format column predicates.
-     */
     getFormatColumnColumnsDependentOnColumnChange(column) {
         const impactedColumnIds = new Set();
         impactedColumnIds.add(column.columnId);
@@ -347,7 +247,6 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
         return [...columnsThatNeedRefresh];
     }
     formatColumnHeaderName(headerName, params) {
-        // currently we only format the header name for normal columns (NOT column groups)
         if (!params.column) {
             return headerName;
         }
@@ -364,7 +263,6 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
         }
         const resolvedDisplayFormat = (0, AdaptableFormatPresets_1.resolveDisplayFormat)(mostRelevantFormatColumn.DisplayFormat);
         if (resolvedDisplayFormat?.Formatter !== 'StringFormatter') {
-            // headers are always strings, so we can only use StringFormatter
             return headerName;
         }
         const formattedHeaderName = this.getFormatColumnApi().internalApi.getStringFormattedValue(headerName, null, abColumn, resolvedDisplayFormat.Options);

package/src/Api/Internal/FreeTextColumnInternalApi.js

@@ -9,10 +9,6 @@ const AdaptableDateEditor_1 = require("../../agGrid/editors/AdaptableDateEditor"
 const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
 const AdaptableColumn_1 = require("../../AdaptableState/Common/AdaptableColumn");
 class FreeTextColumnInternalApi extends ApiBase_1.ApiBase {
-    /**
-     * Checks if a User Edit was in a Free Text Column
-     * @param cellDataChangedInfo change to check
-     */
     handleFreeTextColumnDataChange(cellDataChangedInfo) {
         let freeTextColumn = this.getFreeTextColumnApi()
             .getFreeTextColumns()
@@ -25,10 +21,6 @@ class FreeTextColumnInternalApi extends ApiBase_1.ApiBase {
             this.getFreeTextColumnApi().setStoredValue(freeTextColumn.ColumnId, freeTextStoredValue);
         }
     }
-    /**
-     * Returns all the references in the AdaptableState of the given FreeTextColumn
-     * @param freeTextColumn FreeTextColumn to be checked
-     */
     getFreeTextColumnModuleReferences(freeTextColumn) {
         const references = [];
         this.getAdaptableInternalApi()

package/src/Api/Internal/GridFilterInternalApi.js

@@ -3,9 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GridFilterInternalApi = void 0;
 const ApiBase_1 = require("../Implementation/ApiBase");
 class GridFilterInternalApi extends ApiBase_1.ApiBase {
-    /**
-     * Compares to Grid Filter to see if they are identical
-     */
     isGridFilterDifferent(oldFilter, newFilter) {
         if (oldFilter == undefined && newFilter == undefined) {
             return false;

package/src/Api/Internal/GridInternalApi.js

@@ -11,10 +11,6 @@ const ScheduledAlertHelper_1 = require("../../Utilities/Helpers/Scheduling/Sched
 const UIHelper_1 = tslib_1.__importDefault(require("../../View/UIHelper"));
 const ApiBase_1 = require("../Implementation/ApiBase");
 class GridInternalApi extends ApiBase_1.ApiBase {
-    /**
-     * Gets all distinct display values in the Column for given ColumnId
-     * @param columnId Column to check
-     */
     getDistinctDisplayValuesForColumnOld(columnId) {
         const abColumn = this.getColumnApi().getColumnWithColumnId(columnId);
         if (abColumn == undefined) {
@@ -25,18 +21,6 @@ class GridInternalApi extends ApiBase_1.ApiBase {
             return cv.normalisedValue;
         });
     }
-    /**
-     * Gets all distinct Filter values for the Column with the given ColumnId
-     * used for Floating Filter and Column Header filter
-     * either returns a list of values or al ist a list of values with count
-     *
-     * This is a general method, and it is used in:
-     * - Column Filters
-     * - Query Builder
-     * - Permitted Values
-     *
-     * @param columnId Column to check
-     */
     async getDistinctFilterDisplayValuesForColumn(options) {
         const abColumn = this.getColumnApi().getColumnWithColumnId(options.columnId);
         if (abColumn == undefined) {
@@ -73,10 +57,6 @@ class GridInternalApi extends ApiBase_1.ApiBase {
         });
         return valueOptions || [];
     }
-    /**
-     * Gets all distinct raw values in Column. Values are sorted.
-     * @param columnId Column to check
-     */
     getDistinctRawValuesForColumn(columnId) {
         const abColumn = this.getColumnApi().getColumnWithColumnId(columnId);
         if (abColumn == undefined) {
@@ -86,10 +66,6 @@ class GridInternalApi extends ApiBase_1.ApiBase {
             return cv.rawValue;
         });
     }
-    /**
-     * Gets all distinct raw values in Column. Values are un-sorted.
-     * @param columnId Column to check
-     */
     getUnsortedDistinctRawValuesForColumn(columnId) {
         const abColumn = this.getColumnApi().getColumnWithColumnId(columnId);
         if (abColumn == undefined) {
@@ -103,9 +79,6 @@ class GridInternalApi extends ApiBase_1.ApiBase {
         const columnApi = this.getColumnApi();
         const rowNodesMapToCells = new Map();
         const allRowNodes = [];
-        // for each row node,let's create an object
-        // with only those gridcells that are needed - meaning
-        // for those column that are in the current sort
         const rowNodeCallback = (node) => {
             allRowNodes.push(node);
             const rowNodeCells = {};
@@ -127,15 +100,12 @@ class GridInternalApi extends ApiBase_1.ApiBase {
         }
         const sortInfo = columnSorts.map((columnSort) => {
             const { ColumnId } = columnSort;
-            // NOTE: the comparator we pass to multisort should always sort in ascending order
-            // that's why we pass SortOrder.Asc to the comparators
             const comparator = columnApi.hasNumberDataType(ColumnId)
                 ? (0, ArrayExtensions_1.getNumericComparatorForGridCell)(Enums_1.SortOrder.Asc)
                 : columnApi.hasDateDataType(ColumnId)
                     ? (0, ArrayExtensions_1.getDateComparatorForGridCell)(Enums_1.SortOrder.Asc)
                     : (0, ArrayExtensions_1.getGenericComparatorForGridCell)(Enums_1.SortOrder.Asc);
             return {
-                // but here we pass the actual direction of the column sort
                 dir: columnSort.SortOrder === 'Asc' ? 1 : -1,
                 fn: (rowNodeA, rowNodeB) => {
                     const gridCellA = rowNodesMapToCells.get(rowNodeA)?.[ColumnId];
@@ -150,7 +120,6 @@ class GridInternalApi extends ApiBase_1.ApiBase {
         return (0, infinite_react_1.multisort)(sortInfo, allRowNodes);
     }
     sortDistinctValues(returnValues, column) {
-        // this does NOT into account Custom Sort - far too hard for now...
         let sortOrder = undefined;
         let columnSort = this.getGridApi().getColumnSortForColumn(column.columnId);
         if (columnSort && columnSort.SortOrder) {
@@ -245,11 +214,6 @@ class GridInternalApi extends ApiBase_1.ApiBase {
     hasCellEditableAccordingToEditOptions() {
         return typeof this.getEditOptions()?.isCellEditable === 'function';
     }
-    /**
-     * Returns UNDEFINED if no EditOptions.isCellEditable is provided, otherwise returns the result of the function
-     *
-     * DO NOT USE THIS METHOD DIRECTLY - use `GridApi.isCellEditable` instead
-     */
     isCellEditableAccordingToEditOptions(gridCell, defaultColDefinitionEditableValue) {
         const cellEditable = this.getEditOptions()?.isCellEditable;
         if (cellEditable) {
@@ -263,7 +227,6 @@ class GridInternalApi extends ApiBase_1.ApiBase {
         return undefined;
     }
     isRowFilterable(rowNode) {
-        // first assess if the Row is filterable - if not, then return true so it appears in Grid
         const isRowFilterable = this.getOptionsApi().getFilterOptions().isRowFilterable;
         if (typeof isRowFilterable === 'function') {
             const rowFilterableContext = {