@adaptabletools/adaptable 11.2.4 → 12.0.0-canary.1

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -2,11 +2,10 @@ import { AdaptableIcon } from '../PredefinedConfig/Common/AdaptableIcon';
 import { DateInputOptions } from './DateInputOptions';
 import { AdaptableScope } from '../PredefinedConfig/Common/AdaptableScope';
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
-import { AdaptableButton } from '../PredefinedConfig/Common/AdaptableButton';
-import { RowNode } from '@ag-grid-community/all-modules';
 import { AdaptableObject, AdaptableObjectTag } from '../PredefinedConfig/Common/AdaptableObject';
 import { AdaptableStyle } from '../PredefinedConfig/Common/AdaptableStyle';
-import { AdaptableApi, BaseContext, GridCell } from '../../types';
+import { AdaptableButton, BaseContext, GridCell } from '../../types';
+import { RowNode } from '@ag-grid-community/all-modules';
 /**
  * Options for managing the User Interface of AdapTable
  */
@@ -52,10 +51,6 @@ export interface UserInterfaceOptions {
      * Colours to display in Colour Picker (in place of AdapTable's default set); can be hardcoded list or function
      */
     colorPalette?: string[] | ((currentTheme: string) => string[]);
-    /**
-     * Columns which contain an AdapTable Button - used for performing Actions
-     */
-    actionColumns?: ActionColumn[];
     /**
      * Style to set for editable cells
      */
@@ -73,12 +68,7 @@ export interface UserInterfaceOptions {
     /**
      * Optional list of AdaptableObjectTags that can be associated with AdaptableObjects
      */
-    objectTags?: AdaptableObjectTag[] | ((adaptableApi: AdaptableApi) => AdaptableObjectTag[]);
-    /**
-     * Optional list of Column Types - used primarily for special columns
-     *
-     */
-    columnTypes?: string[];
+    objectTags?: AdaptableObjectTag[] | ((context: ObjectTagsContext) => AdaptableObjectTag[]);
     /**
      * Provide links to AdapTable documentation (in Module popups and Expression Editor)
      *
@@ -99,56 +89,54 @@ export interface UserInterfaceOptions {
      * @gridInfoItem
      */
     showAdapTableVersion?: boolean;
-}
-export interface BasePermittedValues {
     /**
-     * Scope where Values will appear (Mandatory property)
+     * Custom Formatters to use in the Format Column Module
      */
-    scope: AdaptableScope;
-}
-/**
- * Permitted/possible values, when column values can be selected (e.g. sort, bulk-update)
- */
-export interface PermittedValues extends BasePermittedValues {
+    customDisplayFormatters?: CustomDisplayFormatter[];
     /**
-     * Values to display: either hardcoded list or a function
+     * Options for creating Action Columns and Buttons
      */
-    values?: any[] | ((context: PermittedValuesContext) => any[]);
-}
-/**
- * Used to define permitted values for inline column editor
- */
-export interface EditLookUpPermittedValues extends BasePermittedValues {
-    values?: any[] | ((context: EditLookUpContext) => any[]);
+    actionOptions?: ActionOptions;
 }
 /**
- * Used to define values inside the floating filter and floating filter (quick filter)
+ * Options related to Action Columns and Buttons in Adaptable.
  */
-export interface FilterPermittedValues extends BasePermittedValues {
+export interface ActionOptions {
     /**
-     * Prevents AdapTable from filtering the list of values client-side; When true, values is called each time the search bar is changed
+     * Columns which contain an AdapTable Button - used for performing Actions
+     */
+    actionColumns?: ActionColumn[];
+    /**
+     * Action buttons to display for each row.
+     *
+     * @defaultValue undefined
+     */
+    actionRowButtons?: ('clone' | 'create' | 'edit' | 'delete')[];
+    /**
+     * Position of supplied Action Buttons
+     *
+     * @defaultValue 'pinnedLeft'
+     */
+    actionRowButtonsPosition?: 'pinnedLeft' | 'pinnedRight';
+    /**
+     * If set to true, the Action Row Buttons will be handled by AdapTable and the grid data model will be automatically updated with the created/edited/deleted rows
+     *
      * @defaultValue false
      */
-    suppressFilterSearchBar?: boolean;
-    values: (context: FilterPermittedValuesContext) => any[] | Promise<any[]>;
-}
-/**
- * Custom column values for custom sort.
- */
-export interface CustomSortPermittedValues extends BasePermittedValues {
-    values: (context: PermittedValuesContext) => any[] | Promise<any[]>;
+    autoHandleActionRowButtons?: boolean;
+    /**
+     * Function which is called when auto-handling the 'create' Action Row Button. The returned row value should have a valid(unique) primary key value.
+     *
+     * @defaultValue undefined
+     */
+    setPrimaryKeyValue?: (context: SetPrimaryKeyValueContext) => any;
 }
 /**
- * User to define permitted values when updating cells via bulk update
+ * The context for the SetPrimaryKeyValueContext function
  */
-export interface BulkUpdatePermittedValues extends BasePermittedValues {
-    values: (context: BulkUpdatePermittedValuesContext) => any[] | Promise<any[]>;
+export interface SetPrimaryKeyValueContext extends BaseContext {
+    rowData: any;
 }
-/**
- * Use PermittedValues instead
- * @deprecated use PermittedValues instead
- */
-export declare type CellValuesList = PermittedValues;
 /**
  * A Special Column that wraps an AdapTable Button
  */
@@ -215,6 +203,55 @@ export interface ActionColumnSettings {
      */
     suppressMovable?: boolean;
 }
+export interface BasePermittedValues {
+    /**
+     * Scope where Values will appear (Mandatory property)
+     */
+    scope: AdaptableScope;
+}
+/**
+ * Permitted/possible values, when column values can be selected (e.g. sort, bulk-update)
+ */
+export interface PermittedValues extends BasePermittedValues {
+    /**
+     * Values to display: either hardcoded list or a function
+     */
+    values?: any[] | ((context: PermittedValuesContext) => any[]);
+}
+/**
+ * Used to define permitted values for inline column editor
+ */
+export interface EditLookUpPermittedValues extends BasePermittedValues {
+    values?: any[] | ((context: EditLookUpContext) => any[]);
+}
+/**
+ * Used to define values inside the floating filter and floating filter (quick filter)
+ */
+export interface FilterPermittedValues extends BasePermittedValues {
+    /**
+     * Prevents AdapTable from filtering the list of values client-side; When true, values is called each time the search bar is changed
+     * @defaultValue false
+     */
+    suppressFilterSearchBar?: boolean;
+    values: (context: FilterPermittedValuesContext) => any[] | Promise<any[]>;
+}
+/**
+ * Custom column values for custom sort.
+ */
+export interface CustomSortPermittedValues extends BasePermittedValues {
+    values: (context: PermittedValuesContext) => any[] | Promise<any[]>;
+}
+/**
+ * User to define permitted values when updating cells via bulk update
+ */
+export interface BulkUpdatePermittedValues extends BasePermittedValues {
+    values: (context: BulkUpdatePermittedValuesContext) => any[] | Promise<any[]>;
+}
+/**
+ * Use PermittedValues instead
+ * @deprecated use PermittedValues instead
+ */
+export declare type CellValuesList = PermittedValues;
 export interface EditLookUpContext extends BaseContext {
     /**
      * Column displaying the Edit LookUp
@@ -223,7 +260,7 @@ export interface EditLookUpContext extends BaseContext {
     /**
      * Cell being edited
      */
-    gridCell: GridCell;
+    gridCell?: GridCell;
 }
 export interface PermittedValuesContext extends BaseContext {
     /**
@@ -253,3 +290,11 @@ export interface BulkUpdatePermittedValuesContext extends BaseContext {
 }
 export declare type GridInfoSections = GridInfoSection[];
 export declare type GridInfoSection = 'GridSummary' | 'AdaptableOptions' | 'ColumnInfo' | 'AdaptableObjectsSummary';
+export interface ObjectTagsContext extends BaseContext {
+}
+export declare type CustomDisplayFormatter = {
+    id: string;
+    label?: string;
+    handler: (value: any) => any;
+    scope: AdaptableScope;
+};

package/src/Api/AdaptableApi.d.ts

@@ -8,7 +8,7 @@ import { ConditionalStyleApi } from './ConditionalStyleApi';
 import { CustomSortApi } from './CustomSortApi';
 import { DashboardApi } from './DashboardApi';
 import { ToolPanelApi } from './ToolPanelApi';
-import { DataSourceApi } from './DataSourceApi';
+import { DataSetApi } from './DataSetApi';
 import { EventApi } from './EventApi';
 import { ExportApi } from './ExportApi';
 import { FormatColumnApi } from './FormatColumnApi';
@@ -89,9 +89,9 @@ export interface AdaptableApi {
      **/
     dataChangeHistoryApi: DataChangeHistoryApi;
     /**
-     * Provides access to the Data Source Module
+     * Provides access to Data Sets
      */
-    dataSourceApi: DataSourceApi;
+    dataSetApi: DataSetApi;
     /**
      * Used for listenning / subscribing to the various Events published by AdapTable
      */
@@ -209,6 +209,9 @@ export interface AdaptableApi {
         unmount: boolean;
         destroyApi?: boolean;
     }) => void;
+    /**
+     * Whether the Adaptable instance has been destroyed
+     */
     isDestroyed: () => boolean;
     /**
      * Cleanup method that only cleans up this api instance (clears event listeners and sets every property to null), but does not destroy the Adaptable instance.

package/src/Api/ColumnApi.d.ts

@@ -1,5 +1,4 @@
-import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
-import { DataType } from '../PredefinedConfig/Common/Enums';
+import { AdaptableColumn, AdaptableColumnDataType } from '../PredefinedConfig/Common/AdaptableColumn';
 import { Column, RowNode } from '@ag-grid-community/all-modules';
 import { GridCell } from '../../types';
 /**
@@ -59,7 +58,7 @@ export interface ColumnApi {
      * Returns all Columns that have given DataType
      * @param dataType the DataType of the Columns to retrieve
      */
-    getColumnsOfType(dataType: DataType): AdaptableColumn[];
+    getColumnsOfType(dataType: AdaptableColumnDataType): AdaptableColumn[];
     /**
      * Selects (highlights) a Column
      * @param columnId Column to select
@@ -157,7 +156,7 @@ export interface ColumnApi {
      * Returns Data Type for a Column
      * @param columnId Column to check
      */
-    getColumnDataTypeFromColumnId(columnId: string): 'String' | 'Number' | 'NumberArray' | 'Boolean' | 'Date' | 'Object' | 'Unknown' | undefined;
+    getColumnDataTypeFromColumnId(columnId: string): AdaptableColumnDataType | undefined;
     /**
      * Retrieves Friendly Name for a given Column
      * @param columnId ColumnId to check
@@ -294,4 +293,10 @@ export interface ColumnApi {
      * @param expression Expression to Lookup
      */
     isColumnReferencedInExpression(columnId: string, expression: string): boolean;
+    /**
+     * Checks if a column is a ActionRowButton column (see UserInterfaceOptions.ActionOptions)
+     *
+     * @param columnId Column to Check
+     */
+    isActionRowButtonColumn(columnId: string): boolean;
 }

package/src/Api/ConditionalStyleApi.d.ts

@@ -77,6 +77,16 @@ export interface ConditionalStyleApi {
      * @returns conditional styles
      */
     editConditionalStyles(conditionalStyles: ConditionalStyle[]): ConditionalStyle[];
+    /**
+     * Deletes a Conditional Style
+     * @param conditionalStyle Conditional Style to delete
+     */
+    deleteConditionalStyle(conditionalStyle: ConditionalStyle): void;
+    /**
+     * Deletes Conditional Styles
+     * @param conditionalStyles Conditional Styles to delete
+     */
+    deleteConditionalStyles(conditionalStyles: ConditionalStyle[]): void;
     /**
      * Adds new Conditional Style to State
      * @param conditionalStyle Conditional Style to add

package/src/Api/ConfigApi.d.ts

@@ -4,7 +4,6 @@ import { QuickSearchState } from '../PredefinedConfig/QuickSearchState';
 import { LayoutState } from '../PredefinedConfig/LayoutState';
 import { FormatColumnState } from '../PredefinedConfig/FormatColumnState';
 import { ExportState } from '../PredefinedConfig/ExportState';
-import { DataSourceState } from '../PredefinedConfig/DataSourceState';
 import { DashboardState } from '../PredefinedConfig/DashboardState';
 import { CustomSortState } from '../PredefinedConfig/CustomSortState';
 import { ConditionalStyleState } from '../PredefinedConfig/ConditionalStyleState';
@@ -15,7 +14,6 @@ import { PlusMinusState } from '../PredefinedConfig/PlusMinusState';
 import { ApplicationState } from '../PredefinedConfig/ApplicationState';
 import { AdaptablePersistentState, AdaptableState } from '../PredefinedConfig/AdaptableState';
 import { FreeTextColumnState } from '../PredefinedConfig/FreeTextColumnState';
-import { FilterState } from '../PredefinedConfig/FilterState';
 import { ToolPanelState } from '../PredefinedConfig/ToolPanelState';
 import { AdaptableStateKey, AdaptableModule } from '../PredefinedConfig/Common/Types';
 import { AdaptableSearchState, PredefinedConfig, ScheduleState } from '../types';
@@ -133,21 +131,11 @@ export interface ConfigApi {
      * @param returnJson return as JSON rather than object
      */
     getDashboardState(returnJson: boolean): DashboardState;
-    /**
-     * Returns Data Source section of Adaptable State
-     * @param returnJson return as JSON rather than object
-     */
-    getDataSourceState(returnJson: boolean): DataSourceState;
     /**
      * Returns Export section of Adaptable State
      * @param returnJson return as JSON rather than object
      */
     getExportState(returnJson: boolean): ExportState;
-    /**
-     * Returns Filter section of Adaptable State
-     * @param returnJson return as JSON rather than object
-     */
-    getFilterState(returnJson: boolean): FilterState;
     /**
      * Returns Formt Column section of Adaptable State
      * @param returnJson return as JSON rather than object

package/src/Api/DashboardApi.d.ts

@@ -2,7 +2,7 @@ import { DashboardState, DashboardTab } from '../PredefinedConfig/DashboardState
 import { AdaptableModuleButtons, AdaptableDashboardToolbars, AdaptableDashboardToolbar } from '../PredefinedConfig/Common/Types';
 import { DashboardChangedInfo } from './Events/DashboardChanged';
 import { AdaptableButton } from '../PredefinedConfig/Common/AdaptableButton';
-import { CustomToolbar, CustomToolbarButtonContext, DashboardButtonContext } from '../AdaptableOptions/DashboardOptions';
+import { CustomToolbar, DashboardButtonContext } from '../AdaptableOptions/DashboardOptions';
 /**
  * Functions relating to the AdapTable Dashboard.
  */
@@ -18,7 +18,7 @@ export interface DashboardApi {
     /**
      * Retrieves all Custom Buttons
      */
-    getCustomDashboardButtons(): AdaptableButton<DashboardButtonContext>[] | undefined;
+    getCustomDashboardButtons(): AdaptableButton<DashboardButtonContext>[];
     /**
      * Retrieves first Custom Button with given Label
      * @param buttonLabel the label of the Custom Button to retrieve
@@ -49,23 +49,6 @@ export interface DashboardApi {
      * @param customToolbarName the name of the Custom Toolbar
      */
     getCustomToolbarByName(customToolbarName: string): CustomToolbar;
-    /**
-     * Replaces Toolbar Buttons in Custom Toolbar with the new set
-     * @param customToolbarName name of the Custom Toolbar
-     * @param buttons Toolbar Buttons to add
-     */
-    setCustomToolbarButtons(customToolbarName: string, buttons: AdaptableButton<CustomToolbarButtonContext>[]): void;
-    /**
-     * Adds Toolbar Buttons to current collection in Custom Toolbar
-     * @param customToolbarName name of the Custom Toolbar
-     * @param buttons Toolbar Buttons to add
-     */
-    addCustomToolbarButtons(customToolbarName: string, buttons: AdaptableButton<CustomToolbarButtonContext>[]): void;
-    /**
-     * Clears all Toolbar Buttons from Custom Toolbar
-     * @param customToolbarName the name of the Custom Toolbar
-     */
-    clearCustomToolbarButtons(customToolbarName: string): void;
     /**
      * Collapses Dashboard so only Dashboard Header is visible (and not Toolbars' contents)
      */
@@ -74,6 +57,10 @@ export interface DashboardApi {
      * Expands Dashboard so Toolbars in Active Tab are fully visible
      */
     expandDashboard(): void;
+    /**
+     * Refreshes the entire Dashboard section, including Toolbars and Buttons; this is particularly relevant for AdapTable built-in elements, as framework components are dependent on the framework specific change detection mechanisms
+     */
+    refreshDashboard(): void;
     /**
      * Floats Dashboard so only Dashboard Header is visible (in reduced size); can be dragged to a new location
      */

package/src/Api/DataSetApi.d.ts

@@ -0,0 +1,40 @@
+import { DataSet } from '../types';
+/**
+ *  Provides run-time access to Data Sets
+ */
+export interface DataSetApi {
+    /**
+     * Retrieves the Data Sets from General Options
+     * @returns data Sets
+     */
+    getAllDataSets(): DataSet[];
+    /**
+     * Retrieves the currently applied Data Set
+     * @returns data Set
+     */
+    getCurrentDataSet(): DataSet | undefined;
+    /**
+     * Retreives Data Set from State with given name
+     * @param dataSetName name of Data Set to retrieve
+     * @returns data Set
+     */
+    getDataSetByName(dataSetName: string): DataSet;
+    /**
+     * Makes given Data Set current
+     * @param dataSetName Name of Data Set to apply
+     */
+    setDataSet(dataSetName: string): void;
+    /**
+     * Clears currently selected Data Set
+     */
+    clearCurrentDataSet(): void;
+    /**
+     * Opens Settings Panel with Data Set section selected and visible
+     */
+    showDataSetPopup(): void;
+    /**
+     * Fire the DataSet Changed Event
+     * @param dataSet Data Set which has changed
+     */
+    fireDataSetChangeEvent(dataSet: DataSet): void;
+}

package/src/Api/EventApi.d.ts

@@ -14,6 +14,8 @@ import { AdaptableStateChangedInfo } from './Events/AdaptableStateChanged';
 import { FlashingCellDisplayedInfo } from './Events/FlashingCellDisplayed';
 import { GridDataChangedInfo } from './Events/GridDataChanged';
 import { TeamSharingEntityChangedInfo } from './Events/TeamSharingEntityChanged';
+import { RowFormSubmittedInfo } from './Events/RowFormSubmitted';
+import { DataSetChangedInfo } from './Events/DataSetChanged';
 /**
  * Responsible for publishing the many Events that AdapTable fires
  */
@@ -193,6 +195,32 @@ export interface EventApi {
      * Unsubscribe from LiveDataChanged
      */
     off(eventName: 'LiveDataChanged', callback: (liveDataChangedInfo: LiveDataChangedInfo) => void): void;
+    /**
+     * Event fired when a Row Form is submitted
+     *
+     * @param eventName RowFormSubmitted
+     * @param callback RowFormSubmittedInfo
+     */
+    on(eventName: 'RowFormSubmitted', callback: (rowEditedFormInfo: RowFormSubmittedInfo) => void): () => void;
+    /**
+     * Unsubscribe from RowFormSubmitted
+     * @param eventName RowFormSubmitted
+     * @param callback
+     */
+    off(eventName: 'RowFormSubmitted', callback: (rowEditedFormInfo: RowFormSubmittedInfo) => void): void;
+    /**
+     * Event fired when a DataSet is changed
+     *
+     * @param eventName DataSetChanged
+     * @param callback DataSetChangedInfo
+     */
+    on(eventName: 'DataSetChanged', callback: (dataSetChangedInfo: DataSetChangedInfo) => void): () => void;
+    /**
+     * Unsubscribe from DataSetChanged
+     * @param eventName DataSetChanged
+     * @param callback
+     */
+    off(eventName: 'DataSetChanged', callback: (dataSetChangedInfo: DataSetChangedInfo) => void): void;
     /**
      * Fired when Adaptable is up and running - has no arguments.
      * @param eventName - AdaptableReady
@@ -224,6 +252,6 @@ export interface EventApi {
     emitSync(eventName: 'DashboardChanged', data?: any): any[];
     emitSync(eventName: 'FlashingCellDisplayed', data?: any): any[];
     emitSync(eventName: 'AdaptableDestroy'): any[];
-    emit(eventName: 'AdaptableReady' | 'AlertFired' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'AdaptableStateChanged' | 'DashboardChanged' | 'CellChanged' | 'GridDataChanged' | 'LayoutChanged' | 'LiveDataChanged' | 'SearchChanged' | 'SelectionChanged' | 'SystemStatusMessageDisplayed' | 'TeamSharingEntityChanged' | 'ThemeChanged' | 'FDC3MessageSent', data?: any): Promise<any>;
+    emit(eventName: 'AdaptableReady' | 'AlertFired' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'AdaptableStateChanged' | 'DashboardChanged' | 'CellChanged' | 'GridDataChanged' | 'LayoutChanged' | 'LiveDataChanged' | 'SearchChanged' | 'SelectionChanged' | 'SystemStatusMessageDisplayed' | 'TeamSharingEntityChanged' | 'ThemeChanged' | 'FDC3MessageSent' | 'RowFormSubmitted' | 'DataSetChanged', data?: any): Promise<any>;
     destroy(): void;
 }

package/src/Api/Events/DataSetChanged.d.ts

@@ -0,0 +1,5 @@
+import { DataSet } from '../../types';
+import { BaseEventInfo } from './BaseEventInfo';
+export interface DataSetChangedInfo extends BaseEventInfo {
+    dataSet: DataSet;
+}

package/src/Api/Events/RowFormSubmitted.d.ts

@@ -0,0 +1,19 @@
+import { BaseEventInfo } from './BaseEventInfo';
+import { AdaptableFormData } from '../../PredefinedConfig/Common/AdaptableForm';
+import { RowNode } from '@ag-grid-community/all-modules';
+export declare type RowFormSubmittedInfo = CreatedRowFormInfo | EditedRowFormInfo | DeletedRowFormInfo;
+export declare type RowFormType = 'rowCreated' | 'rowEdited' | 'rowDeleted';
+export interface CreatedRowFormInfo extends BaseEventInfo {
+    type: 'rowCreated';
+    formData: AdaptableFormData;
+    clonedRowNode?: RowNode;
+}
+export interface EditedRowFormInfo extends BaseEventInfo {
+    type: 'rowEdited';
+    formData: AdaptableFormData;
+    rowNode: RowNode;
+}
+export interface DeletedRowFormInfo extends BaseEventInfo {
+    type: 'rowDeleted';
+    rowNode: RowNode;
+}

package/src/Api/Events/SearchChanged.d.ts

@@ -1,8 +1,7 @@
-import { DataSource } from '../../PredefinedConfig/DataSourceState';
 import { CustomSort } from '../../PredefinedConfig/CustomSortState';
 import { ColumnSort } from '../../PredefinedConfig/Common/ColumnSort';
-import { ColumnFilter } from '../../PredefinedConfig/FilterState';
 import { BaseEventInfo } from './BaseEventInfo';
+import { ColumnFilter, DataSet } from '../../types';
 /**
  * EventInfo returned by SearchChanged event; includes full AdapTable search and sort info plus the event's trigger
  */
@@ -10,7 +9,7 @@ export interface SearchChangedInfo extends BaseEventInfo {
     /**
      * What search-related change caused the event to fire
      */
-    searchChangedTrigger: 'DataSource' | 'CurrentQuery' | 'Filter' | 'DataChange' | 'Sort';
+    searchChangedTrigger: 'CurrentQuery' | 'Filter' | 'DataChange' | 'Sort';
     /**
      * Current searches and filters in the Grid
      */
@@ -25,9 +24,9 @@ export interface SearchChangedInfo extends BaseEventInfo {
  */
 export interface AdaptableSearchState {
     /**
-     * Current Data Source (if one selected)
+     * Current DataSet (if one selected)
      */
-    dataSource: DataSource | undefined;
+    dataSet: DataSet | undefined;
     /**
      * Current Query
      */

package/src/Api/ExportApi.d.ts

@@ -1,7 +1,7 @@
 import { AdaptableForm } from '../PredefinedConfig/Common/AdaptableForm';
 import { ExportState, Report, ReportData, ReportSchedule, SystemReportNames } from '../PredefinedConfig/ExportState';
 import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
-import { CustomDestination, ExportButtonContext } from '../AdaptableOptions/ExportOptions';
+import { CustomDestination, ExportFormContext } from '../AdaptableOptions/ExportOptions';
 import { ExportDestination } from '../PredefinedConfig/Common/Enums';
 /**
  * Provides run-time access to the Export Module and Report state
@@ -122,7 +122,7 @@ export interface ExportApi {
      * Form Data entered by the User in the UI for a Custom Destination
      * @param destination Custom Destination for which to get Form Def
      */
-    getExportDestinationForm(destinationName: string): AdaptableForm<ExportButtonContext> | undefined;
+    getExportDestinationForm(destinationName: string): AdaptableForm<ExportFormContext> | undefined;
     /**
      * Whether given data change affects given report
      * @param cellDataChangedInfo data change to check

package/src/Api/FilterApi.d.ts

@@ -1,15 +1,10 @@
-import { FilterState, ColumnFilter, SystemFilterPredicateIds } from '../PredefinedConfig/FilterState';
-import { AdaptableColumn } from '../types';
+import { AdaptableColumn, ColumnFilter, GridCell, SystemFilterPredicateIds } from '../types';
 import { AdaptablePredicateDef } from '../PredefinedConfig/Common/AdaptablePredicate';
 import { RowNode } from '@ag-grid-community/all-modules';
 /**
  * Provides run-time access to Filter section of Adaptable State.
  */
 export interface FilterApi {
-    /**
-     * Retrieves Filter section from Adaptable State
-     */
-    getFilterState(): FilterState;
     /**
      * Returns Predicate Definition for given Column and Quick Filter shortcut
      * @param shortcut Quick Filter shortcut to lookup
@@ -31,16 +26,26 @@ export interface FilterApi {
      */
     getAllSystemFilterIds(): SystemFilterPredicateIds;
     /**
-     * Retrieves all the Column Filters in the Column Filter State (of Predefined Config)
-     * @returns column filters
+     * Makes Quick Filter Bar appear
      */
-    getAllColumnFilter(): ColumnFilter[];
+    showQuickFilterBar(): void;
+    /**
+     * Hides Quick Filter bar
+     */
+    hideQuickFilterBar(): void;
     /**
-     * Retrieves ColumnFilter by Id
-     * @param id column filter id
-     * @returns column filter
+     * Whether Quick Filter is available for use
+     */
+    isQuickFilterAvailable(): boolean;
+    /**
+     * Whether Quick Filter Form is currently visible
+     */
+    isQuickFilterVisible(): boolean;
+    /**
+     * Retrieves all the Column Filters in the Column Filter State (of Predefined Config)
+     * @returns column filters
      */
-    getColumnFilterById(id: ColumnFilter['Uuid']): ColumnFilter;
+    getColumnFilters(): ColumnFilter[];
     /**
      * Sets Column Filters - will replace filters for existing column and leave other column filters in place
      * @param columnFilters Column Filters to set
@@ -63,9 +68,9 @@ export interface FilterApi {
      */
     clearColumnFilterByColumns(columns: string[]): void;
     /**
-     * Clears all Column Filters in State
+     * Clears all Column Filters in the Current Layout
      */
-    clearAllColumnFilter(): void;
+    clearColumnFilters(): void;
     /**
      * Clears existing Column Filters and then sets the new ones
      * @param columnFilters Column Filters to set
@@ -78,12 +83,15 @@ export interface FilterApi {
      */
     getAllColumnFilterForColumn(columnId: string): ColumnFilter[];
     /**
-     * Creates new Column Filter on given Column using Primary Key values
-     * @param columnId ColumnId to use
-     * @param primarykeyValues Primary Key Values to use
-     * @returns column filter
+     * Creates an Equality Filter based on given Grid Cells
+     * @param gridCells cells to create Filter for
+     */
+    createValuesColumnFilterForCells(gridCells: GridCell[]): ColumnFilter | null;
+    /**
+     *  Creates an Equality Filter based on given Grid Cell
+     * @param gridCell cell to create Filter for
      */
-    createColumnFilterForCell(columnId: string, primarykeyValues: any[]): ColumnFilter | null;
+    createEqualityColumnFilterForCell(gridCell: GridCell): ColumnFilter | null;
     /**
      * Retrieves description of given Column Filter
      * @param columnFilter Column Filter to use
@@ -100,20 +108,4 @@ export interface FilterApi {
      * @param node Row Node to evaluate
      */
     evaluateColumnFilter(columnFilter: ColumnFilter, node: RowNode): boolean;
-    /**
-     * Makes Quick Filter Bar appear
-     */
-    showQuickFilterBar(): void;
-    /**
-     * Hides Quick Filter bar
-     */
-    hideQuickFilterBar(): void;
-    /**
-     * Whether Quick Filter is available for use
-     */
-    isQuickFilterAvailable(): boolean;
-    /**
-     * Whether Quick Filter Form is currently visible
-     */
-    isQuickFilterVisible(): boolean;
 }