@adaptabletools/adaptable 13.0.0-canary.11 → 13.0.0-canary.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "13.0.0-canary.11",
+  "version": "13.0.0-canary.13",
   "description": "Powerful data-agnostic HTML5 datagrid add-on that sits on top of an underlying grid component and provides all the rich functionality that advanced users expect from their DataGrids and Data Tables",
   "keywords": [
     "web-components",

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1663671135839;
+declare const _default: 1663777360241;
 export default _default;

package/publishTimestamp.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = 1663671135839;
+exports.default = 1663777360241;

package/src/AdaptableInterfaces/IAdaptable.d.ts

@@ -28,6 +28,7 @@ import { IMetamodelService } from '../Utilities/Services/Interface/IMetamodelSer
 import { ColumnValuesComparer } from '../AdaptableOptions/GeneralOptions';
 import { IRowEditService } from '../Utilities/Services/Interface/IRowEditService';
 import { RenderReactRootFn } from '../renderReactRoot';
+export declare type AdaptableVariant = 'vanilla' | 'react' | 'angular';
 /**
  *  The only interface for Adaptable
  *
@@ -36,6 +37,7 @@ import { RenderReactRootFn } from '../renderReactRoot';
  * Should only be used internally as all external access is via the Api
  */
 export interface IAdaptable {
+    variant: AdaptableVariant;
     supressReact18RenderWarning: boolean;
     renderReactRoot: RenderReactRootFn;
     api: AdaptableApi;

package/src/AdaptableOptions/AdaptableQLOptions.d.ts

@@ -108,9 +108,8 @@ export interface ExpressionOptions {
      */
     moduleExpressionFunctions?: ModuleExpressionFunctionsMap | ((context: ModuleExpressionFunctionsContext) => ModuleExpressionFunctions | undefined);
     /**
-     * Deprecated use `isColumnQueryable` instead
+     * Specifies if a given column can be included in Queries
      */
-    queryableColumns?: string[] | (() => string[]);
     isColumnQueryable?: (queryableColumnContext: QueryableColumnContext) => boolean;
     /**
      * Validate Expressions before they can be run or saved
@@ -202,11 +201,29 @@ export interface GlobalExpressionFunctionsContext<T> extends BaseContext {
  * Context provided to ExpressionOptions.moduleExpressionFunctions property callback
  */
 export interface ModuleExpressionFunctionsContext extends BaseContext {
+    /**
+     * The Adaptable Module requesting the expression functions
+     */
     module: AdaptableModule;
+    /**
+     * The global boolean expression functions
+     */
     availableBooleanFunctionNames: BooleanFunctionName[];
+    /**
+     * The global scalar expression functions
+     */
     availableScalarFunctionNames: ScalarFunctionName[];
+    /**
+     * The global observable expression functions
+     */
     availableObservableFunctionNames: ObservableFunctionName[];
+    /**
+     * The global aggregated boolean expression functions
+     */
     availableAggregatedBooleanFunctionNames: AggregatedBooleanFunctionName[];
+    /**
+     * The global aggregated scalar expression functions
+     */
     availableAggregatedScalarFunctionNames: AggregatedScalarFunctionName[];
 }
 /**
@@ -240,7 +257,7 @@ export interface EvaluateExpressionExternallyContext extends BaseContext {
  */
 export interface QueryableColumnContext extends BaseContext {
     /**
-     * Column - just Id, DataType and FriendlyName
+     * Basic Column Info - just ColumnId, DataType and FriendlyName
      */
     adaptableColumn: AdaptableColumnBase;
 }

package/src/AdaptableOptions/LayoutOptions.d.ts

@@ -5,6 +5,7 @@ import { FlashingCellDefinition } from '../PredefinedConfig/FlashingCellState';
 import { FormatColumn } from '../PredefinedConfig/FormatColumnState';
 import { PlusMinusNudge } from '../PredefinedConfig/PlusMinusState';
 import { Shortcut } from '../PredefinedConfig/ShortcutState';
+import { StyledColumn } from '../PredefinedConfig/StyledColumnState';
 import { BaseSchedule } from '../PredefinedConfig/Common/Schedule';
 import { Layout } from '../PredefinedConfig/LayoutState';
 import { AdaptableModule } from '../PredefinedConfig/Common/Types';
@@ -116,7 +117,7 @@ export interface LayoutAvailableContext extends BaseContext {
 /**
  * Types of Adaptable Objects that can be associated with a Layout
  */
-export declare type LayoutAssociatedObject = AlertDefinition | ConditionalStyle | CustomSort | FlashingCellDefinition | FormatColumn | PlusMinusNudge | Shortcut | BaseSchedule;
+export declare type LayoutAssociatedObject = AlertDefinition | ConditionalStyle | CustomSort | FlashingCellDefinition | FormatColumn | PlusMinusNudge | StyledColumn | Shortcut | BaseSchedule;
 /**
  * Context for `LayoutOptions.autoGenerateTagsForLayouts` method
  */

package/src/Api/AdaptableApi.d.ts

@@ -38,6 +38,7 @@ import { FlashingCellApi } from './FlashingCellApi';
 import { ChartingApi } from './ChartingApi';
 import { SettingsPanelApi } from './SettingsPanelApi';
 import { StatusBarApi } from './StatusBarApi';
+import { StyledColumnApi } from './StyledColumnApi';
 /**
  *
  * The `AdaptableApi` provides developers with run-time access to AdapTable.
@@ -173,6 +174,7 @@ export interface AdaptableApi {
      * Provides access to the Smart Edit Module
      */
     smartEditApi: SmartEditApi;
+    styledColumnApi: StyledColumnApi;
     /**
      * Methods related to displaying System Status and application health messages
      */

package/src/Api/ColumnApi.d.ts

@@ -253,11 +253,17 @@ export interface ColumnApi {
      */
     getDistinctVisibleDisplayValuesForColumn(columnId: string): any[];
     /**
-     * Gets all distinct raw values in Column
+     * Gets all distinct raw values in Column. Values are sorted.
      * @param columnId Column to check
      * @param skipRowNode optional RowNode which should be skipped when collecting the distinct rawValues
      */
     getDistinctRawValuesForColumn(columnId: string, skipRowNode?: RowNode): any[];
+    /**
+     * Gets all distinct raw values in Column. Values are un-sorted.
+     * @param columnId Column to check
+     * @param skipRowNode optional RowNode which should be skipped when collecting the distinct rawValues
+     */
+    getUnsortedDistinctRawValuesForColumn(columnId: string, skipRowNode?: RowNode): any[];
     /**
      * Gets all distinct visible raw values in the Column
      * @param columnId Column to check

package/src/Api/FormatColumnApi.d.ts

@@ -1,4 +1,4 @@
-import { FormatColumnState, FormatColumn, ColumnStyle, ColumnComparison, CellColorRange } from '../PredefinedConfig/FormatColumnState';
+import { FormatColumnState, FormatColumn, ColumnComparison } from '../PredefinedConfig/FormatColumnState';
 import { AdaptableColumn, AdaptableFormat, AdaptablePredicateDef, AdaptableScope } from '../types';
 import { RowNode } from '@ag-grid-community/core';
 /**
@@ -135,15 +135,10 @@ export interface FormatColumnApi {
      */
     getFormatColumnWithStyleForColumn(column: AdaptableColumn): FormatColumn | undefined;
     /**
-     * Retrieves all format columns with style for a column
+     * Retrieves all format columns with style for a column. Includes text alignment.
      * @param column The Column for which to retrieve the Format Column
      */
     getColumnFormatColumnsWithStyle(column: AdaptableColumn): FormatColumn[];
-    /**
-     * Retrieves all Format Columns with style for the whole row
-     * @returns format columns
-     */
-    getRowFormatColumnsWithStyle(): FormatColumn[];
     /**
      * 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
@@ -160,22 +155,6 @@ export interface FormatColumnApi {
      * Returns true if Format State includes Format Columns with a Style property
      */
     hasStyleFormatColumns(): boolean;
-    /**
-     * Gets the Minimum Value to display for a Numeric Style
-     * @param numericStyle Numeric Style to check
-     * @param rowNode current Row Node
-     * @param cellValue current Cell Value
-     */
-    getNumericStyleMinValue(numericStyle: ColumnStyle, column: AdaptableColumn, rowNode: RowNode, cellValue: any): number;
-    /**
-     * Gets the Maximum Value to display for a Numeric Style
-     * @param numericStyle Numeric Style to check
-     * @param rowNode current Row Node
-     * @param cellValue current Cell Value
-     */
-    getNumericStyleMaxValue(numericStyle: ColumnStyle, column: AdaptableColumn, rowNode: RowNode, cellValue: any): number;
-    getCellColorRangeMinValue(range: CellColorRange, column: AdaptableColumn): number | undefined;
-    getCellColorRangeMaxValue(range: CellColorRange, column: AdaptableColumn): number | undefined;
     /**
      * Returns first Format Column that contains checkbox style
      * @param columnId column to check

package/src/Api/Implementation/AdaptableApiImpl.d.ts

@@ -39,6 +39,7 @@ import { FlashingCellApi } from '../FlashingCellApi';
 import { ChartingApi } from '../ChartingApi';
 import { StatusBarApi } from '../StatusBarApi';
 import { ActionApi } from '../../../types';
+import { StyledColumnApi } from '../StyledColumnApi';
 export declare class AdaptableApiImpl implements AdaptableApi {
     protected adaptable: IAdaptable;
     actionApi: ActionApi;
@@ -75,6 +76,7 @@ export declare class AdaptableApiImpl implements AdaptableApi {
     queryApi: QueryApi;
     queryLanguageApi: QueryLanguageApi;
     settingsPanelApi: SettingsPanelApi;
+    styledColumnApi: StyledColumnApi;
     toolPanelApi: ToolPanelApi;
     teamSharingApi: TeamSharingApi;
     scopeApi: ScopeApi;

package/src/Api/Implementation/AdaptableApiImpl.js

@@ -41,6 +41,7 @@ const FlashingCellApiImpl_1 = require("./FlashingCellApiImpl");
 const ChartingApiImpl_1 = require("./ChartingApiImpl");
 const SettingsPanelApiImpl_1 = require("./SettingsPanelApiImpl");
 const ActionApiImpl_1 = require("./ActionApiImpl");
+const StyledColumnApiImpl_1 = require("./StyledColumnApiImpl");
 class AdaptableApiImpl {
     constructor(adaptable) {
         this.adaptable = adaptable;
@@ -79,6 +80,7 @@ class AdaptableApiImpl {
         this.userInterfaceApi = new UserInterfaceApiImpl_1.UserInterfaceApiImpl(adaptable);
         this.queryApi = new QueryApiImpl_1.QueryApiImpl(adaptable);
         this.queryLanguageApi = new QueryLanguageApiImpl_1.QueryLanguageApiImpl(adaptable);
+        this.styledColumnApi = new StyledColumnApiImpl_1.StyledColumnApiImpl(adaptable);
         this.toolPanelApi = new ToolPanelApiImpl_1.ToolPanelApiImpl(adaptable);
         this.teamSharingApi = new TeamSharingApiImpl_1.TeamSharingApiImpl(adaptable);
         this.scopeApi = new ScopeApiImpl_1.ScopeApiImpl(adaptable);

package/src/Api/Implementation/ColumnApiImpl.d.ts

@@ -61,6 +61,7 @@ export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
     getDistinctBulkUpdateDisplayValuesForColumn(columnId: string, selectedGridCells: GridCell[]): Promise<any[]>;
     getDistinctVisibleDisplayValuesForColumn(columnId: string): any[];
     getDistinctRawValuesForColumn(columnId: string, skipRowNode?: RowNode): any[];
+    getUnsortedDistinctRawValuesForColumn(columnId: string, skipRowNode?: RowNode): any[];
     getDistinctVisibleRawValuesForColumn(columnId: string): any[];
     private sortDistinctValues;
     getPrimaryKeyColumn(): AdaptableColumn;

package/src/Api/Implementation/ColumnApiImpl.js

@@ -343,11 +343,17 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         if (abColumn == undefined) {
             return [];
         }
-        const returnValues = this.adaptable.getDistinctValuesForColumn(abColumn, false, skipRowNode);
-        return this.sortDistinctValues(returnValues, abColumn).map((cv) => {
+        return this.sortDistinctValues(this.getUnsortedDistinctRawValuesForColumn(columnId, skipRowNode), abColumn).map((cv) => {
             return cv.rawValue;
         });
     }
+    getUnsortedDistinctRawValuesForColumn(columnId, skipRowNode) {
+        const abColumn = this.getColumnFromId(columnId);
+        if (abColumn == undefined) {
+            return [];
+        }
+        return this.adaptable.getDistinctValuesForColumn(abColumn, false, skipRowNode);
+    }
     getDistinctVisibleRawValuesForColumn(columnId) {
         const abColumn = this.getColumnFromId(columnId);
         if (abColumn == undefined) {

package/src/Api/Implementation/FormatColumnApiImpl.d.ts

@@ -1,7 +1,7 @@
 import { AdaptableStyle } from '../../PredefinedConfig/Common/AdaptableStyle';
 import { ApiBase, LayoutAssociatedObjectLoadConfig } from './ApiBase';
 import { FormatColumnApi } from '../FormatColumnApi';
-import { FormatColumnState, FormatColumn, ColumnStyle, CellColorRange, ColumnComparison } from '../../PredefinedConfig/FormatColumnState';
+import { FormatColumnState, FormatColumn, ColumnComparison } from '../../PredefinedConfig/FormatColumnState';
 import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
 import { RowNode } from '@ag-grid-community/core';
 import { AdaptableFormat } from '../../types';
@@ -29,7 +29,6 @@ export declare class FormatColumnApiImpl extends ApiBase implements FormatColumn
     applyFormatColumnDisplayFormats(): void;
     getActiveFormatColumnForColumn(column: AdaptableColumn): FormatColumn | undefined;
     getColumnFormatColumnsWithStyle(column: AdaptableColumn): FormatColumn[];
-    getRowFormatColumnsWithStyle(): FormatColumn[];
     getFormatColumnForColumn(column: AdaptableColumn): FormatColumn | undefined;
     getFormatColumnForColumnId(columnId: string): FormatColumn | undefined;
     getFormatColumnWithStyleForColumn(column: AdaptableColumn): FormatColumn | undefined;
@@ -43,10 +42,6 @@ export declare class FormatColumnApiImpl extends ApiBase implements FormatColumn
     getFormatColumnsWithAllScope(formatColumns: FormatColumn[]): FormatColumn[] | undefined;
     getFormatColumnsWithDataTypeScope(formatColumns: FormatColumn[]): FormatColumn[] | undefined;
     getFormatColumnsWithColumnScope(formatColumns: FormatColumn[]): FormatColumn[] | undefined;
-    getNumericStyleMinValue(numericStyle: ColumnStyle, column: AdaptableColumn, rowNode: RowNode, cellValue: any): number;
-    getNumericStyleMaxValue(numericStyle: ColumnStyle, column: AdaptableColumn, rowNode: RowNode, cellValue: any): number | undefined;
-    getCellColorRangeMinValue(range: CellColorRange, column: AdaptableColumn): number | undefined;
-    getCellColorRangeMaxValue(range: CellColorRange, column: AdaptableColumn): number | undefined;
     getCheckBoxStyleFormatColumn(column: AdaptableColumn): FormatColumn | undefined;
     isCheckBoxStyleFormatColumn(column: AdaptableColumn): boolean;
     fireCheckboxColumnClickedEvent(columnId: string, rowData: any, primaryKeyValue: any, isChecked: boolean): void;

package/src/Api/Implementation/FormatColumnApiImpl.js

@@ -28,7 +28,7 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
         return this.getAllFormatColumn().filter((formatColumn) => formatColumn.IsSuspended);
     }
     getAllFormatColumnWithStyle() {
-        return this.getAllFormatColumn().filter((fc) => fc.Style != null);
+        return this.getAllFormatColumn().filter((fc) => fc.Style != null || fc.CellAlignment);
     }
     getColumnComparisonForFormatColumn(formatColumn) {
         var _a, _b;
@@ -113,13 +113,7 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
     getColumnFormatColumnsWithStyle(column) {
         const formatColumns = this.getAllFormatColumnWithStyle();
         return this.getFormatColumnInColumnScope(formatColumns, column).filter((scopedFormatColumn) => {
-            return (!this.adaptable.api.scopeApi.scopeIsAll(scopedFormatColumn.Scope) &&
-                this.adaptable.api.scopeApi.isColumnInScope(column, scopedFormatColumn.Scope));
-        });
-    }
-    getRowFormatColumnsWithStyle() {
-        return this.getAllFormatColumnWithStyle().filter((formatColumn) => {
-            return this.adaptable.api.scopeApi.scopeIsAll(formatColumn.Scope);
+            return this.adaptable.api.scopeApi.isColumnInScope(column, scopedFormatColumn.Scope);
         });
     }
     getFormatColumnForColumn(column) {
@@ -138,10 +132,10 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
         return this.getAppropriateFormatColumn(formatColumns, column);
     }
     getFormatColumnWithStyleClassNameForColumn(column) {
-        return this.getColumnFormatColumnsWithStyle(column).filter((fc) => StringExtensions_1.default.IsNotNullOrEmpty(fc.Style.ClassName));
+        return this.getColumnFormatColumnsWithStyle(column).filter((fc) => { var _a; return StringExtensions_1.default.IsNotNullOrEmpty((_a = fc === null || fc === void 0 ? void 0 : fc.Style) === null || _a === void 0 ? void 0 : _a.ClassName); });
     }
     getFormatColumnWithDisplayFormatForColumn(column) {
-        const formatColumns = this.getAllFormatColumnWithDisplayFormat().concat(this.getAllFormatColumnWithCellAlignment());
+        const formatColumns = this.getAllFormatColumnWithDisplayFormat();
         return this.getAppropriateFormatColumn(formatColumns, column);
     }
     getFormatColumnWithSingleColumnScope(columnId) {
@@ -162,13 +156,19 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
         return returnFormatColumn;
     }
     getFormatColumnInColumnScope(formatColumns, column) {
-        return this.getFormatColumnsWithColumnScope(formatColumns)
-            .concat(this.getFormatColumnsWithDataTypeScope(formatColumns))
-            .concat(this.getFormatColumnsWithAllScope(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.adaptable.api.scopeApi.scopeHasColumns(fc.Scope) ||
+                // this.getFormatColumnsWithDataTypeScope(formatColumns)
+                this.adaptable.api.scopeApi.scopeHasDataType(fc.Scope) ||
+                // this.getFormatColumnsWithAllScope(formatColumns)
+                this.adaptable.api.scopeApi.scopeIsAll(fc.Scope));
+        });
     }
     getAppropriateFormatColumn(formatColumns, column) {
-        return this.getFormatColumnInColumnScope(formatColumns, column).find((scopedFormatColumn) => !this.adaptable.api.scopeApi.scopeIsAll(scopedFormatColumn.Scope) &&
-            this.adaptable.api.scopeApi.isColumnInScope(column, scopedFormatColumn.Scope));
+        return this.getFormatColumnInColumnScope(formatColumns, column).find((scopedFormatColumn) => this.adaptable.api.scopeApi.isColumnInScope(column, scopedFormatColumn.Scope));
     }
     hasStyleFormatColumns() {
         return ArrayExtensions_1.default.IsNotNullOrEmpty(this.getAllFormatColumnWithStyle());
@@ -185,106 +185,6 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
     getFormatColumnsWithColumnScope(formatColumns) {
         return formatColumns.filter((fc) => this.adaptable.api.scopeApi.scopeHasColumns(fc.Scope));
     }
-    getNumericStyleMinValue(numericStyle, column, rowNode, cellValue) {
-        var _a, _b;
-        const columnComparison = numericStyle.GradientStyle
-            ? numericStyle.GradientStyle.ColumnComparison
-            : (_a = numericStyle.PercentBarStyle) === null || _a === void 0 ? void 0 : _a.ColumnComparison;
-        if (columnComparison) {
-            if (!isNaN(Number(columnComparison.MinValue))) {
-                return Number(columnComparison.MinValue);
-            }
-            else {
-                let columnId = columnComparison.MinValue;
-                if (!this.adaptable.api.columnApi.doesColumnExist(columnId)) {
-                    return 0;
-                }
-                else {
-                    return this.adaptable.api.gridApi.getRawValueFromRowNode(rowNode, columnId);
-                }
-            }
-        }
-        // for Gradient Column we want just the range that contains cell value
-        if (numericStyle.GradientStyle) {
-            let range;
-            numericStyle.GradientStyle.CellRanges.forEach((cellRange) => {
-                if (!range) {
-                    if ((cellRange.Min == 'Col-Min' || cellValue >= cellRange.Min) &&
-                        (cellRange.Max == 'Col-Max' || cellValue <= cellRange.Max)) {
-                        range = cellRange;
-                    }
-                }
-            });
-            return this.getCellColorRangeMinValue(range, column);
-        }
-        // for percentbar we want to get the whole Ranges
-        if (numericStyle.PercentBarStyle) {
-            const ranges = (_b = numericStyle.PercentBarStyle) === null || _b === void 0 ? void 0 : _b.CellRanges;
-            if (ranges) {
-                return this.getCellColorRangeMinValue(ranges[0], column);
-            }
-        }
-    }
-    getNumericStyleMaxValue(numericStyle, column, rowNode, cellValue) {
-        var _a, _b;
-        const columnComparison = numericStyle.GradientStyle
-            ? numericStyle.GradientStyle.ColumnComparison
-            : (_a = numericStyle.PercentBarStyle) === null || _a === void 0 ? void 0 : _a.ColumnComparison;
-        if (columnComparison) {
-            if (!isNaN(Number(columnComparison.MaxValue))) {
-                return Number(columnComparison.MaxValue);
-            }
-            else {
-                let columnId = columnComparison.MaxValue;
-                if (!this.adaptable.api.columnApi.doesColumnExist(columnId)) {
-                    return 0;
-                }
-                else {
-                    return this.adaptable.api.gridApi.getRawValueFromRowNode(rowNode, columnId);
-                }
-            }
-        }
-        if (numericStyle.GradientStyle) {
-            let range;
-            numericStyle.GradientStyle.CellRanges.forEach((cellRange) => {
-                if (!range) {
-                    if ((cellRange.Min == 'Col-Min' || cellValue >= cellRange.Min) &&
-                        (cellRange.Max == 'Col-Max' || cellValue <= cellRange.Max)) {
-                        range = cellRange;
-                    }
-                }
-            });
-            return this.getCellColorRangeMaxValue(range, column);
-        }
-        if (numericStyle.PercentBarStyle) {
-            const ranges = (_b = numericStyle.PercentBarStyle) === null || _b === void 0 ? void 0 : _b.CellRanges;
-            if (ranges) {
-                return this.getCellColorRangeMaxValue(ranges[ranges.length - 1], column);
-            }
-        }
-    }
-    getCellColorRangeMinValue(range, column) {
-        if (!range) {
-            return undefined;
-        }
-        if (range.Min == undefined) {
-            return undefined;
-        }
-        return range.Min == 'Col-Min'
-            ? this.getAdaptableApi().columnApi.getMinValueForNumericColumn(column)
-            : range.Min;
-    }
-    getCellColorRangeMaxValue(range, column) {
-        if (!range) {
-            return undefined;
-        }
-        if (range.Max == undefined) {
-            return undefined;
-        }
-        return range.Max == 'Col-Max'
-            ? this.getAdaptableApi().columnApi.getMaxValueForNumericColumn(column)
-            : range.Max;
-    }
     getCheckBoxStyleFormatColumn(column) {
         var _a;
         if (column.dataType != 'Boolean') {

package/src/Api/Implementation/StyledColumnApiImpl.d.ts

@@ -0,0 +1,19 @@
+import { ApiBase, LayoutAssociatedObjectLoadConfig } from './ApiBase';
+import { StyledColumnApi } from '../StyledColumnApi';
+import { StyledColumnState, StyledColumn } from '../../PredefinedConfig/StyledColumnState';
+import { AdaptableColumn, CellColorRange } from '../../types';
+import { RowNode } from '@ag-grid-community/core';
+export declare class StyledColumnApiImpl extends ApiBase implements StyledColumnApi {
+    getStyledColumnState(): StyledColumnState;
+    getAllStyledColumn(config?: LayoutAssociatedObjectLoadConfig): StyledColumn[];
+    getStyledColumnById(id: StyledColumn['Uuid']): StyledColumn;
+    getStyledColumnByColumnId(id: StyledColumn['Uuid']): StyledColumn;
+    getAllActiveStyledColumn(): StyledColumn[];
+    getAllSuspendedStyledColumn(): StyledColumn[];
+    deleteStyledColumn(styledColumn: StyledColumn): void;
+    addStyledColumn(styledColumn: StyledColumn): void;
+    getNumericStyleMinValue(numericStyle: any, column: AdaptableColumn, rowNode: RowNode, cellValue: any): number;
+    getNumericStyleMaxValue(numericStyle: any, column: AdaptableColumn, rowNode: RowNode, cellValue: any): number | undefined;
+    getCellColorRangeMinValue(range: CellColorRange, column: AdaptableColumn): number | undefined;
+    getCellColorRangeMaxValue(range: CellColorRange, column: AdaptableColumn): number | undefined;
+}

package/src/Api/Implementation/StyledColumnApiImpl.js

@@ -0,0 +1,134 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StyledColumnApiImpl = void 0;
+const tslib_1 = require("tslib");
+const ApiBase_1 = require("./ApiBase");
+const StyledColumnRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/StyledColumnRedux"));
+class StyledColumnApiImpl extends ApiBase_1.ApiBase {
+    getStyledColumnState() {
+        return this.getAdaptableState().StyledColumn;
+    }
+    getAllStyledColumn(config) {
+        var _a;
+        return ((_a = this.handleLayoutAssociatedObjects(this.getStyledColumnState().StyledColumns, 'StyledColumn', config)) !== null && _a !== void 0 ? _a : []);
+    }
+    getStyledColumnById(id) {
+        return this.getAllStyledColumn().find((styledcolumn) => styledcolumn.Uuid === id);
+    }
+    getStyledColumnByColumnId(id) {
+        return this.getAllStyledColumn().find((styledcolumn) => styledcolumn.ColumnId === id);
+    }
+    getAllActiveStyledColumn() {
+        return this.getAllStyledColumn().filter((styledcolumn) => !styledcolumn.IsSuspended);
+    }
+    getAllSuspendedStyledColumn() {
+        return this.getAllStyledColumn().filter((styledcolumn) => styledcolumn.IsSuspended);
+    }
+    deleteStyledColumn(styledColumn) {
+        this.dispatchAction(StyledColumnRedux.StyledColumnDelete(styledColumn));
+    }
+    addStyledColumn(styledColumn) {
+        this.dispatchAction(StyledColumnRedux.StyledColumnAdd(styledColumn));
+    }
+    getNumericStyleMinValue(numericStyle, column, rowNode, cellValue) {
+        var _a, _b;
+        const columnComparison = numericStyle.GradientStyle
+            ? numericStyle.GradientStyle.ColumnComparison
+            : (_a = numericStyle.PercentBarStyle) === null || _a === void 0 ? void 0 : _a.ColumnComparison;
+        if (columnComparison) {
+            if (!isNaN(Number(columnComparison.MinValue))) {
+                return Number(columnComparison.MinValue);
+            }
+            else {
+                let columnId = columnComparison.MinValue;
+                if (!this.adaptable.api.columnApi.doesColumnExist(columnId)) {
+                    return 0;
+                }
+                else {
+                    return this.adaptable.api.gridApi.getRawValueFromRowNode(rowNode, columnId);
+                }
+            }
+        }
+        // for Gradient Column we want just the range that contains cell value
+        if (numericStyle.GradientStyle) {
+            let range;
+            numericStyle.GradientStyle.CellRanges.forEach((cellRange) => {
+                if (!range) {
+                    if ((cellRange.Min == 'Col-Min' || cellValue >= cellRange.Min) &&
+                        (cellRange.Max == 'Col-Max' || cellValue <= cellRange.Max)) {
+                        range = cellRange;
+                    }
+                }
+            });
+            return this.getCellColorRangeMinValue(range, column);
+        }
+        // for percentbar we want to get the whole Ranges
+        if (numericStyle.PercentBarStyle) {
+            const ranges = (_b = numericStyle.PercentBarStyle) === null || _b === void 0 ? void 0 : _b.CellRanges;
+            if (ranges) {
+                return this.getCellColorRangeMinValue(ranges[0], column);
+            }
+        }
+    }
+    getNumericStyleMaxValue(numericStyle, column, rowNode, cellValue) {
+        var _a, _b;
+        const columnComparison = numericStyle.GradientStyle
+            ? numericStyle.GradientStyle.ColumnComparison
+            : (_a = numericStyle.PercentBarStyle) === null || _a === void 0 ? void 0 : _a.ColumnComparison;
+        if (columnComparison) {
+            if (!isNaN(Number(columnComparison.MaxValue))) {
+                return Number(columnComparison.MaxValue);
+            }
+            else {
+                let columnId = columnComparison.MaxValue;
+                if (!this.adaptable.api.columnApi.doesColumnExist(columnId)) {
+                    return 0;
+                }
+                else {
+                    return this.adaptable.api.gridApi.getRawValueFromRowNode(rowNode, columnId);
+                }
+            }
+        }
+        if (numericStyle.GradientStyle) {
+            let range;
+            numericStyle.GradientStyle.CellRanges.forEach((cellRange) => {
+                if (!range) {
+                    if ((cellRange.Min == 'Col-Min' || cellValue >= cellRange.Min) &&
+                        (cellRange.Max == 'Col-Max' || cellValue <= cellRange.Max)) {
+                        range = cellRange;
+                    }
+                }
+            });
+            return this.getCellColorRangeMaxValue(range, column);
+        }
+        if (numericStyle.PercentBarStyle) {
+            const ranges = (_b = numericStyle.PercentBarStyle) === null || _b === void 0 ? void 0 : _b.CellRanges;
+            if (ranges) {
+                return this.getCellColorRangeMaxValue(ranges[ranges.length - 1], column);
+            }
+        }
+    }
+    getCellColorRangeMinValue(range, column) {
+        if (!range) {
+            return undefined;
+        }
+        if (range.Min == undefined) {
+            return undefined;
+        }
+        return range.Min == 'Col-Min'
+            ? this.getAdaptableApi().columnApi.getMinValueForNumericColumn(column)
+            : range.Min;
+    }
+    getCellColorRangeMaxValue(range, column) {
+        if (!range) {
+            return undefined;
+        }
+        if (range.Max == undefined) {
+            return undefined;
+        }
+        return range.Max == 'Col-Max'
+            ? this.getAdaptableApi().columnApi.getMaxValueForNumericColumn(column)
+            : range.Max;
+    }
+}
+exports.StyledColumnApiImpl = StyledColumnApiImpl;