@adaptabletools/adaptable 13.0.0-canary.2 → 13.0.0-canary.21

package/src/PredefinedConfig/Common/AdaptablePredicate.js

@@ -27,7 +27,7 @@ exports.SystemPredicateDefs = [
         label: 'Values',
         icon: { text: 'IN' },
         columnScope: { DataTypes: ['String', 'Number', 'Date'] },
-        moduleScope: ['filter', 'conditionalstyle', 'alert'],
+        moduleScope: ['filter', 'conditionalstyle', 'formatColumn', 'alert'],
         handler: ({ inputs, column, value }) => {
             if (inputs.length === 0) {
                 return true;
@@ -53,7 +53,7 @@ exports.SystemPredicateDefs = [
         label: 'Exclude Values',
         icon: { text: '!IN' },
         columnScope: { DataTypes: ['String', 'Number', 'Date'] },
-        moduleScope: ['filter', 'conditionalstyle', 'alert'],
+        moduleScope: ['filter', 'conditionalstyle', 'formatColumn', 'alert'],
         handler: ({ inputs, column, value }) => {
             // basically negation of IN
             if (inputs.length === 0) {
@@ -79,7 +79,7 @@ exports.SystemPredicateDefs = [
         label: 'Blanks',
         icon: { name: 'blanks' },
         columnScope: { All: true },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         handler: ({ value }) => Helper_1.default.IsInputNullOrEmpty(value),
     },
     {
@@ -87,7 +87,7 @@ exports.SystemPredicateDefs = [
         label: 'Non Blanks',
         icon: { name: 'non-blanks' },
         columnScope: { All: true },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         handler: ({ value }) => Helper_1.default.IsInputNotNullOrEmpty(value),
     },
     // Numeric System Filters
@@ -96,7 +96,7 @@ exports.SystemPredicateDefs = [
         label: 'Greater Than',
         icon: { name: 'greater-than' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         inputs: [{ type: 'number' }],
         handler: ({ value, inputs }) => Number(value) > Number(inputs[0]),
         toString: ({ inputs }) => `> ${inputs[0]}`,
@@ -107,7 +107,7 @@ exports.SystemPredicateDefs = [
         label: 'Less Than',
         icon: { name: 'less-than' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         inputs: [{ type: 'number' }],
         handler: ({ value, inputs }) => Number(value) < Number(inputs[0]),
         toString: ({ inputs }) => `< ${inputs[0]}`,
@@ -118,7 +118,7 @@ exports.SystemPredicateDefs = [
         label: 'Positive',
         icon: { text: '>0' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         handler: ({ value }) => Number(value) > 0,
     },
     {
@@ -126,7 +126,7 @@ exports.SystemPredicateDefs = [
         label: 'Negative',
         icon: { text: '<0' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         handler: ({ value }) => Number(value) < 0,
     },
     {
@@ -134,7 +134,7 @@ exports.SystemPredicateDefs = [
         label: 'Zero',
         icon: { text: '=0' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         handler: ({ value }) => {
             if (typeof value === 'string' && !StringExtensions_1.default.IsNumeric(value)) {
                 return false;
@@ -147,7 +147,7 @@ exports.SystemPredicateDefs = [
         label: 'Equals',
         icon: { name: 'equal' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         inputs: [{ type: 'number' }],
         handler: ({ value, inputs }) => {
             const input = inputs[0];
@@ -165,7 +165,7 @@ exports.SystemPredicateDefs = [
         label: 'Not Equals',
         icon: { name: 'not-equal' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         inputs: [{ type: 'number' }],
         handler: ({ value, inputs }) => {
             const input = inputs[0];
@@ -183,7 +183,7 @@ exports.SystemPredicateDefs = [
         label: 'Between',
         icon: { text: 'BE' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         inputs: [{ type: 'number' }, { type: 'number' }],
         handler: ({ value, inputs }) => Number(value) >= Number(inputs[0]) && Number(value) <= Number(inputs[1]),
         toString: ({ inputs }) => `Between ${inputs[0]}:${inputs[1]}`,
@@ -194,7 +194,7 @@ exports.SystemPredicateDefs = [
         label: 'Not Between',
         icon: { text: '!BE' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         inputs: [{ type: 'number' }, { type: 'number' }],
         handler: ({ value, inputs }) => Number(value) < Number(inputs[0]) || Number(value) > Number(inputs[1]),
         toString: ({ inputs }) => `Not Between ${inputs[0]}:${inputs[1]}`,
@@ -222,7 +222,7 @@ exports.SystemPredicateDefs = [
         label: 'Equals',
         icon: { name: 'equal' },
         columnScope: { DataTypes: ['String'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         inputs: [{ type: 'text' }],
         handler: ({ value, inputs, api }) => {
             if (!value) {
@@ -241,7 +241,7 @@ exports.SystemPredicateDefs = [
         label: 'Not Equals',
         icon: { name: 'not-equal' },
         columnScope: { DataTypes: ['String'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         inputs: [{ type: 'text' }],
         handler: ({ value, inputs, api }) => {
             if (!value) {
@@ -260,7 +260,7 @@ exports.SystemPredicateDefs = [
         label: 'Contains',
         icon: { name: 'contains' },
         columnScope: { DataTypes: ['String'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         inputs: [{ type: 'text' }],
         handler: ({ value, inputs, api }) => {
             if (!value) {
@@ -278,7 +278,7 @@ exports.SystemPredicateDefs = [
         label: 'Not Contains',
         icon: { name: 'not-contains' },
         columnScope: { DataTypes: ['String'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         inputs: [{ type: 'text' }],
         handler: ({ value, inputs, api }) => {
             if (!value) {
@@ -296,7 +296,7 @@ exports.SystemPredicateDefs = [
         label: 'Starts With',
         icon: { name: 'starts-with' },
         columnScope: { DataTypes: ['String'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         inputs: [{ type: 'text' }],
         handler: ({ value, inputs, api }) => {
             if (!value) {
@@ -314,7 +314,7 @@ exports.SystemPredicateDefs = [
         label: 'Ends With',
         icon: { name: 'ends-with' },
         columnScope: { DataTypes: ['String'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         inputs: [{ type: 'text' }],
         handler: ({ value, inputs, api }) => {
             if (!value) {
@@ -332,7 +332,7 @@ exports.SystemPredicateDefs = [
         label: 'Regex',
         icon: { name: 'regex' },
         columnScope: { DataTypes: ['String'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         inputs: [{ type: 'text' }],
         handler: ({ value, inputs }) => new RegExp(inputs[0]).test(value),
         toString: ({ inputs }) => `Regex ${inputs[0]}`,
@@ -343,7 +343,7 @@ exports.SystemPredicateDefs = [
         label: 'Today',
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         handler: ({ value }) => (0, isToday_1.default)((0, DateHelper_1.parseDateValue)(value)),
     },
     {
@@ -351,7 +351,7 @@ exports.SystemPredicateDefs = [
         label: 'Yesterday',
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         handler: ({ value }) => (0, isYesterday_1.default)((0, DateHelper_1.parseDateValue)(value)),
     },
     {
@@ -359,7 +359,7 @@ exports.SystemPredicateDefs = [
         label: 'Tomorrow',
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         handler: ({ value }) => (0, isTomorrow_1.default)((0, DateHelper_1.parseDateValue)(value)),
     },
     {
@@ -367,7 +367,7 @@ exports.SystemPredicateDefs = [
         label: 'This Week',
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         handler: ({ value }) => (0, isThisWeek_1.default)((0, DateHelper_1.parseDateValue)(value)),
     },
     {
@@ -375,7 +375,7 @@ exports.SystemPredicateDefs = [
         label: 'This Month',
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         handler: ({ value }) => (0, isThisMonth_1.default)((0, DateHelper_1.parseDateValue)(value)),
     },
     {
@@ -383,7 +383,7 @@ exports.SystemPredicateDefs = [
         label: 'This Quarter',
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         handler: ({ value }) => (0, isThisQuarter_1.default)((0, DateHelper_1.parseDateValue)(value)),
     },
     {
@@ -391,7 +391,7 @@ exports.SystemPredicateDefs = [
         label: 'This Year',
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         handler: ({ value }) => (0, isThisYear_1.default)((0, DateHelper_1.parseDateValue)(value)),
     },
     {
@@ -399,7 +399,7 @@ exports.SystemPredicateDefs = [
         label: 'In Past',
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         handler: ({ value }) => (0, isPast_1.default)((0, DateHelper_1.parseDateValue)(value)),
     },
     {
@@ -407,7 +407,7 @@ exports.SystemPredicateDefs = [
         label: 'In Future',
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         handler: ({ value }) => (0, isFuture_1.default)((0, DateHelper_1.parseDateValue)(value)),
     },
     {
@@ -415,7 +415,7 @@ exports.SystemPredicateDefs = [
         label: 'After',
         icon: { name: 'greater-than' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         inputs: [{ type: 'date' }],
         handler: ({ value, inputs }) => (0, isAfter_1.default)((0, DateHelper_1.parseDateValue)(value), (0, DateHelper_1.parseDateValue)(inputs[0])),
         toString: ({ inputs }) => `> ${inputs[0]}`,
@@ -425,7 +425,7 @@ exports.SystemPredicateDefs = [
         label: 'Before',
         icon: { name: 'less-than' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         inputs: [{ type: 'date' }],
         handler: ({ value, inputs }) => (0, isBefore_1.default)((0, DateHelper_1.parseDateValue)(value), (0, DateHelper_1.parseDateValue)(inputs[0])),
         toString: ({ inputs }) => `< ${inputs[0]}`,
@@ -435,7 +435,7 @@ exports.SystemPredicateDefs = [
         label: 'Equals',
         icon: { name: 'equal' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         inputs: [{ type: 'date' }],
         handler: ({ value, inputs }) => (0, isSameDay_1.default)((0, DateHelper_1.parseDateValue)(value), (0, DateHelper_1.parseDateValue)(inputs[0])),
         toString: ({ inputs }) => `= ${inputs[0]}`,
@@ -445,7 +445,7 @@ exports.SystemPredicateDefs = [
         label: 'NotEquals',
         icon: { name: 'not-equal' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         inputs: [{ type: 'date' }],
         handler: ({ value, inputs }) => !(0, isSameDay_1.default)((0, DateHelper_1.parseDateValue)(value), (0, DateHelper_1.parseDateValue)(inputs[0])),
         toString: ({ inputs }) => `!= ${inputs[0]}`,
@@ -455,7 +455,7 @@ exports.SystemPredicateDefs = [
         label: 'Next Work Day',
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         handler: ({ value, api }) => (0, isSameDay_1.default)((0, DateHelper_1.parseDateValue)(value), CalendarHelper_1.default.getNextWorkingDay()),
     },
     {
@@ -463,7 +463,7 @@ exports.SystemPredicateDefs = [
         label: 'Last Work Day',
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         handler: ({ value, api }) => (0, isSameDay_1.default)((0, DateHelper_1.parseDateValue)(value), CalendarHelper_1.default.getPreviousWorkingDay()),
     },
     {
@@ -482,7 +482,7 @@ exports.SystemPredicateDefs = [
         label: 'True',
         icon: { text: 'T' },
         columnScope: { DataTypes: ['Boolean'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         handler: ({ value }) => Boolean(value) === true,
     },
     {
@@ -490,7 +490,7 @@ exports.SystemPredicateDefs = [
         label: 'False',
         icon: { text: 'F' },
         columnScope: { DataTypes: ['Boolean'] },
-        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle', 'formatColumn'],
         handler: ({ value }) => Boolean(value) === false,
     },
     {

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

@@ -3,6 +3,9 @@ import { AdaptableStyle } from './Common/AdaptableStyle';
 import { AdaptableFormat } from './Common/AdaptableFormat';
 import { AdaptableScope } from './Common/AdaptableScope';
 import { SuspendableObject } from './Common/SuspendableObject';
+import { XOR } from '../Utilities/Extensions/TypeExtensions';
+import { TypeHint } from './Common/Types';
+import { AdaptableBooleanQuery, AdaptablePredicate, GradientStyle, PercentBarStyle } from '../types';
 /**
  * Predefined Configuration for Format Column Module
  */
@@ -20,12 +23,17 @@ export interface FormatColumn extends SuspendableObject {
      * Where Format will be applied - whole Row, some Columns or all Columns of given DataType
      */
     Scope: AdaptableScope;
+    /**
+     * Predicate-based Rule to use for deciding if a format column needs to be applied.
+     * When not defined the format column is always applied.
+     */
+    Rule?: FormatColumnRule;
     /**
      * Style to apply
      */
     Style?: AdaptableStyle;
     /**
-     * Applies Gradient, Percent Bar or CheckBox style to a Column
+     * @deprecated now in StyledColumn Module
      */
     ColumnStyle?: ColumnStyle;
     /**
@@ -36,20 +44,26 @@ 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
      */
     IncludeGroupedRows?: boolean;
 }
+/**
+ * The Format Column Rule - can be either a Predicate or a BooleanExpression
+ */
+export declare type FormatColumnRule = XOR<{
+    Predicate: FormatColumnPredicate;
+}, AdaptableBooleanQuery>;
+export interface FormatColumnPredicate extends AdaptablePredicate {
+    PredicateId: TypeHint<string, SystemFormatColumnPredicateId>;
+}
+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 {
     /**
@@ -65,88 +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';

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
  */
@@ -36,6 +37,7 @@ export interface PredefinedConfig {
     CalculatedColumn?: CalculatedColumnState;
     /**
      * Supplies a collection of *ConditionalStyle* objects to provides columns and rows with a particular style when the data matches a given rule
+     * @deprecated use `FormatColumn` instead
      */
     ConditionalStyle?: ConditionalStyleState;
     /**
@@ -86,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
      */