@adaptabletools/adaptable 13.0.0-canary.8 → 13.0.0

package/src/Api/Implementation/StyledColumnApiImpl.js

@@ -0,0 +1,193 @@
+"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"));
+const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
+const Helper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/Helper"));
+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(styledColumn, column, rowNode, cellValue) {
+        var _a, _b;
+        const columnComparison = styledColumn.GradientStyle
+            ? styledColumn.GradientStyle.ColumnComparison
+            : (_a = styledColumn.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 (styledColumn.GradientStyle) {
+            let range;
+            styledColumn.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 (styledColumn.PercentBarStyle) {
+            const ranges = (_b = styledColumn.PercentBarStyle) === null || _b === void 0 ? void 0 : _b.CellRanges;
+            if (ranges) {
+                return this.getCellColorRangeMinValue(ranges[0], column);
+            }
+        }
+    }
+    getNumericStyleMaxValue(styledColumn, column, rowNode, cellValue) {
+        var _a, _b;
+        const columnComparison = styledColumn.GradientStyle
+            ? styledColumn.GradientStyle.ColumnComparison
+            : (_a = styledColumn.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 (styledColumn.GradientStyle) {
+            let range;
+            styledColumn.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 (styledColumn.PercentBarStyle) {
+            const ranges = (_b = styledColumn.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;
+    }
+    getColumnComparisonForStyledColumn(styledColumn) {
+        var _a, _b;
+        if (styledColumn.GradientStyle) {
+            if ((_a = styledColumn.GradientStyle) === null || _a === void 0 ? void 0 : _a.ColumnComparison) {
+                return styledColumn.GradientStyle.ColumnComparison;
+            }
+        }
+        if (styledColumn.PercentBarStyle) {
+            if ((_b = styledColumn.PercentBarStyle) === null || _b === void 0 ? void 0 : _b.ColumnComparison) {
+                return styledColumn.PercentBarStyle.ColumnComparison;
+            }
+        }
+        return undefined;
+    }
+    getColumnIdsFromColumnComparison(columnComparison) {
+        let returnValues = [];
+        if (typeof columnComparison.MinValue === 'string') {
+            let minIds = this.adaptable.api.columnApi.getColumnIdsFromId(columnComparison.MinValue, false);
+            if (ArrayExtensions_1.default.IsNotNullOrEmpty(minIds)) {
+                returnValues.push(...minIds);
+            }
+        }
+        if (typeof columnComparison.MaxValue === 'string') {
+            let maxIds = this.adaptable.api.columnApi.getColumnIdsFromId(columnComparison.MaxValue, false);
+            if (ArrayExtensions_1.default.IsNotNullOrEmpty(maxIds)) {
+                returnValues.push(...maxIds);
+            }
+        }
+        return returnValues;
+    }
+    getCheckBoxStyleStyledColumn(column) {
+        var _a;
+        if (column.dataType != 'Boolean') {
+            return undefined;
+        }
+        const checkBoxFormatColumns = (_a = this.getStyledColumnState().StyledColumns) === null || _a === void 0 ? void 0 : _a.filter((sc) => sc === null || sc === void 0 ? void 0 : sc.CheckBoxStyle);
+        const styledColumn = checkBoxFormatColumns.find((sc) => sc.ColumnId == column.columnId);
+        return styledColumn;
+    }
+    isCheckBoxStyleStyledColumn(column) {
+        const styledColumn = this.getCheckBoxStyleStyledColumn(column);
+        return Helper_1.default.objectExists(styledColumn);
+    }
+    fireCheckboxColumnClickedEvent(columnId, rowData, primaryKeyValue, isChecked) {
+        let checkboxColumnClickedInfo = {
+            adaptableApi: this.adaptable.api,
+            column: this.adaptable.api.columnApi.getColumnFromId(columnId),
+            rowData: rowData,
+            primaryKeyValue: primaryKeyValue,
+            isChecked: isChecked,
+        };
+        this.adaptable.api.eventApi.emit('CheckboxColumnClicked', checkboxColumnClickedInfo);
+    }
+    getActiveStyledColumnForColumn(column) {
+        const styledColumns = this.getAllActiveStyledColumn();
+        return styledColumns.find((sc) => sc.ColumnId == column.columnId);
+    }
+}
+exports.StyledColumnApiImpl = StyledColumnApiImpl;

package/src/Api/InternalApi.d.ts

@@ -144,5 +144,5 @@ export interface InternalApi {
     getValueForTag(adaptableObjectTag: AdaptableObjectTag): string | number;
     getEditLookUpValuesForColumn(editLookUpItem: EditLookUpPermittedValues, column: AdaptableColumn, gridCell?: GridCell): any[] | undefined;
     getAdaptableQueryExpressionText(query: Partial<AdaptableQuery>): string;
-    shouldKeepDeprecatedConditionalStyles(): boolean;
+    deleteConditionalStyles(conditionalStyles: any[]): void;
 }

package/src/Api/PluginsApi.d.ts

@@ -3,6 +3,7 @@ import { IPushPullApi } from './IPushPullApi';
 import { Glue42Api } from './Glue42Api';
 import { OpenFinApi } from './OpenFinApi';
 import { FinanceApi } from './FinanceApi';
+import { FinsembleApi } from './FinsembleApi';
 /**
  * API methods dealing with AdapTable plugins
  */
@@ -44,4 +45,8 @@ export interface PluginsApi {
      * Returns Finance API class in Adaptable API
      */
     getFinancePluginApi(): FinanceApi;
+    /**
+     * Returns Finsemble API class in Adaptable API
+     */
+    getFinsemblePluginApi(): FinsembleApi;
 }

package/src/Api/QueryLanguageApi.d.ts

@@ -1,5 +1,6 @@
 import { AdaptableModule } from '../PredefinedConfig/Common/Types';
 import { AdaptableQuery } from '../PredefinedConfig/Common/AdaptableQuery';
+import { AdaptableColumnBase } from '../PredefinedConfig/Common/AdaptableColumn';
 /**
  * Functions related to AdapTableQL (the Adaptable Query Language)
  */
@@ -38,9 +39,9 @@ export interface QueryLanguageApi {
      */
     getColumnsFromExpression(expression: string): string[];
     /**
-     * Returns all columns that can be used in an Expression
+     * Returns whether a Column is Queryable
      */
-    getQueryableColumnIds(): string[];
+    isColumnQueryable(adaptableColumnBase: AdaptableColumnBase): boolean;
     /**
      * Runs the AST that AdapTableQL creates for an Expression - useful when evaluating remotely
      * @param expression expression to be run

package/src/Api/ScopeApi.d.ts

@@ -1,6 +1,6 @@
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { AdaptableScope, ScopeDataType } from '../PredefinedConfig/Common/AdaptableScope';
-import { CellColorRange } from '../PredefinedConfig/FormatColumnState';
+import { CellColorRange } from '../PredefinedConfig/StyledColumnState';
 /**
  * Provides access to a suite of functions related to the `Scope` object
  */

package/src/Api/StyledColumnApi.d.ts

@@ -0,0 +1,106 @@
+import { RowNode } from '@ag-grid-community/core/dist/cjs/es5/entities/rowNode';
+import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
+import { StyledColumnState, StyledColumn, CellColorRange, ColumnComparison } from '../PredefinedConfig/StyledColumnState';
+/**
+ * Provides run-time access to Styled Column Module and associated state
+ */
+export interface StyledColumnApi {
+    /**
+     * Retrieves Styled Column section from Adaptable State
+     */
+    getStyledColumnState(): StyledColumnState;
+    /**
+     * Retrieves all Styled Columns in Adaptable State
+     * @returns Styled Columns
+     */
+    getAllStyledColumn(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): StyledColumn[];
+    /**
+     * Retrieves Styled Column by Id
+     * @param id Styled Column id
+     * @returns Styled Column
+     */
+    getStyledColumnById(id: StyledColumn['Uuid']): StyledColumn;
+    /**
+     * Retrieves Styled Column by Column Id
+     * @param columnId Styled Column id
+     * @returns Styled Column
+     */
+    getStyledColumnByColumnId(columnId: StyledColumn['ColumnId']): StyledColumn;
+    /**
+     * Retrieves all active (not-suspended) Styled Columns in Adaptable State
+     * @returns Styled Columns
+     */
+    getAllActiveStyledColumn(): StyledColumn[];
+    /**
+     * Retrieves all suspended Styled Columns in Adaptable State
+     * @returns Styled Columns
+     */
+    getAllSuspendedStyledColumn(): StyledColumn[];
+    /**
+     * Delete a Styled column
+     * @param styledColumn
+     */
+    deleteStyledColumn(styledColumn: StyledColumn): void;
+    /**
+     * Create a Styled column
+     * @param styledColumn
+     */
+    addStyledColumn(styledColumn: StyledColumn): void;
+    /**
+     * Gets the Minimum Value to display for a Styled Column
+     * @param styledColumn Styled Column to check
+     * @param rowNode current Row Node
+     * @param cellValue current Cell Value
+     */
+    getNumericStyleMinValue(styledColumn: Omit<StyledColumn, 'ColumnId'>, column: AdaptableColumn, rowNode: RowNode, cellValue: any): number;
+    /**
+     * Gets the Maximum Value to display for a Styled Column
+     * @param styledColumn Styled Column to check
+     * @param rowNode current Row Node
+     * @param cellValue current Cell Value
+     */
+    getNumericStyleMaxValue(styledColumn: Omit<StyledColumn, 'ColumnId'>, column: AdaptableColumn, rowNode: RowNode, cellValue: any): number;
+    /**
+     * Returns the smallest number in a Range
+     * @param range Range to check
+     * @param column current Column
+     */
+    getCellColorRangeMinValue(range: CellColorRange, column: AdaptableColumn): number | undefined;
+    /**
+     * Returns the largest number in a Range
+     * @param range Range to check
+     * @param column current Column
+     */
+    getCellColorRangeMaxValue(range: CellColorRange, column: AdaptableColumn): number | undefined;
+    /**
+     * Retrieves the ColumnComparison property, if there, from a Styled Column
+     * @param styledColumn Styled Column to Add
+     */
+    getColumnComparisonForStyledColumn(styledColumn: StyledColumn): ColumnComparison | undefined;
+    /**
+     * Returns any ColumnIds referenced in a Column Comparison
+     * @param columnComparision Column Comparison to check
+     */
+    getColumnIdsFromColumnComparison(columnComparision: ColumnComparison): string[];
+    /**
+     * Returns first Styled Column that contains checkbox style
+     * @param columnId column to check
+     */
+    getCheckBoxStyleStyledColumn(column: AdaptableColumn): StyledColumn | undefined;
+    /**
+     * Whether given column is a (boolean) checkbox column
+     * @param columnId column to check
+     */
+    isCheckBoxStyleStyledColumn(column: AdaptableColumn): boolean;
+    /**
+     * Publishes the CheckboxColumnClickedEvent - when the checkbox in an Checkbox Column is clicked
+     */
+    fireCheckboxColumnClickedEvent(columnId: string, rowData: any, primaryKeyValue: any, isChecked: boolean): void;
+    /**
+     * Returns a Styled Column for a given column
+     * @param column Column to check
+     */
+    getActiveStyledColumnForColumn(column: AdaptableColumn): StyledColumn | undefined;
+}

package/src/Api/StyledColumnApi.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/PredefinedConfig/AdaptableState.d.ts

@@ -23,6 +23,7 @@ import { QueryState } from './QueryState';
 import { FlashingCellState } from './FlashingCellState';
 import { StatusBarState } from './StatusBarState';
 import { ChartingState } from './ChartingState';
+import { StyledColumnState } from './StyledColumnState';
 /**
  * The main state object of Adaptable
  */
@@ -48,6 +49,7 @@ export interface AdaptablePersistentState {
     Query: QueryState;
     QuickSearch: QuickSearchState;
     Schedule: ScheduleState;
+    StyledColumn: StyledColumnState;
     Shortcut: ShortcutState;
     StatusBar: StatusBarState;
     TeamSharing: TeamSharingState;

package/src/PredefinedConfig/Common/AdaptableIcon.d.ts

@@ -51,4 +51,4 @@ export interface AdaptableBaseIcon {
 /**
  * All AdapTable internal icon names
  */
-export declare type AdaptableInternalIconName = 'add' | 'add-row' | 'alert' | 'align-justify' | 'analysis' | 'application' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'arrow-up-long' | 'arrow-down-long' | 'arrowexpand' | 'attach-file' | 'blanks' | 'boolean-list' | 'broadcast' | 'build' | 'bulk-update' | 'calculated-column' | 'calendar' | 'call' | 'campaign' | 'cell-summary' | 'cell-validation' | 'chart' | 'chat' | 'check' | 'check-circle' | 'checked' | 'clear' | 'clone' | 'close' | 'cloud-upload' | 'collapse' | 'column-add' | 'column-chooser' | 'column-filter' | 'comment' | 'conditional-style' | 'contains' | 'custom-sort' | 'dashboard' | 'data-set' | 'date-range' | 'delete' | 'division' | 'dock' | 'drag' | 'edit' | 'ends-with' | 'equal' | 'equation' | 'error' | 'expand' | 'exponent' | 'export' | 'export-data' | 'fast-backward' | 'fast-forward' | 'filter' | 'flashing-cell' | 'folder' | 'folder-open' | 'folder-shared' | 'format-column' | 'freetext-column' | 'function' | 'gradient-column' | 'greater-than' | 'greater-than-or-equal' | 'hide-column' | 'history' | 'home' | 'import-export' | 'info' | 'instrument' | 'invalid' | 'ipushpull' | 'justify' | 'layout' | 'less-than' | 'less-than-or-equal' | 'list' | 'login' | 'logout' | 'menu' | 'minus' | 'multiplication' | 'newpage' | 'news' | 'non-blanks' | 'not-contains' | 'not-equal' | 'ok' | 'pause' | 'percent' | 'percent-bar' | 'person' | 'pie-chart' | 'play' | 'plus' | 'plus-minus' | 'query' | 'quick-search' | 'quote' | 'refresh' | 'regex' | 'reminder' | 'save' | 'schedule' | 'settings' | 'shortcut' | 'show-column' | 'smart-edit' | 'sort-asc' | 'sort-desc' | 'spark-line' | 'starts-with' | 'state-management' | 'statusbar' | 'stop' | 'system-status' | 'tab-unselected' | 'team-share' | 'theme' | 'tool-panel' | 'track-changes' | 'trash' | 'triangle-down' | 'triangle-up' | 'unchecked' | 'undo' | 'updated-row' | 'upload' | 'warning';
+export declare type AdaptableInternalIconName = 'add' | 'add-row' | 'alert' | 'align-justify' | 'analysis' | 'application' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'arrow-up-long' | 'arrow-down-long' | 'arrowexpand' | 'attach-file' | 'blanks' | 'boolean-list' | 'broadcast' | 'brush' | 'build' | 'bulk-update' | 'calculated-column' | 'calendar' | 'call' | 'campaign' | 'cell-summary' | 'cell-validation' | 'chart' | 'chat' | 'check' | 'check-circle' | 'checked' | 'clear' | 'clone' | 'close' | 'cloud-upload' | 'collapse' | 'column-add' | 'column-chooser' | 'column-filter' | 'comment' | 'conditional-style' | 'contains' | 'custom-sort' | 'dashboard' | 'data-set' | 'date-range' | 'delete' | 'division' | 'dock' | 'drag' | 'edit' | 'ends-with' | 'equal' | 'equation' | 'error' | 'expand' | 'exponent' | 'export' | 'export-data' | 'fast-backward' | 'fast-forward' | 'filter' | 'flashing-cell' | 'folder' | 'folder-open' | 'folder-shared' | 'format-column' | 'freetext-column' | 'function' | 'gradient-column' | 'greater-than' | 'greater-than-or-equal' | 'hide-column' | 'history' | 'home' | 'import-export' | 'info' | 'instrument' | 'invalid' | 'ipushpull' | 'justify' | 'layout' | 'less-than' | 'less-than-or-equal' | 'list' | 'login' | 'logout' | 'menu' | 'minus' | 'multiplication' | 'newpage' | 'news' | 'non-blanks' | 'not-contains' | 'not-equal' | 'ok' | 'pause' | 'percent' | 'percent-bar' | 'person' | 'pie-chart' | 'play' | 'plus' | 'plus-minus' | 'query' | 'quick-search' | 'quote' | 'refresh' | 'regex' | 'reminder' | 'save' | 'schedule' | 'settings' | 'shortcut' | 'show-column' | 'smart-edit' | 'sort-asc' | 'sort-desc' | 'spark-line' | 'starts-with' | 'state-management' | 'statusbar' | 'stop' | 'system-status' | 'tab-unselected' | 'team-share' | 'theme' | 'tool-panel' | 'track-changes' | 'trash' | 'triangle-down' | 'triangle-up' | 'unchecked' | 'undo' | 'updated-row' | 'upload' | 'warning';

package/src/PredefinedConfig/Common/Types.d.ts

@@ -22,15 +22,15 @@ export declare type AdaptableModuleButtons = AdaptableModuleButton[];
 /**
  * List of all the Module buttons Adaptable provides - each Module has a popup for which this is a shortcut button
  */
-export declare type AdaptableModuleButton = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'Filter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'GridInfo' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'Shortcut' | 'SmartEdit' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme';
+export declare type AdaptableModuleButton = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'Filter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'GridInfo' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'Shortcut' | 'SmartEdit' | 'StyledColumn' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme';
 export declare type AdaptableStateKeys = AdaptableStateKey[];
 export declare type AdaptableStateKey = keyof AdaptablePersistentState | 'OpenFin' | 'Glue42' | 'IPushPull';
 /**
  * Modules provided by AdapTable, subject to Entitlements and usually have Predefined Config
  */
-export declare type AdaptableModule = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Charting' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'Filter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'GridInfo' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'Shortcut' | 'SmartEdit' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel';
+export declare type AdaptableModule = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Charting' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'Filter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'GridInfo' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'Shortcut' | 'SmartEdit' | 'StyledColumn' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel';
 export declare const ALL_MODULES: AdaptableModule[];
-export declare type AdaptableSettingsPanel = 'Alert' | 'CalculatedColumn' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'Filter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'Layout' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel';
+export declare type AdaptableSettingsPanel = 'Alert' | 'CalculatedColumn' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'Filter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'Layout' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'StyledColumn' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel';
 export declare type TypeHint<Base, Literals> = (Base & {
     __subType?: true;
 }) | Literals;

package/src/PredefinedConfig/Common/Types.js

@@ -102,6 +102,7 @@ exports.ALL_MODULES = [
     ModuleConstants.SettingsPanelModuleId,
     ModuleConstants.ShortcutModuleId,
     ModuleConstants.SmartEditModuleId,
+    ModuleConstants.StyledColumnModuleId,
     ModuleConstants.StateManagementModuleId,
     ModuleConstants.StatusBarModuleId,
     ModuleConstants.SystemStatusModuleId,

package/src/PredefinedConfig/ConditionalStyleState.d.ts

@@ -7,41 +7,32 @@ import { XOR } from '../Utilities/Extensions/TypeExtensions';
 import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
 import { SuspendableObject } from './Common/SuspendableObject';
 /**
- * Predefined Configuration for the Conditional Style Module
+ * Deprecated section of Adaptable State - use `FormatColumnState` instead
+ * @deprecated use `FormatColumnState` instead
  **/
 export interface ConditionalStyleState extends ConfigState {
-    /**
-     * Array of Conditional Styles to ship with AdapTable
-     */
     ConditionalStyles?: ConditionalStyle[];
 }
 /**
- * Object used in Conditional Style function - contains Scope, a Rule and a Style
+ * Deprecated Adaptable Object - use `FormatColumn` instead
+ * @deprecated use `FormatColumn` instead
  */
 export interface ConditionalStyle extends SuspendableObject {
-    /**
-     * Where Style is applied - can be whole Row, some Columns or all Columns of given DataType
-     */
     Scope: AdaptableScope;
-    /**
-     * Predicate-based Rule to use for deciding if a style needs to be applied.
-     */
     Rule: ConditionalStyleRule;
-    /**
-     * Adaptable Style (e.g. font properties and colurs) to apply.
-     */
     Style: AdaptableStyle;
-    /**
-     * Whether to apply Style in Grouped Rows and when Pivoting
-     * @defaultValue false
-     */
     IncludeGroupedRows?: boolean;
 }
+/**
+ * Deprecated - use `FormatColumnPredicate` instead
+ * @deprecated use `FormatColumnPredicate` instead
+ */
 export interface ConditionalStylePredicate extends AdaptablePredicate {
     PredicateId: TypeHint<string, SystemConditionalStylePredicateId>;
 }
 /**
- * The Conditional Style Rule - can be either a Predicate or an Expression
+ * Deprecated - use `FormatColumnRule` instead
+ * @deprecated use `FormatColumnRule` instead
  */
 export declare type ConditionalStyleRule = XOR<{
     Predicate: ConditionalStylePredicate;

package/src/PredefinedConfig/FormatColumnState.d.ts

@@ -5,7 +5,7 @@ import { AdaptableScope } from './Common/AdaptableScope';
 import { SuspendableObject } from './Common/SuspendableObject';
 import { XOR } from '../Utilities/Extensions/TypeExtensions';
 import { TypeHint } from './Common/Types';
-import { AdaptableBooleanQuery, AdaptablePredicate } from '../types';
+import { AdaptableBooleanQuery, AdaptablePredicate, GradientStyle, PercentBarStyle } from '../types';
 /**
  * Predefined Configuration for Format Column Module
  */
@@ -33,7 +33,7 @@ export interface FormatColumn extends SuspendableObject {
      */
     Style?: AdaptableStyle;
     /**
-     * Applies Gradient, Percent Bar or CheckBox style to a Column
+     * @deprecated now in StyledColumn Module
      */
     ColumnStyle?: ColumnStyle;
     /**
@@ -44,12 +44,6 @@ export interface FormatColumn extends SuspendableObject {
      * Aligns cells 'Left' or 'Right' or 'Center'
      */
     CellAlignment?: 'Left' | 'Right' | 'Center';
-    /**
-     * Text to display in Column Header (doesn't change ColumnId)
-     *
-     * @deprecated use `Layout.ColumnHeadersMap` instead
-     */
-    HeaderName?: string;
     /**
      * Whether to Format the Column in Grouped Rows
      * @defaultValue false
@@ -57,7 +51,7 @@ export interface FormatColumn extends SuspendableObject {
     IncludeGroupedRows?: boolean;
 }
 /**
- * The Format Column Rule - can be either a Predicate or an Expression
+ * The Format Column Rule - can be either a Predicate or a BooleanExpression
  */
 export declare type FormatColumnRule = XOR<{
     Predicate: FormatColumnPredicate;
@@ -65,9 +59,11 @@ export declare type FormatColumnRule = XOR<{
 export interface FormatColumnPredicate extends AdaptablePredicate {
     PredicateId: TypeHint<string, SystemFormatColumnPredicateId>;
 }
-declare type SystemFormatColumnPredicateId = 'Blanks' | 'NonBlanks' | 'Equals' | 'NotEquals' | 'GreaterThan' | 'LessThan' | 'Positive' | 'Negative' | 'Zero' | 'Between' | 'NotBetween' | 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Today' | 'Yesterday' | 'Tomorrow' | 'ThisWeek' | 'ThisMonth' | 'ThisQuarter' | 'ThisYear' | 'InPast' | 'InFuture' | 'Before' | 'After' | 'On' | 'NotOn' | 'NextWorkDay' | 'LastWorkDay' | 'True' | 'False';
+export declare type SystemFormatColumnPredicateId = 'Blanks' | 'NonBlanks' | 'Equals' | 'NotEquals' | 'GreaterThan' | 'LessThan' | 'Positive' | 'Negative' | 'Zero' | 'Between' | 'NotBetween' | 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Today' | 'Yesterday' | 'Tomorrow' | 'ThisWeek' | 'ThisMonth' | 'ThisQuarter' | 'ThisYear' | 'InPast' | 'InFuture' | 'Before' | 'After' | 'On' | 'NotOn' | 'NextWorkDay' | 'LastWorkDay' | 'True' | 'False';
 /**
  * Special Style used when Formatting Columns: Gradient, PercentBar or CheckBox
+ *
+ * @deprecated use StyledColumn instead
  */
 export interface ColumnStyle {
     /**
@@ -83,89 +79,3 @@ export interface ColumnStyle {
      */
     CheckBoxStyle?: boolean;
 }
-/**
- * Style used to display Percent Bars in Format Column
- */
-export interface PercentBarStyle {
-    /**
-     * Ranges (e.g. to allow a traffic light effect)
-     */
-    CellRanges?: CellColorRange[];
-    /**
-     * Compares cell values to another Column
-     */
-    ColumnComparison?: ColumnComparison;
-    /**
-     * Whether Cell shows Cell Value, Percent Value, both or none
-     */
-    CellText?: CellTextOptions;
-    /**
-     * Whether Tooltip shows Cell Value, Percent Value, both or none
-     */
-    ToolTipText?: CellTextOptions;
-    /**
-     * Back colour - only used for 'Percent Bar' Numeric style; leave unset if none required
-     * @defaultValue Gray
-     */
-    BackColor?: string;
-}
-/**
- * Used to display Gradient Styles in Format Column
- */
-export interface GradientStyle {
-    /**
-     * Ranges (e.g. to allow a traffic light effect)
-     */
-    CellRanges?: CellColorRange[];
-    /**
-     * Compares cell values to another Column
-     */
-    ColumnComparison?: ColumnComparison;
-}
-/**
- * Defines which Colours to show in Gradient and Percent Bar Styles
- */
-export interface CellColorRange {
-    /**
-     * Start number of Range
-     */
-    Min: number | 'Col-Min';
-    /**
-     * End number of Range
-     */
-    Max: number | 'Col-Max';
-    /**
-     * Cell colour to use for values that fall inside Range
-     */
-    Color: string;
-    /**
-     * Reverses the Gradient so the lower the cell value the darker the colour
-     */
-    ReverseGradient?: boolean;
-}
-/**
- * Enables a Percent Bar or Gradient Style to use another column in its calculations
- */
-export interface ColumnComparison {
-    /**
-     * Start value - either numeric or Column name
-     */
-    MinValue: number | string;
-    /**
-     * End value - either numeric or Column name
-     */
-    MaxValue: number | string;
-    /**
-     * Colour to use for the Comparison
-     */
-    Color: string;
-}
-/**
- * Array of CellTextOption available in Format Columns
- */
-export declare type CellTextOptions = CellTextOption[];
-/**
- * Text optionally to show in a Format Column special style: 'CellValue' or 'PercentageValue'
- */
-export declare type CellTextOption = 'CellValue' | 'PercentageValue';
-export {};

package/src/PredefinedConfig/PredefinedConfig.d.ts

@@ -18,6 +18,7 @@ import { ToolPanelState } from './ToolPanelState';
 import { QueryState } from './QueryState';
 import { StatusBarState } from './StatusBarState';
 import { ChartingState } from './ChartingState';
+import { StyledColumnState } from './StyledColumnState';
 /**
  * This is the main Predefined Config interface which developers will populate at design-time
  */
@@ -87,6 +88,10 @@ export interface PredefinedConfig {
      * Supplies a collection of *Shortcut* objects to aid data entry and prevent 'fat finger' issues
      */
     Shortcut?: ShortcutState;
+    /**
+     * Supplies a collection of Special Column Styles
+     */
+    StyledColumn?: StyledColumnState;
     /**
      * Configures the Adaptable Status Bar
      */