@adaptabletools/adaptable 20.0.0-canary.8 → 20.0.0

package/src/{PredefinedConfig → AdaptableState}/FlashingCellState.d.ts

@@ -1,10 +1,19 @@
-import { ConfigState } from './ConfigState';
+import { BaseState } from './BaseState';
 import { AdaptableStyle } from './Common/AdaptableStyle';
 import { AdaptableColumnPredicate, ColumnScope } from '../types';
 import { XOR } from '../Utilities/Extensions/TypeExtensions';
 import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
 import { TypeHint } from './Common/Types';
 import { SuspendableObject } from '../../types';
+/**
+ * Adaptable State Section for Flashing Cell module
+ */
+export interface FlashingCellState extends BaseState {
+    /**
+     * Flashing Cell Definitions - will colour cells/rows when rule is met
+     */
+    FlashingCellDefinitions?: FlashingCellDefinition[];
+}
 export interface FlashingCellDefinitionPredicate extends AdaptableColumnPredicate {
     PredicateId: TypeHint<string, SystemFlashingCellPredicateId>;
 }
@@ -14,15 +23,6 @@ export interface FlashingCellDefinitionPredicate extends AdaptableColumnPredicat
 export type FlashingCellRule = XOR<{
     Predicates: FlashingCellDefinitionPredicate[];
 }, AdaptableBooleanQuery>;
-/**
- * Predefined Configuration for Flashing Cell module
- */
-export interface FlashingCellState extends ConfigState {
-    /**
-     * Flashing Cell Definitions - will colour cells/rows when rule is met
-     */
-    FlashingCellDefinitions?: FlashingCellDefinition[];
-}
 /**
  * What should flash? row, cell or aggregated cell
  */

package/src/{PredefinedConfig → AdaptableState}/FormatColumnState.d.ts

@@ -1,4 +1,4 @@
-import { ConfigState } from './ConfigState';
+import { BaseState } from './BaseState';
 import { AdaptableStyle } from './Common/AdaptableStyle';
 import { AdaptableFormat } from './Common/AdaptableFormat';
 import { ColumnScope } from './Common/ColumnScope';
@@ -9,9 +9,9 @@ import { TypeHint } from './Common/Types';
 import { AdaptableBooleanQuery } from '../types';
 import { AdaptableColumnPredicate } from './Common/AdaptablePredicate';
 /**
- * Predefined Configuration for Format Column Module
+ * Adaptable State Section for Format Column Module
  */
