@adaptabletools/adaptable 13.1.1 → 14.0.0-canary.1

package/src/Api/DataSetApi.d.ts

@@ -7,7 +7,7 @@ export interface DataSetApi {
      * Retrieves the Data Sets from General Options
      * @returns data Sets
      */
-    getAllDataSets(): DataSet[];
+    getDataSets(): DataSet[];
     /**
      * Retrieves the currently applied Data Set
      * @returns data Set
@@ -31,10 +31,20 @@ export interface DataSetApi {
     /**
      * Opens Settings Panel with Data Set section selected and visible
      */
+    openDataSetSettingsPanel(): void;
+    /**
+     * TO BE REMOVED
+     */
+    /**
+     * @deprecated use `getDataSets()` instead
+     */
+    getAllDataSets(): DataSet[];
+    /**
+     * @deprecated use `openDataSetSettingsPanel()` instead
+     */
     showDataSetPopup(): void;
     /**
-     * Fires the DataSet Selected Event
-     * @param dataSet Data Set which has been selected
+     * @deprecated internal method, will be removed in next major release
      */
     fireDataSetSelectedEvent(dataSet: DataSet): void;
 }

package/src/Api/EventApi.d.ts

@@ -4,11 +4,11 @@ import { AdaptableFDC3EventInfo, SelectionChangedInfo, LiveDataChangedInfo, Dash
  */
 export interface EventApi {
     /**
-     * @deprecated - use FilterApplied, QueryRun or GridSorted
+     * @deprecated - use `FilterApplied`, `QueryRun` or `GridSorted` instead
      */
     on(eventName: 'SearchChanged', callback: (searchChangedInfo: SearchChangedInfo) => void): VoidFunction;
     /**
-     *@deprecated - use FilterApplied, QueryRun or GridSorted
+     *@deprecated - use `FilterApplied`, `QueryRun` or `GridSorted` instead
      */
     off(eventName: 'SearchChanged', callback: (searchChangedInfo: SearchChangedInfo) => void): void;
     /**

package/src/Api/ExportApi.d.ts

@@ -43,14 +43,14 @@ export interface ExportApi {
      */
     getCurrentReportName(): string;
     /**
-     * Retrieves all Reports in State - both System and User-created Reports
+     * Retrieves all Reports in State - System, Server and User-created Reports
      * @returns reports
      */
-    getAllReports(): Report[];
+    getReports(): Report[];
     /**
-     * Returns any Custom Reports that have been provided to Export Options
+     * Returns all Server Reports that have been provided to Export Options
      */
-    getAllServerReports(): ServerReport[] | undefined;
+    getServerReports(): ServerReport[];
     /**
      * Retrieves System Reports section of Export State
      */
@@ -99,7 +99,7 @@ export interface ExportApi {
     /**
      * Opens Settings Panel with Export section selected and visible
      */
-    showExportPopup(): void;
+    openExportSettingsPanel(): void;
     /**
      * Edits an existing report
      * @param report report to edit
@@ -116,7 +116,7 @@ export interface ExportApi {
      * Retrieves all Custom Destinations from Export Options
      * @returns custom destinations
      */
-    getAllCustomDestination(): CustomDestination[];
+    getCustomDestinations(): CustomDestination[];
     /**
      * If the given destination is a Custom one
      * @param destination destination to check
@@ -127,18 +127,12 @@ export interface ExportApi {
      * @param destination Custom Destination for which to get Form Def
      */
     getExportDestinationForm(destinationName: string): AdaptableForm<ExportFormContext> | undefined;
-    /**
-     * Whether given data change affects given report
-     * @param cellDataChangedInfo data change to check
-     * @param report report to check
-     */
-    isDataChangeInReport(cellDataChangedInfo: CellDataChangedInfo, report: Report): boolean;
     /**
      * Exports data currently in grid to Excel as What-You-See-Is-What-You-Get
      */
     exportVisualDataToExcel(): void;
     /**
-     * Whether a Report is a Custom Report
+     * Whether the given Report is a user-generated (server) one
      * @param report Report to Check
      */
     isServerReport(report: Report): boolean;
@@ -152,4 +146,27 @@ export interface ExportApi {
      * @param reportName - the name of the report
      */
     getReportDataForReport(reportName: string): ReportData | undefined;
+    /**
+     * TO BE REMOVED
+     */
+    /**
+     * @deprecated use `getReports()` instead
+     */
+    getAllReports(): Report[];
+    /**
+     * @deprecated use `getServerReports()` instead
+     */
+    getAllServerReports(): ServerReport[] | undefined;
+    /**
+     * @deprecated use `showExportSettingsPanel()` instead
+     */
+    showExportPopup(): void;
+    /**
+     * @deprecated use `getCustomDestinations()` instead
+     */
+    getAllCustomDestination(): CustomDestination[];
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    isDataChangeInReport(cellDataChangedInfo: CellDataChangedInfo, report: Report): boolean;
 }

package/src/Api/FilterApi.d.ts

@@ -1,18 +1,12 @@
 import { AdaptableColumn, ColumnFilter, GridCell } from '../types';
 import * as Redux from 'redux';
-import { ColumnFilterDef, AdaptablePredicateDef } from '../PredefinedConfig/Common/AdaptablePredicate';
+import { AdaptablePredicateDef, ColumnFilterDef } from '../PredefinedConfig/Common/AdaptablePredicate';
 import { RowNode } from '@ag-grid-community/core';
 import { LayoutColumnFilterAction } from '../Redux/ActionsReducers/LayoutRedux';
 /**
  * Provides run-time access to Filter section of Adaptable State.
  */
 export interface FilterApi {
-    /**
-     * Returns Predicate Definition for given Column and Quick Filter shortcut
-     * @param shortcut Quick Filter shortcut to lookup
-     * @param column Adaptable Column being Filtered
-     */
-    findPredicateDefByShortcut(shortcut: string, column: AdaptableColumn): AdaptablePredicateDef;
     /**
      * Gets all Filter Predicates available for a given Column
      * @param column Column to lookup
@@ -45,7 +39,7 @@ export interface FilterApi {
      */
     getColumnFilters(): ColumnFilter[];
     /**
-     * Retrieves all active/no-suspedned Column Filters in currently applied Layout
+     * Retrieves all active/no-suspended Column Filters in currently applied Layout
      * @returns column filters
      */
     getActiveColumnFilters(): ColumnFilter[];
@@ -53,20 +47,20 @@ export interface FilterApi {
      * Retrieves the Column Filter for the specified Column.
      * @param columnId Column ID to lookup
      */
-    getColumnFilter(columnId: string): ColumnFilter | undefined;
+    getColumnFilterForColumn(columnId: string): ColumnFilter | undefined;
     /**
      * Retrieves all Column Filters in a given Layout
      * @param layoutName Layout to retrieve Column Filters for
      */
     getColumnFiltersForLayout(layoutName: string): ColumnFilter[];
     /**
-     * Sets Column Filters - will replace filters for existing column and leave other column filters in place
+     * Sets Column Filters in the current Layout - will replace filters for existing column and leave other column filters in place
      * @param columnFilters Column Filters to set
      * @returns column filters
      */
-    setColumnFilter(columnFilters: ColumnFilter[]): ColumnFilter[] | null;
+    setColumnFilters(columnFilters: ColumnFilter[]): ColumnFilter[] | null;
     /**
-     * Clears given Column Filter
+     * Clears given Column Filter in the current Layout
      * @param columnFilter Column Filter to clear
      */
     clearColumnFilter(columnFilter: ColumnFilter): void;
@@ -74,12 +68,12 @@ export interface FilterApi {
      * Clears Column Filter for given Column
      * @param columnId Column for which Column Filter should be cleared
      */
-    clearColumnFilterByColumn(columnId: string): void;
+    clearColumnFilterForColumn(columnId: string): void;
     /**
      * Clears Column Filters for given set of Columns
-     * @param columns Columns for which Column Filte should be cleared
+     * @param columns Columns for which Column Filter should be cleared
      */
-    clearColumnFilterByColumns(columns: string[]): void;
+    clearColumnFiltersForColumns(columns: string[]): void;
     /**
      * Clears all Column Filters in the Current Layout
      */
@@ -88,79 +82,97 @@ export interface FilterApi {
      * Clears existing Column Filters and sets new ones
      * @param columnFilters Column Filters to set
      */
-    clearAndSetColumnFilter(columnFilters: ColumnFilter[]): void;
+    clearAndSetColumnFilters(columnFilters: ColumnFilter[]): void;
     /**
-     * Retrieves all Column Filters for given Column
-     * @param columnId column to retrieve Column Filters for
-     * @returns column filters
+     * Checks if a filter is active or applied.
+     * It is applied when:
+     * - filter predicate does not have inputs
+     * - filter predicate has inputs with values
      */
-    getAllColumnFilterForColumn(columnId: string): ColumnFilter[];
+    isFilterActive(columnFilter: ColumnFilter): boolean;
     /**
-     * Creates an Equality Filter based on given Grid Cells
-     * @param gridCells cells to create Filter for
+     * Retrieves the Column Filter definitions for all available Column Filters
      */
-    createValuesColumnFilterForCells(gridCells: GridCell[]): ColumnFilter | null;
+    getColumnFilterDefs(): ColumnFilterDef[];
     /**
-     *  Creates an Equality Filter based on given Grid Cell
-     * @param gridCell cell to create Filter for
+     * Suspends a Column Filter
+     * @param columnFilter Column Filter to Suspend
      */
-    createEqualityColumnFilterForCell(gridCell: GridCell): ColumnFilter | null;
+    suspendColumnFilter(columnFilter: ColumnFilter): void;
     /**
-     * Retrieves description of given Column Filter
-     * @param columnFilter Column Filter to use
+     * Unsuspend a Column Filter
+     * @param columnFilter Column Filter to UnSuspend
      */
-    columnFilterToString(columnFilter: ColumnFilter): string;
+    unSuspendColumnFilter(columnFilter: ColumnFilter): void;
     /**
-     * Retrieves descriptions of given Column Filters
-     * @param columnFilters Column Filters to use
+     * Suspends all Column Filters
      */
-    columnFiltersToString(columnFilters: ColumnFilter[]): string;
+    suspendAllColumnFilters(): void;
     /**
-     * Calls AdapTableQL to evaluate Filter for given Row
-     * @param columnFilter Column Filter to use
-     * @param node Row Node to evaluate
+     * Unsuspend all Column Filters
      */
-    evaluateColumnFilter(columnFilter: ColumnFilter, node: RowNode): boolean;
+    unSuspendAllColumnFilters(): void;
     /**
-     * Checks if a filter is active or applied.
-     * It is applied when:
-     * - filter predicate does not have inputs
-     * - filter predicate has inputs with values
+     * TO BE REMOVED
      */
-    isFilterActive(columnFilter: ColumnFilter): boolean;
-    getColumnFilterDefs(): ColumnFilterDef[];
     /**
-     * Checks if the filter action should trigger grid filtering.
-     *
-     * @param action Filtering Action
+     * @deprecated internal method, will be removed in next major release
      */
-    shouldNewColumnFilterTriggerGridFiltering(action: LayoutColumnFilterAction | Redux.Action): boolean;
+    findPredicateDefByShortcut(shortcut: string, column: AdaptableColumn): AdaptablePredicateDef;
     /**
-     * Fires Filter Applied Event - typically used to enable filtering on the server
+     * @deprecated use `clearColumnFilterForColumn()` instead
      */
-    fireFilterAppliedEvent(): void;
+    clearColumnFilterByColumn(columnId: string): void;
     /**
-     * Compares to sets of Column Filters to see if they are identical
-     * @param filters1
-     * @param filters2
+     * @deprecated use `clearColumnFiltersForColumns()` instead
      */
-    areColumnFiltersDifferent(filters1: ColumnFilter[], filters2: ColumnFilter[]): boolean;
+    clearColumnFilterByColumns(columns: string[]): void;
     /**
-     * Suspends a Column Filter
-     * @param columnFilter Column Filter to Suspend
+     * @deprecated use `setColumnFilters()` instead
      */
-    suspendColumnFilter(columnFilter: ColumnFilter): void;
+    setColumnFilter(columnFilters: ColumnFilter[]): ColumnFilter[] | null;
     /**
-     * Unsuspends a Column Filter
-     * @param columnFilter Column Filter to UnSuspend
+     * @deprecated use `clearAndSetColumnFilters()` instead
      */
-    unSuspendColumnFilter(columnFilter: ColumnFilter): void;
+    clearAndSetColumnFilter(columnFilters: ColumnFilter[]): void;
     /**
-     * Suspends all Column Filters
+     * @deprecated use `getColumnFilterForColumn()` instead
      */
-    suspendAllColumnFilters(): void;
+    getAllColumnFilterForColumn(columnId: string): ColumnFilter[];
     /**
-     * Unsuspends all Column Filters
+     * @deprecated use `getColumnFilterForColumn()` instead
      */
-    unSuspendAllColumnFilters(): void;
+    getColumnFilter(columnId: string): ColumnFilter | undefined;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    createValuesColumnFilterForCells(gridCells: GridCell[]): ColumnFilter | null;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    createEqualityColumnFilterForCell(gridCell: GridCell): ColumnFilter | null;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    columnFilterToString(columnFilter: ColumnFilter): string;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    columnFiltersToString(columnFilters: ColumnFilter[]): string;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    evaluateColumnFilter(columnFilter: ColumnFilter, node: RowNode): boolean;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    shouldNewColumnFilterTriggerGridFiltering(action: LayoutColumnFilterAction | Redux.Action): boolean;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    fireFilterAppliedEvent(): void;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    areColumnFiltersDifferent(filters1: ColumnFilter[], filters2: ColumnFilter[]): boolean;
 }

package/src/Api/FlashingCellApi.d.ts

@@ -2,6 +2,7 @@ import { AdaptableFlashingCell } from '../PredefinedConfig/Common/AdaptableFlash
 import { AdaptablePredicateDef } from '../PredefinedConfig/Common/AdaptablePredicate';
 import { AdaptableScope } from '../PredefinedConfig/Common/AdaptableScope';
 import { FlashingCellDefinition, FlashingCellState } from '../PredefinedConfig/FlashingCellState';
+import { AdaptableObjectLookupCriteria } from '../PredefinedConfig/Common/AdaptableObject';
 /**
  * Provides run-time access to Flashing Cell functionality and associated State
  */
@@ -18,7 +19,7 @@ export interface FlashingCellApi {
         includeLayoutNotAssociatedObjects?: boolean;
     }): FlashingCellDefinition[];
     /**
-     * Retrieves Flashing cell Definition By Id
+     * Retrieves Flashing Cell Definition by the technical ID (from `FlashingCellState`)
      * @param id Flashing Cell Definition Id
      * @returns flashing cell definition
      */
@@ -29,12 +30,12 @@ export interface FlashingCellApi {
      */
     getActiveFlashingCellDefinitions(): FlashingCellDefinition[];
     /**
-     * Returns where a Flashing cell Definition will flash a single cell or a whole row
+     * Returns `FlashTarget` of the given Flashing Cell Definition
      * @param flashingCellDefinition Flashing cell Definition to check
      */
     getFlashingCellFlashTarget(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition['FlashTarget'];
     /**
-     * Displays a Flashing Cell Definition
+     * Evaluates the given Flashing Cell Definition and flashes the correspondent cells/rows
      * @param flashingCellToShow Flashing Cell Definition to show
      */
     showFlashingCell(flashingCellToShow: AdaptableFlashingCell): void;
@@ -60,11 +61,6 @@ export interface FlashingCellApi {
      * @param flashingCellDefinitions Flashing Cell Definitions to Add to State
      */
     setFlashingCellDefinitions(flashingCellDefinitions: FlashingCellDefinition[]): void;
-    /**
-     * Merges a Flashing Cell Definition with default values
-     * @param flashingCellDefinition Flashing Cell Definition to Merge
-     */
-    mergeFlashingCellDefinitionWithDefaults(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;
     /**
      * Adds provided Flashing cell Definitions
      * @param flashingCellDefinitions Flashing Cell Definition to Add
@@ -91,9 +87,29 @@ export interface FlashingCellApi {
     /**
      * Clears all Cells and Rows which have been flashed (primarily used if duration is 'Always')
      */
+    clearAllFlashingCells(): void;
+    /**
+     * Is there any cells/rows currently being flashed
+     */
+    isAnyFlashingCellActive(): boolean;
+    /**
+     * Find all Flashing Cell Definitions which match the given criteria
+     * @param flashingCellLookupCriteria lookup criteria
+     */
+    findFlashingCellDefinitions(flashingCellLookupCriteria: AdaptableObjectLookupCriteria): FlashingCellDefinition[];
+    /**
+     *  TO BE REMOVED
+     */
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    mergeFlashingCellDefinitionWithDefaults(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;
+    /**
+     * @deprecated use `clearAllFlashingCells()` instead
+     */
     clearGridFlashing(): void;
     /**
-     * Are there any cells/rows currently being flashed
+     * @deprecated use `isAnyFlashingCellActive()` instead
      */
     areCellsCurrentlyFlashed(): boolean;
 }