-export interface FormatColumnState extends ConfigState {
+export interface FormatColumnState extends BaseState {
     /**
      * Collection of Format Columns
      */

package/src/{PredefinedConfig → AdaptableState}/FreeTextColumnState.d.ts

@@ -1,10 +1,10 @@
-import { ConfigState } from './ConfigState';
+import { BaseState } from './BaseState';
 import { AdaptableObject } from './Common/AdaptableObject';
 import { SpecialColumnSettings } from './Common/SpecialColumnSettings';
 /**
- * Predefined Configuration for the Free Text Column Module
+ * Adaptable State Section for the Free Text Column Module
  */
-export interface FreeTextColumnState extends ConfigState {
+export interface FreeTextColumnState extends BaseState {
     /**
      * Collection of Free Text Columns
      */

package/src/{PredefinedConfig → AdaptableState}/IPushPullState.d.ts

@@ -1,10 +1,10 @@
 import { BaseSchedule } from './Common/Schedule';
 import { AdaptableObject } from './Common/AdaptableObject';
-import { ConfigState } from './ConfigState';
+import { BaseState } from './BaseState';
 /**
  * Internal State used by AdapTable for managing the ipushpull plugin
  */
-export interface IPushPullState extends ConfigState {
+export interface IPushPullState extends BaseState {
     IsIPushPullRunning?: boolean;
     IPushPullDomainsPages?: IPushPullDomain[];
     IPushPullLoginErrorMessage?: string;

package/src/AdaptableState/InitialState.d.ts

@@ -0,0 +1,199 @@
+import { ApplicationState } from './ApplicationState';
+import { AlertState } from './AlertState';
+import { CalculatedColumnState } from './CalculatedColumnState';
+import { ChartingState } from './ChartingState';
+import { CustomSortState } from './CustomSortState';
+import { DashboardState } from './DashboardState';
+import { ExportState } from './ExportState';
+import { FlashingCellState } from './FlashingCellState';
+import { FormatColumnState } from './FormatColumnState';
+import { FreeTextColumnState } from './FreeTextColumnState';
+import { LayoutState } from './LayoutState';
+import { NamedQueryState } from './NamedQueryState';
+import { NoteState } from './NoteState';
+import { PlusMinusState } from './PlusMinusState';
+import { QuickSearchState } from './QuickSearchState';
+import { ScheduleState } from './ScheduleState';
+import { ShortcutState } from './ShortcutState';
+import { StatusBarState } from './StatusBarState';
+import { StyledColumnState } from './StyledColumnState';
+import { ThemeState } from './ThemeState';
+import { ToolPanelState } from './ToolPanelState';
+/**
+ * The initial state of Adaptable which is populated at design-time and used to create the Adaptable State - must include at least one Layout.
+ */
+export interface InitialState {
+    /**
+     * Collection of `AlertDefinitions` which will fire Alerts when the rule is met
+     */
+    Alert?: AlertState;
+    /**
+     * Empty state section (only populated at Design Time) available for User to store their own data with the rest of AdapTable state.
+     */
+    Application?: ApplicationState;
+    /**
+     * Collection of *CalculatedColumn* objects that will display a value based on other cells in the row (using a Calculated Column Expression)
+     */
+    CalculatedColumn?: CalculatedColumnState;
+    /**
+     * Named Charts (wrapping Chart models)
+     */
+    Charting?: ChartingState;
+    /**
+     * Collection of *Custom Sort* objects to allow some columns to be sorted in non-standard (e.g. non alphabetical) ways
+     */
+    CustomSort?: CustomSortState;
+    /**
+     * Large series of properties to give users full control over the look and feel of the *Dashboard* - the section above the grid with toolbars and buttons
+     */
+    Dashboard?: DashboardState;
+    /**
+     * Collection of *Report* objects, together with name of the Current Report, as part of AdapTable export Module
+     */
+    Export?: ExportState;
+    /***
+     * Definitions of which cells flash in response to data changes
+     */
+    FlashingCell?: FlashingCellState;
+    /**
+     * Collection of *FormatColumn* objects that will style an entire column either fully or using a Condition
+     */
+    FormatColumn?: FormatColumnState;
+    /**
+     * Collection of *FreeText* objects so users can make their own notes in bespoke columns that will get stored with their state (and not with the DataSource).  Useful if needing a 'Comments' column.
+     */
+    FreeTextColumn?: FreeTextColumnState;
+    /**
+     * Collection of *Layouts* to name (and manage) sets of column visibility, order, grouping, sorts, aggregations, filters etc.
+     */
+    Layout: LayoutState;
+    /**
+     * Named Queries available for use across multiple AdapTable Modules; and `CurrentQuery` - an Expression to run at start-up
+     */
+    NamedQuery?: NamedQueryState;
+    /**
+     * Collection of personal Notes that are edited at Cell level
+     */
+    Note?: NoteState;
+    /**
+     * Collection of *PlusMinus* rule objects to stipulate what happens when the user clicks '+' or '-' in a numeric cell
+     */
+    PlusMinus?: PlusMinusState;
+    /**
+     * Configues how Quick Search will run i.e. how and whether to highlight matching cells and to filter out non-matching rows
+     */
+    QuickSearch?: QuickSearchState;
+    /**
+     * Collection of *Schedule* objects
+     */
+    Schedule?: ScheduleState;
+    /**
+     * Collection of *Shortcut* objects to aid data entry and prevent 'fat finger' issues
+     */
+    Shortcut?: ShortcutState;
+    /**
+     * Configures the Adaptable Status Bar
+     */
+    StatusBar?: StatusBarState;
+    /**
+     * Collection of Special Column Styles
+     */
+    StyledColumn?: StyledColumnState;
+    /**
+     * Specifies the current Theme and lists the User and System themes available for selection.
+     */
+    Theme?: ThemeState;
+    /**
+     * Sets order and visibility of Tool Panel controls in the AdapTable ToolPanel (on right of grid)
+     */
+    ToolPanel?: ToolPanelState;
+}
+/**
+ * @deprecated Use `InitialState` instead - it has the same structure but is more accurately named
+ */
+export interface PredefinedConfig {
+    /**
+     * Collection of `AlertDefinitions` which will fire Alerts when the rule is met
+     */
+    Alert?: AlertState;
+    /**
+     * Empty state section (only populated at Design Time) available for User to store their own data with the rest of AdapTable state.
+     */
+    Application?: ApplicationState;
+    /**
+     * Collection of *CalculatedColumn* objects that will display a value based on other cells in the row (using a Calculated Column Expression)
+     */
+    CalculatedColumn?: CalculatedColumnState;
+    /**
+     * Named Charts (wrapping Chart models)
+     */
+    Charting?: ChartingState;
+    /**
+     * Collection of *Custom Sort* objects to allow some columns to be sorted in non-standard (e.g. non alphabetical) ways
+     */
+    CustomSort?: CustomSortState;
+    /**
+     * Large series of properties to give users full control over the look and feel of the *Dashboard* - the section above the grid with toolbars and buttons
+     */
+    Dashboard?: DashboardState;
+    /**
+     * Collection of *Report* objects, together with name of the Current Report, as part of AdapTable export Module
+     */
+    Export?: ExportState;
+    /***
+     * Objects which define which cells flash in response to data changes
+     */
+    FlashingCell?: FlashingCellState;
+    /**
+     * Collection of *FormatColumn* objects that will style an entire column either fully or using a Condition
+     */
+    FormatColumn?: FormatColumnState;
+    /**
+     * Collection of *FreeText* objects so users can make their own notes in bespoke columns that will get stored with their state (and not with the DataSource).  Useful if needing a 'Comments' column.
+     */
+    FreeTextColumn?: FreeTextColumnState;
+    /**
+     * Collection of *Layouts* to name (and manage) sets of column visibility, order, grouping, sorts, aggregations, filters etc.
+     */
+    Layout: LayoutState;
+    /**
+     * Named Queries available for use across multiple AdapTable Modules
+     */
+    NamedQuery?: NamedQueryState;
+    /**
+     * Collection of personal Notes that are edited at Cell level
+     */
+    Note?: NoteState;
+    /**
+     * Collection of *PlusMinus* rule objects to stipulate what happens when the user clicks '+' or '-' in a numeric cell
+     */
+    PlusMinus?: PlusMinusState;
+    /**
+     * Configues how Quick Search will run i.e. how and whether to highlight matching cells and to filter out non-matching rows
+     */
+    QuickSearch?: QuickSearchState;
+    /**
+     * Collection of *Schedule* objects
+     */
+    Schedule?: ScheduleState;
+    /**
+     * Collection of *Shortcut* objects to aid data entry and prevent 'fat finger' issues
+     */
+    Shortcut?: ShortcutState;
+    /**
+     * Configures the Adaptable Status Bar
+     */
+    StatusBar?: StatusBarState;
+    /**
+     * Collection of Special Column Styles
+     */
+    StyledColumn?: StyledColumnState;
+    /**
+     * Specifies the current Theme and lists the User and System themes available for selection.
+     */
+    Theme?: ThemeState;
+    /**
+     * Sets the order and visibility of the Tool Panel controls in the AdapTable ToolPanel (on right of grid)
+     */
+    ToolPanel?: ToolPanelState;
+}

package/src/{PredefinedConfig → AdaptableState}/InternalState.d.ts

@@ -24,7 +24,7 @@ export type SystemRowSummary = {
     RowData: Record<string, any>;
 };
 /**
- * Internal state, used by Adaptable during a session; none of it is provided through Predefined Config, nor is it persisted
+ * Internal state, used by Adaptable during a session; none of it is provided through Initial Adaptable State, nor is it persisted
  */
 export interface InternalState extends IPushPullState, OpenFinState {
     Columns: AdaptableColumn[];

package/src/{PredefinedConfig → AdaptableState}/LayoutState.d.ts

@@ -1,4 +1,4 @@
-import { ConfigState } from './ConfigState';
+import { BaseState } from './BaseState';
 import { AdaptableObject } from './Common/AdaptableObject';
 import { ColumnSort } from './Common/ColumnSort';
 import { ColumnFilter, GridFilter } from '../types';
@@ -14,9 +14,9 @@ export type Layout = TableLayout | PivotLayout;
  */
 export type LayoutArray = NonEmptyArray<Layout>;
 /**
- * Predefined Configuration for Layout Module, containing collection of Layouts and name of Current Layout
+ * Adaptable State Section for Layout Module, containing collection of Layouts and name of Current Layout
  */
-export interface LayoutState extends ConfigState {
+export interface LayoutState extends BaseState {
     /**
      * Layout to be loaded when AdapTable starts (using `Name` property in Layout); if not provided the first Layout is used
      */
@@ -125,7 +125,7 @@ export interface PivotLayout extends LayoutBase {
      */
     PivotColumns: string[];
     /**
-     * How deep to expand Pivots
+     * How deep to expand Pivot Columns (0 for none, 1 for 1st level only etc, -1 to expand all)
      */
     PivotExpandLevel?: number;
     /**

package/src/{PredefinedConfig → AdaptableState}/NamedQueryState.d.ts

@@ -1,10 +1,10 @@
-import { ConfigState } from './ConfigState';
+import { BaseState } from './BaseState';
 import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
 import { AdaptableObject } from './Common/AdaptableObject';
 /**
- * Predefined Configuration for Named Query Module
+ * Adaptable State Section for Named Query Module
  */
-export interface NamedQueryState extends ConfigState {
+export interface NamedQueryState extends BaseState {
     /**
      * Named Queries which can be referenced in other Expressions
      */

package/src/{PredefinedConfig → AdaptableState}/NoteState.d.ts

@@ -1,9 +1,9 @@
 import { AdaptableObject } from '../types';
-import { ConfigState } from './ConfigState';
+import { BaseState } from './BaseState';
 /**
- * Predefined Configuration for Note Module
+ * Adaptable State Section for Note Module
  */
-export interface NoteState extends ConfigState {
+export interface NoteState extends BaseState {
     /**
      * Collection of AdapTable Notes
      */

package/src/{PredefinedConfig → AdaptableState}/OpenFinState.d.ts

@@ -1,10 +1,10 @@
-import { ConfigState } from './ConfigState';
+import { BaseState } from './BaseState';
 import { AdaptableObject } from './Common/AdaptableObject';
 import { BaseSchedule } from './Common/Schedule';
 /**
  * Internal State used by AdapTable for managing the OpenFin plugin
  */
-export interface OpenFinState extends ConfigState {
+export interface OpenFinState extends BaseState {
     CurrentLiveOpenFinReport?: OpenFinReport;
     OpenFinCurrentReportName?: string;
 }

package/src/{PredefinedConfig → AdaptableState}/PlusMinusState.d.ts

@@ -1,11 +1,11 @@
-import { ConfigState } from './ConfigState';
+import { BaseState } from './BaseState';
 import { ColumnScope } from './Common/ColumnScope';
 import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
 import { SuspendableObject } from './Common/SuspendableObject';
 /**
- * Predefined Configuration for Plus Minus Module
+ * Adaptable State Section for Plus Minus Module
  */
-export interface PlusMinusState extends ConfigState {
+export interface PlusMinusState extends BaseState {
     /**
      * Array of Plus Minus Nudges
      */

package/src/{PredefinedConfig → AdaptableState}/PopupState.d.ts

@@ -1,5 +1,5 @@
 import { ScreenPopup, ConfirmationPopup, PromptPopup, WindowPopup, FormPopup } from '../Utilities/Interface/MessagePopups';
-import { ConfigState } from './ConfigState';
+import { BaseState } from './BaseState';
 import { ProgressIndicatorConfig } from './Common/ProgressIndicatorConfig';
 export interface ProgressIndicator extends ProgressIndicatorConfig {
     active: boolean;
@@ -7,7 +7,7 @@ export interface ProgressIndicator extends ProgressIndicatorConfig {
 /**
  * Internal state to manage open popups - NOT persisted by Redux
  */
-export interface PopupState extends ConfigState {
+export interface PopupState extends BaseState {
     ScreenPopup: ScreenPopup;
     WindowPopup: WindowPopup;
     FormPopup: FormPopup;

package/src/{PredefinedConfig → AdaptableState}/QuickSearchState.d.ts

@@ -1,9 +1,9 @@
 import { AdaptableStyle } from './Common/AdaptableStyle';
-import { ConfigState } from './ConfigState';
+import { BaseState } from './BaseState';
 /**
- * Predefined Configuration for Quick Search Module
+ * Adaptable State Section for Quick Search Module
  */
-export interface QuickSearchState extends ConfigState {
+export interface QuickSearchState extends BaseState {
     /**
      * Last Quick Search that was run (and will run again at start up)
      */

package/src/{PredefinedConfig → AdaptableState}/ScheduleState.d.ts

@@ -1,13 +1,13 @@
-import { ConfigState } from './ConfigState';
+import { BaseState } from './BaseState';
 import { IPushPullSchedule } from './IPushPullState';
 import { OpenFinSchedule } from './OpenFinState';
 import { AdaptableMessageType, ReportSchedule } from '../types';
 import { BaseSchedule } from './Common/Schedule';
 /**
- * Predefined Configuration for the Schedule Module
+ * Adaptable State Section for the Schedule Module
  *
  */
-export interface ScheduleState extends ConfigState {
+export interface ScheduleState extends BaseState {
     /**
      * Schedules connected to Reports (created in the Export function)
      */

package/src/{PredefinedConfig → AdaptableState}/ShortcutState.d.ts

@@ -1,10 +1,10 @@
-import { ConfigState } from './ConfigState';
+import { BaseState } from './BaseState';
 import { ColumnScope } from './Common/ColumnScope';
 import { SuspendableObject } from './Common/SuspendableObject';
 /**
- * Predefined Configuration for Shortcut Module
+ * Adaptable State Section for Shortcut Module
  */
-export interface ShortcutState extends ConfigState {
+export interface ShortcutState extends BaseState {
     /**
      * Collection of Shortcuts - designed to speed up data entry
      */

package/src/{PredefinedConfig → AdaptableState}/StatusBarState.d.ts

@@ -1,9 +1,9 @@
-import { ConfigState } from '../types';
+import { BaseState } from '../types';
 import { AdaptableStatusBarPanel } from './Common/Types';
 /**
- * Predefined Configuration for the Adaptable Status Bar
+ * Adaptable State Section for the Adaptable Status Bar
  */
-export interface StatusBarState extends ConfigState {
+export interface StatusBarState extends BaseState {
     /**
      * Adaptable Status Bars to display - can be unlimited and displayed in 3 locations
      * @defaultValue null

package/src/{PredefinedConfig → AdaptableState}/StyledColumnState.d.ts

@@ -1,13 +1,13 @@
-import { ConfigState } from './ConfigState';
+import { BaseState } from './BaseState';
 import { SuspendableObject } from './Common/SuspendableObject';
 import { AdaptableCustomIcon, AdaptableSystemIcon, AdaptablePredicate, AdaptableStyle, AdaptableBooleanQuery } from '../types';
 import { TypeHint } from './Common/Types';
 import { RowScope } from './Common/RowScope';
 import { AgSparklineOptions } from 'ag-charts-types';
 /**
- * Predefined Configuration for Styled Column Module
+ * Adaptable State Section for Styled Column Module
  */
-export interface StyledColumnState extends ConfigState {
+export interface StyledColumnState extends BaseState {
     /**
      * Collection of Special Column Styles
      */

package/src/{PredefinedConfig → AdaptableState}/TeamSharingState.d.ts

@@ -1,12 +1,12 @@
-import { ConfigState } from './ConfigState';
+import { BaseState } from './BaseState';
 import { AdaptableObject, AdaptableObjectTag } from './Common/AdaptableObject';
 import { AdaptableModule } from '../types';
 import { TypeUuid } from './Uuid';
 import * as Redux from 'redux';
 /**
- * State for Team Sharing; this is internal so not designed to be provided as part of Predefined Config
+ * State for Team Sharing; internal so not designed to be provided as part of Initial Adaptable State
  */
-export interface TeamSharingState extends ConfigState {
+export interface TeamSharingState extends BaseState {
     /**
      * List of objects currently being Team Shared
      */

package/src/{PredefinedConfig → AdaptableState}/ThemeState.d.ts

@@ -1,10 +1,10 @@
-import { ConfigState } from './ConfigState';
+import { BaseState } from './BaseState';
 import { AdaptableObject } from './Common/AdaptableObject';
 import { TypeHint } from './Common/Types';
 /**
  * Theme section of Adaptable State
  */
-export interface ThemeState extends ConfigState {
+export interface ThemeState extends BaseState {
     /**
      * Name of current theme (or theme to set at startup); leave blank if using 'Light Theme', set to 'dark' for 'Dark Theme' or provide name of Custom Theme
      */

package/src/{PredefinedConfig → AdaptableState}/ToolPanelState.d.ts

@@ -1,9 +1,9 @@
-import { ConfigState } from './ConfigState';
+import { BaseState } from './BaseState';
 import { AdaptableModuleButtons, AdaptableToolPanel } from './Common/Types';
 /**
- * Predefined Configuration for the Adaptable ToolPanel
+ * Adaptable State Section for the AdapTable ToolPanel
  */
-export interface ToolPanelState extends ConfigState {
+export interface ToolPanelState extends BaseState {
     /**
      * Adaptable Tool Panels which are viaible
      * @defaultValue ToolPanels for all available Modules (subject to Entitlement rules)

package/src/Api/AdaptableApi.d.ts

@@ -5,7 +5,7 @@ import { BulkUpdateApi } from './BulkUpdateApi';
 import { CalendarApi } from './CalendarApi';
 import { CalculatedColumnApi } from './CalculatedColumnApi';
 import { CellSummaryApi } from './CellSummaryApi';
-import { ConfigApi } from './ConfigApi';
+import { StateApi } from './StateApi';
 import { CustomSortApi } from './CustomSortApi';
 import { DashboardApi } from './DashboardApi';
 import { ToolPanelApi } from './ToolPanelApi';
@@ -95,7 +95,7 @@ export interface AdaptableApi {
     /**
      * Methods giving access to Adaptable State
      */
-    configApi: ConfigApi;
+    stateApi: StateApi;
     /**
      * Provides access to the Custom Sort Module
      */

package/src/Api/AlertApi.d.ts

@@ -1,7 +1,7 @@
-import { AlertDefinition, AlertState } from '../PredefinedConfig/AlertState';
-import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
+import { AlertDefinition, AlertState } from '../AdaptableState/AlertState';
+import { AdaptableAlert } from '../AdaptableState/Common/AdaptableAlert';
 import { AdaptableMessageType, AlertProperties } from '../types';
-import { AdaptableObjectLookupCriteria } from '../PredefinedConfig/Common/AdaptableObject';
+import { AdaptableObjectLookupCriteria } from '../AdaptableState/Common/AdaptableObject';
 /**
  * Provides run-time access to Alert function and associated State
  */

package/src/Api/ApplicationApi.d.ts

@@ -1,4 +1,4 @@
-import { ApplicationState, ApplicationDataEntry } from '../PredefinedConfig/ApplicationState';
+import { ApplicationState, ApplicationDataEntry } from '../AdaptableState/ApplicationState';
 /**
  * Provides run-time access to the Application Module
  */

package/src/Api/CalculatedColumnApi.d.ts

@@ -1,4 +1,4 @@
-import { CalculatedColumn, CalculatedColumnState } from '../PredefinedConfig/CalculatedColumnState';
+import { CalculatedColumn, CalculatedColumnState } from '../AdaptableState/CalculatedColumnState';
 /**
  * Provides run-time access to the Calculated Column Module
  **/

package/src/Api/CellSummaryApi.d.ts

@@ -1,4 +1,4 @@
-import { CustomCellSummaryOperation } from '../PredefinedConfig/Common/CellSummary';
+import { CustomCellSummaryOperation } from '../AdaptableState/Common/CellSummary';
 /**
  *  Provides run-time access to the Cell Summary Module
  */

package/src/Api/ChartingApi.d.ts

@@ -1,5 +1,5 @@
 import { ChartModel, ChartRef } from 'ag-grid-enterprise';
-import { ExternalChartDefinition } from '../PredefinedConfig/ChartingState';
+import { ExternalChartDefinition } from '../AdaptableState/ChartingState';
 import { ChartContainer, ChartDefinition } from '../types';
 import { ChartingOpenState } from './Events/ChartChanged';
 /**

package/src/Api/ColumnFilterApi.d.ts

@@ -1,5 +1,5 @@
 import { AdaptableColumn, ColumnFilter, ColumnFilterPredicate } from '../types';
-import { AdaptablePredicateDef, ColumnFilterDef } from '../PredefinedConfig/Common/AdaptablePredicate';
+import { AdaptablePredicateDef, ColumnFilterDef } from '../AdaptableState/Common/AdaptablePredicate';
 /**
  * Provides run-time access to Filter section of Adaptable State.
  */
@@ -84,6 +84,11 @@ export interface ColumnFilterApi {
      * Checks if a Column Filter is active (i.e. Predicate has no inputs or has inputs with values)
      */
     isColumnFilterActive(columnFilter: ColumnFilter): boolean;
+    /**
+     * Checks if the given Coumn has an active Column Filter
+     * @param columnId Column ID to check
+     */
+    isColumnFilterActiveForColumn(columnId: string): boolean;
     /**
      * Retrieves the Column Filter definitions for all available Column Filters
      */

package/src/Api/ColumnScopeApi.d.ts

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

package/src/Api/CommentApi.d.ts

@@ -1,4 +1,4 @@
-import { CommentThread } from '../PredefinedConfig/CommentState';
+import { CommentThread } from '../AdaptableState/CommentState';
 import { AdaptableComment, CellAddress } from '../types';
 /**
  * Provides run-time access to Comment Module and related State

package/src/Api/CustomSortApi.d.ts

@@ -1,4 +1,4 @@
-import { CustomSortState, CustomSort } from '../PredefinedConfig/CustomSortState';
+import { CustomSortState, CustomSort } from '../AdaptableState/CustomSortState';
 /**
  *  Provides run-time access to the Custom Sort function
  */

package/src/Api/DashboardApi.d.ts

@@ -1,6 +1,6 @@
-import { DashboardState, DashboardTab } from '../PredefinedConfig/DashboardState';
-import { AdaptableDashboardToolbar, AdaptableDashboardToolbars, AdaptableModuleButtons } from '../PredefinedConfig/Common/Types';
-import { AdaptableButton } from '../PredefinedConfig/Common/AdaptableButton';
+import { DashboardState, DashboardTab } from '../AdaptableState/DashboardState';
+import { AdaptableDashboardToolbar, AdaptableDashboardToolbars, AdaptableModuleButtons } from '../AdaptableState/Common/Types';
+import { AdaptableButton } from '../AdaptableState/Common/AdaptableButton';
 import { CustomToolbar, DashboardButtonContext } from '../AdaptableOptions/DashboardOptions';
 /**
  * Functions relating to the AdapTable Dashboard.