@adaptabletools/adaptable 14.0.0-canary.0 → 14.0.0-canary.1

package/src/Api/ChartingApi.d.ts

@@ -1,4 +1,5 @@
 import { ChartModel, ChartRef } from '@ag-grid-community/core';
+import { ChartDefinition } from '../types';
 /**
  * Provides run-time access to Charting Module and related State
  */
@@ -10,11 +11,24 @@ export interface ChartingApi {
     /**
      * Retrieves current user-generated Charts
      */
-    getCurrentCharts(): ChartModel[];
+    getCurrentChartModels(): ChartModel[];
     /**
      * Retrieves persisted Charts from Adaptable State
      */
     getPersistedCharts(): ChartModel[];
+    /**
+     * Retrieves all adaptable chart definitions
+     */
+    getChartDefinitions(): ChartDefinition[];
+    /**
+     * Retrieves chart definition by uuid
+     * @param uuid chart uuid
+     */
+    getChartDefinitionByUuid(uuid: string): ChartDefinition | undefined;
+    /**
+     * Retrieves AG Grid ChartRef for given chartId
+     */
+    getChartRef(chartId: string): ChartRef | undefined;
     /**
      * Saves all current Charts into Adaptable State
      */
@@ -23,4 +37,34 @@ export interface ChartingApi {
      * Displays all persisted Charts
      */
     showPersistedCharts(): ChartRef[];
+    /**
+     * Opens a Chart Definition
+     *
+     * @param chartDefinition chart definition
+     */
+    showChartDefinition(chartDefinition: ChartDefinition, container?: HTMLElement): ChartRef;
+    /**
+     * Open a Chart definition.
+     * If the chart is already opened a second chart is not opened.
+     *
+     * @param chartDefinition chart definition
+     */
+    showChartDefinitionOnce(chartDefinition: ChartDefinition, container?: HTMLElement): ChartRef;
+    /**
+     * Edit existing chart
+     * @param chartDefinition
+     */
+    editChartDefinition(chartDefinition: ChartDefinition): void;
+    /**
+     * Add new chart
+     * @param chartDefinition
+     */
+    addChartDefinition(chartDefinition: ChartDefinition): void;
+    /**
+     * TO BE REMOVED
+     */
+    /**
+     * @deprecated use `getChartDefinitions()` instead
+     */
+    getAllChartDefinitions(): ChartDefinition[];
 }

package/src/Api/ColumnApi.d.ts

@@ -1,19 +1,13 @@
-import { AdaptableColumn, AdaptableColumnDataType } from '../PredefinedConfig/Common/AdaptableColumn';
 import { Column, RowNode } from '@ag-grid-community/core';
-import { GridCell } from '../../types';
+import { AdaptableColumn, AdaptableColumnDataType, GridCell } from '../../types';
 /**
- * A large range of column-related functions in AdapTable
+ * Provides run-time access to Adaptable Column related features
  */
 export interface ColumnApi {
     /**
      * Returns all Columns
      * */
     getColumns(): AdaptableColumn[];
-    /**
-     * Retrieves 'ColumnType' property for a given Column
-     * @param columnId Column to use
-     */
-    getAgGridColumnType(columnId: string): string | string[];
     /**
      * Returns all visible Columns
      * */
@@ -34,6 +28,24 @@ export interface ColumnApi {
      * Returns all boolean Columns
      */
     getBooleanColumns(): AdaptableColumn[];
+    /**
+     * Returns all number-array, tuple-number-array or object-number-array columns
+     */
+    getArrayColumns(): AdaptableColumn[];
+    /**
+     * Returns all number-array columns
+     */
+    getNumberArrayColumns(): AdaptableColumn[];
+    /**
+     * Returns all tuple-number-array columns
+     * e.g. [[1, 2], [3, 4]]
+     */
+    getTupleNumberArrayColumns(): AdaptableColumn[];
+    /**
+     * Returns all object-number-array columns
+     * e.g. [{x : 1, y : 2}, {x : 3, y : 4}]
+     */
+    getObjectNumberArrayColumns(): AdaptableColumn[];
     /**
      * Returns all Sortable Columns
      */
@@ -41,7 +53,7 @@ export interface ColumnApi {
     /**
      * Returns all Sortable Columns
      */
-    getFiltrableColumns(): AdaptableColumn[];
+    getFilterableColumns(): AdaptableColumn[];
     /**
      * Returns all Groupable Columns
      */
@@ -53,7 +65,7 @@ export interface ColumnApi {
     /**
      * Returns all Aggregatable Columns
      */
-    getAggregetableColumns(): AdaptableColumn[];
+    getAggregatableColumns(): AdaptableColumn[];
     /**
      * Returns all Queryable Columns
      */
@@ -112,122 +124,197 @@ export interface ColumnApi {
      */
     showColumn(columnId: string): void;
     /**
-     * Is Column row-grouped
-     * @param columnId Column to check
+     * Checks if Column with given ColumnId is a row-group Column automatically generated by AG Grid
+     * @param columnId ColumnId to check
      */
     isAutoRowGroupColumn(columnId: string): boolean;
     /**
-     * Is Column pivoted
-     * @param columnId Column to check
+     * Checks if Column with given ColumnId is a pivot Column automatically generated by AG Grid
+     * @param columnId ColumnId to check
      */
     isAutoPivotColumn(columnId: string): boolean;
     /**
-     * Is Column a Calculated Column
-     * @param columnId Column to check
+     * Checks if Column with given ColumnId is a Calculated Column
+     * @param columnId ColumnId to check
      */
     isCalculatedColumn(columnId: string): boolean;
     /**
-     * Is Column a Free Text Column
-     * @param columnId Column to check
+     * Checks if Column with given ColumnId is a Free Text Column
+     * @param columnId ColumnId to check
      */
     isFreeTextColumn(columnId: string): boolean;
     /**
-     * Is Column an Action Column
-     * @param columnId Column to check
+     * Checks if Column with given ColumnId is an Action Column
+     * @param columnId ColumnId to check
      */
     isActionColumn(columnId: string): boolean;
     /**
-     * Does Column have a numeric style (e.g. Percent Bar or Gradient)
-     * @param columnId Column to check
+     * Checks if the Column with the given `columnId` has DataType Number
+     * @param columnId Column ID
      */
-    isFormatNumericStyleColumn(column: AdaptableColumn): boolean;
+    hasNumberDataType(columnId: string): boolean;
     /**
-     * Is Column Numeric
-     * @param columnId Column to check
+     * Checks if the Column with the given `columnId` has DataType Boolean
+     * @param columnId Column ID
      */
-    isNumericColumn(column: AdaptableColumn): boolean;
+    hasBooleanDataType(columnId: string): boolean;
     /**
-     * Is Column Boolean
-     * @param columnId Column to check
+     * Checks if the Column with the given `columnId` has DataType Date
+     * @param columnId Column ID
      */
-    isBooleanColumn(column: AdaptableColumn): boolean;
+    hasDateDataType(columnId: string): boolean;
     /**
-     * Is Column a Date
-     * @param columnId Column to check
+     * Checks if the Column with the given `columnId` has an Array-like DataType (`NumberArray`,`TupleNumberArray` or `ObjectNumberArray`)
+     * @param columnId Column ID
      */
-    isDateColumn(column: AdaptableColumn): boolean;
+    hasArrayDataType(columnId: string): boolean;
     /**
-     * Returns Data Type for a Column
+     * Returns Data Type for the Column with given ColumnId
      * @param columnId Column to check
      */
-    getColumnDataTypeFromColumnId(columnId: string): AdaptableColumnDataType | undefined;
+    getColumnDataTypeForColumnId(columnId: string): AdaptableColumnDataType | undefined;
     /**
-     * Retrieves Friendly Name for a given Column
-     * @param columnId ColumnId to check
-     * @param column Column to Lookup
-     */
-    getFriendlyNameFromColumn(columnId: string, column: AdaptableColumn): string;
-    /**
-     * Retrieves Friendly Name for a given ColumnId
+     * Retrieves Friendly Name of Column with given ColumnId
      * @param columnId ColumnId to lookup
      */
-    getFriendlyNameFromColumnId(columnId: string): string;
+    getFriendlyNameForColumnId(columnId: string): string;
     /**
      * Retrieves Friendly Names for given ColumnIds
      * @param columnIds ColumnIds to lookup
      */
-    getFriendlyNamesFromColumnIds(columnIds: string[]): string[];
+    getFriendlyNamesForColumnIds(columnIds: string[]): string[];
     /**
      * Retrieves Adaptable Column with given Friendly name
-     * @param columnName Friendly Name to looukup
+     * @param columnName Friendly Name to lookup
+     * @param logWarning Whether to log warning if Column missing
      */
-    getColumnFromFriendlyName(columnName: string): AdaptableColumn;
+    getColumnWithFriendlyName(columnName: string, logWarning?: boolean): AdaptableColumn;
+    /**
+     * Retrieves Adaptable Columns with given Friendly names
+     * @param friendlyNames Friendly Names to lookup
+     */
+    getColumnsWithFriendlyNames(friendlyNames: string[]): AdaptableColumn[];
     /**
      * Retrieves ColumnId for Column with given Friendly Name
      * @param friendlyName Friendly Name to Lookup
      */
-    getColumnIdFromFriendlyName(friendlyName: string): string;
+    getColumnIdForFriendlyName(friendlyName: string): string;
     /**
      * Retrieves ColumnIds for Columns with given Friendly Names
      * @param friendlyName Friendly Names to Lookup
      */
-    getColumnIdsFromFriendlyNames(friendlyNames: string[]): string[];
-    /**
-     * Retrieves Adaptable Columns with given Friendly names
-     * @param friendlyNames Friendly Names to looukup
-     */
-    getColumnsFromFriendlyNames(friendlyNames: string[]): AdaptableColumn[];
+    getColumnIdsForFriendlyNames(friendlyNames: string[]): string[];
     /**
      * Retrieves Adaptable Columns with given ColumnIds
-     * @param columnIds Column Ids to looukup
+     * @param columnIds Column Ids to lookup
      */
-    getColumnsFromIds(columnIds: string[]): AdaptableColumn[];
+    getColumnsWithColumnIds(columnIds: string[]): AdaptableColumn[];
     /**
      * Retrieves Adaptable Column with given ColumnId
      * @param columnId ColumnId to lookup
      * @param logWarning Whether to log warning if Column missing
      */
+    getColumnWithColumnId(columnId: string, logWarning?: boolean): AdaptableColumn | undefined;
+    /**
+     * Returns true if the given Column exists in the Grid
+     * @param columnId Column to check
+     */
+    isColumnInGrid(columnId: string): boolean;
+    /**
+     * Retrieves current Primary Key Column in AdapTable
+     */
+    getPrimaryKeyColumn(): AdaptableColumn;
+    /**
+     * Checks if the Column with given ColumnId is an ActionRowButton column
+     * @param columnId ColumnId to Check
+     */
+    isActionRowButtonColumn(columnId: string): boolean;
+    /**
+     * Returns the default Aggregation Function for a Column
+     * @param columnId Column to Check
+     */
+    getDefaultAggFunc(columnId: string): string;
+    /**
+     * TO BE REMOVED
+     */
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    getAgGridColumnType(columnId: string): string | string[];
+    /**
+     * @deprecated use `getFilterableColumns()` instead
+     */
+    getFiltrableColumns(): AdaptableColumn[];
+    /**
+     * @deprecated us `getAggregatableColumns` instead
+     */
+    getAggregetableColumns(): AdaptableColumn[];
+    /**
+     * @deprecated use `StyledColumnApi.hasPercentBarStyle()` or `StyledColumnApi.hasGradientStyle()` instead
+     */
+    isStyledNumericColumn(column: AdaptableColumn): boolean;
+    /**
+     * @deprecated use `hasNumberDataType()` instead
+     */
+    isNumericColumn(column: AdaptableColumn): boolean;
+    /**
+     * @deprecated use `hasBooleanDataType()` instead
+     */
+    isBooleanColumn(column: AdaptableColumn): boolean;
+    /**
+     * @deprecated use `hasDateDataType()` instead
+     */
+    isDateColumn(column: AdaptableColumn): boolean;
+    /**
+     * @deprecated use `getColumnDataTypeForColumnId()` instead
+     */
+    getColumnDataTypeFromColumnId(columnId: string): AdaptableColumnDataType | undefined;
+    /**
+     * @deprecated use `getFriendlyNameForColumnId()` instead
+     */
+    getFriendlyNameFromColumnId(columnId: string): string;
+    /**
+     * @deprecated use `getFriendlyNameForColumnId()` instead
+     */
+    getFriendlyNameFromColumn(columnId: string, column: AdaptableColumn): string;
+    /**
+     * @deprecated use `getFriendlyNamesForColumnIds()` instead
+     */
+    getFriendlyNamesFromColumnIds(columnIds: string[]): string[];
+    /***
+     * @deprecated use `getColumnWithFriendlyName()` instead
+     */
+    getColumnFromFriendlyName(columnName: string): AdaptableColumn;
+    /**
+     * @deprecated use `getColumnIdForFriendlyName()` instead
+     */
+    getColumnIdFromFriendlyName(friendlyName: string): string;
+    /**
+     * @deprecated use `getColumnIdsForFriendlyNames()` instead
+     */
+    getColumnIdsFromFriendlyNames(friendlyNames: string[]): string[];
+    /**
+     * @deprecated use `getColumnsWithFriendlyNames()` instead
+     */
+    getColumnsFromFriendlyNames(friendlyNames: string[]): AdaptableColumn[];
+    /**
+     * @deprecated use `getColumnWithColumnId()` instead
+     */
     getColumnFromId(columnId: string, logWarning?: boolean): AdaptableColumn | undefined;
     /**
-     * Returns the ColumnId if regular, otherwise referenced columns if Calculated Column
-     * @param columnId ColumnId to lookup
-     * @param logWarning Whether to log warning if Column missing
+     * @deprecated use `getColumnsWithColumnIds()` instead
      */
-    getColumnIdsFromId(columnId: string, logWarning?: boolean): string[] | undefined;
+    getColumnsFromIds(columnIds: string[]): AdaptableColumn[];
     /**
-     * Returns true if the given Column exists in the Grid
-     * @param columnId Column to check
+     * @deprecated use `isColumnInGrid()` instead
      */
     doesColumnExist(columnId: string): boolean;
     /**
-     * Gets all distinct display values in the Column
-     * @param columnId Column to check
+     * @deprecated internal method, will be removed in next major release
      */
     getDistinctDisplayValuesForColumn(columnId: string): any[];
     /**
-     * Gets all distinct display values in for filter column, used for Floating Filter and Column Header filter
-     * @param columnId Column to check
-     * @param columnFilter Current applied filter
+     * @deprecated internal method, will be removed in next major release
      */
     getDistinctFilterDisplayValuesForColumn(columnId: string, filter: string, showFilteredRowsOnly: boolean): Promise<{
         values: {
@@ -237,82 +324,51 @@ export interface ColumnApi {
         suppressClientSideFilter: boolean;
     }>;
     /**
-     * Gets all distinct column display values in for custom sort.
-     * @param columnId Column to check
+     * @deprecated internal method, will be removed in next major release
      */
     getDistinctCustomSortDisplayValuesForColumn(columnId: string): Promise<any[]>;
     /**
-     * Gets all distinct column display values for bulk update.
-     * @param columnId Column to check
-     * @param selectedGridCells Selected grid cells
+     * @deprecated internal method, will be removed in next major release
      */
     getDistinctBulkUpdateDisplayValuesForColumn(columnId: string, selectedGridCells: GridCell[]): Promise<any[]>;
     /**
-     * Gets all distinct visible display values in the Column
-     * @param columnId Column to check
+     * @deprecated internal method, will be removed in next major release
      */
     getDistinctVisibleDisplayValuesForColumn(columnId: string): any[];
     /**
-     * Gets all distinct raw values in Column
-     * @param columnId Column to check
-     * @param skipRowNode optional RowNode which should be skipped when collecting the distinct rawValues
+     * @deprecated internal method, will be removed in next major release
      */
     getDistinctRawValuesForColumn(columnId: string, skipRowNode?: RowNode): any[];
     /**
-     * Gets all distinct visible raw values in the Column
-     * @param columnId Column to check
+     * @deprecated internal method, will be removed in next major release
      */
-    getDistinctVisibleRawValuesForColumn(columnId: string): any[];
+    getUnsortedDistinctRawValuesForColumn(columnId: string, skipRowNode?: RowNode): any[];
     /**
-     * Retrieves current Primary Key Column in AdapTable
+     * @deprecated internal method, will be removed in next major release
      */
-    getPrimaryKeyColumn(): AdaptableColumn;
+    getDistinctVisibleRawValuesForColumn(columnId: string): any[];
     /**
-     * Retrieves a list providing the Friendly Name / Caption for all columns
+     * @deprecated internal method, will be removed in next major release
      */
     getAllColumnFriendlyNames(): string[];
     /**
-     * Retrieves AG Grid's field property for the column
-     * @param columnId columnId to look up
+     * @deprecated internal method, will be removed in next major release
      */
     getAgGridColumnFieldForAdaptableColumn(columnId: string): string;
     /**
-     * Retrieves AG Grid's column for an Adaptable column
-     * @param columnId columnId to look up
+     * @deprecated internal method, will be removed in next major release
      */
     getAgGridColumnForAdaptableColumn(columnId: string): Column;
     /**
-     * Does Column use AdapTable's Filter Form
-     * @param columnId Column to Check
+     * @deprecated internal method, will be removed in next major release
      */
     usesAdaptableFilterForm(columnId: string): boolean;
     /**
-     * Does Column use AdapTable's Quick Filter
-     * @param columnId Column to Check
+     * @deprecated internal method, will be removed in next major release
      */
     usesAdaptableQuickFilter(columnId: string): boolean;
     /**
-     * Checks if a column is referenced in a given Expression
-     * @param columnId Column to Check
-     * @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;
-    /**
-     * Returns the default Aggregation Function for a Column
-     * @param columnId Column to Check
-     */
-    getDefaultAggFunc(columnId: string): string;
-    /**
-     * Returns the `types` property for a given Column
-     * @param columnId Column to Check
+     * @deprecated internal method, will be removed in next major release
      */
     getTypesForColumn(columnId: string): string | string[];
-    getMinValueForNumericColumn(column: AdaptableColumn): number | undefined;
-    getMaxValueForNumericColumn(column: AdaptableColumn): number | undefined;
 }

package/src/Api/ConfigApi.d.ts

@@ -6,7 +6,6 @@ import { FormatColumnState } from '../PredefinedConfig/FormatColumnState';
 import { ExportState } from '../PredefinedConfig/ExportState';
 import { DashboardState } from '../PredefinedConfig/DashboardState';
 import { CustomSortState } from '../PredefinedConfig/CustomSortState';
-import { ConditionalStyleState } from '../PredefinedConfig/ConditionalStyleState';
 import { CalculatedColumnState } from '../PredefinedConfig/CalculatedColumnState';
 import { AlertState } from '../PredefinedConfig/AlertState';
 import { ConfigState } from '../PredefinedConfig/ConfigState';
@@ -94,7 +93,7 @@ export interface ConfigApi {
      * @param stateKey section of State to return
      * @param returnJson whether to return section as JSON or object
      */
-    getUserStateByStateKey(stateKey: AdaptableStateKey, returnJson: boolean): ConfigState | string;
+    getUserStateByStateKey(stateKey: AdaptableStateKey, returnJson?: boolean): ConfigState | string;
     /**
      * Adds '1' to current revision number of State element
      * @param stateKey Adaptable State Key to update
@@ -104,87 +103,82 @@ export interface ConfigApi {
      * Returns Alert section of Adaptable State
      * @param returnJson return as JSON rather than object
      */
-    getAlertState(returnJson: boolean): AlertState;
+    getAlertState(returnJson?: boolean): AlertState;
     /**
      * Returns Application section of Adaptable State
      * @param returnJson return as JSON rather than object
      */
-    getApplicationState(returnJson: boolean): ApplicationState;
+    getApplicationState(returnJson?: boolean): ApplicationState;
     /**
      * Returns Calculated Column section of Adaptable State
      * @param returnJson return as JSON rather than object
      */
-    getCalculatedColumnState(returnJson: boolean): CalculatedColumnState;
-    /**
-     * Returns Conditional Style section of Adaptable State
-     * @param returnJson return as JSON rather than object
-     */
-    getConditionalStyleState(returnJson: boolean): ConditionalStyleState;
+    getCalculatedColumnState(returnJson?: boolean): CalculatedColumnState;
     /**
      * Returns Custom Sort section of Adaptable State
      * @param returnJson return as JSON rather than object
      */
-    getCustomSortState(returnJson: boolean): CustomSortState;
+    getCustomSortState(returnJson?: boolean): CustomSortState;
     /**
      * Returns Dashboard section of Adaptable State
      * @param returnJson return as JSON rather than object
      */
-    getDashboardState(returnJson: boolean): DashboardState;
+    getDashboardState(returnJson?: boolean): DashboardState;
     /**
      * Returns Export section of Adaptable State
      * @param returnJson return as JSON rather than object
      */
-    getExportState(returnJson: boolean): ExportState;
+    getExportState(returnJson?: boolean): ExportState;
     /**
-     * Returns Formt Column section of Adaptable State
+     * Returns Format Column section of Adaptable State
      * @param returnJson return as JSON rather than object
      */
-    getFormatColumnState(returnJson: boolean): FormatColumnState;
+    getFormatColumnState(returnJson?: boolean): FormatColumnState;
     /**
      * Returns FreeText Column section of Adaptable State
      * @param returnJson return as JSON rather than object
      */
-    getFreeTextColumnState(returnJson: boolean): FreeTextColumnState;
+    getFreeTextColumnState(returnJson?: boolean): FreeTextColumnState;
     /**
      * Returns Layout section of Adaptable State
      * @param returnJson return as JSON rather than object
      */
-    getLayoutState(returnJson: boolean): LayoutState;
+    getLayoutState(returnJson?: boolean): LayoutState;
     /**
      * Returns Plus Minus section of Adaptable State
      * @param returnJson return as JSON rather than object
      */
-    getPlusMinusState(returnJson: boolean): PlusMinusState;
+    getPlusMinusState(returnJson?: boolean): PlusMinusState;
     /**
      * Returns Query section of Adaptable State
      * @param returnJson return as JSON rather than object
      */
-    getQueryState(returnJson: boolean): QueryState;
+    getQueryState(returnJson?: boolean): QueryState;
     /**
      * Returns Quick Search section of Adaptable State
      * @param returnJson return as JSON rather than object
      */
-    getQuickSearchState(returnJson: boolean): QuickSearchState;
+    getQuickSearchState(returnJson?: boolean): QuickSearchState;
     /**
      * Returns Schedule section of Adaptable State
      * @param returnJson return as JSON rather than object
      */
-    getScheduleState(returnJson: boolean): ScheduleState;
+    getScheduleState(returnJson?: boolean): ScheduleState;
     /**
      * Returns Shortcut section of Adaptable State
      * @param returnJson return as JSON rather than object
      */
-    getShortcutState(returnJson: boolean): ShortcutState;
+    getShortcutState(returnJson?: boolean): ShortcutState;
     /**
      * Returns Theme section of Adaptable State
      * @param returnJson return as JSON rather than object
      */
-    getThemeState(returnJson: boolean): ThemeState;
+    getThemeState(returnJson?: boolean): ThemeState;
     /**
      * Returns Tool Panel section of Adaptable State
      * @param returnJson return as JSON rather than object
      */
-    getToolPanelState(returnJson: boolean): ToolPanelState;
+    getToolPanelState(returnJson?: boolean): ToolPanelState;
     /**
      * Sent by each Module when it is Ready
      * @param module Module which is Ready

package/src/Api/CustomSortApi.d.ts

@@ -10,12 +10,12 @@ export interface CustomSortApi {
     /**
      * Retrieves all Custom Sorts in Adaptable State
      */
-    getAllCustomSort(config?: {
+    getCustomSorts(config?: {
         includeLayoutNotAssociatedObjects?: boolean;
     }): CustomSort[];
     /**
-     * Retrieves Custom Sort by id
-     * @param id Custom Sort id
+     * Retrieves Custom Sort by the technical ID (from `CustomSortState`)
+     * @param id Custom Sort technical id
      * @returns sort column
      */
     getCustomSortById(id: CustomSort['Uuid']): CustomSort;
@@ -23,18 +23,22 @@ export interface CustomSortApi {
      * Retrieves all Custom Sorts that are active (not-suspended) in Adaptable State
      * @returns sort columns
      */
-    getAllActiveCustomSort(): CustomSort[];
+    getActiveCustomSorts(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): CustomSort[];
     /**
      * Retrieves all Custom Sorts that are suspended in Adaptable State
      * @returns sort columns
      */
-    getAllSuspendedCustomSort(): CustomSort[];
+    getSuspendedCustomSorts(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): CustomSort[];
     /**
-     * Retrieves Custom Sort from Adaptable State for given ColumnId
+     * Retrieves Custom Sort from Adaptable State for Column with given ColumnId
      * @param columnId Id of Column to retrieve Custom Sort for
      * @returns sort column
      */
-    getCustomSortByColumn(columnId: string): CustomSort;
+    getCustomSortForColumn(columnId: string): CustomSort | undefined;
     /**
      * Adds a Custom Sort to Custom Sort collection in Adaptable State
      * @param customSort Custom Sort to add
@@ -75,5 +79,30 @@ export interface CustomSortApi {
     /**
      * Opens Settings Panel with Custom Sort section selected and visible
      */
+    openCustomSortSettingsPanel(): void;
+    /**
+     * TO BE REMOVED
+     */
+    /**
+     * @deprecated use `getCustomSorts` instead
+     */
+    getAllCustomSort(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): CustomSort[];
+    /**
+     * @deprecated use `getActiveCustomSorts()` instead
+     */
+    getAllActiveCustomSort(): CustomSort[];
+    /**
+     * @deprecated use `getSuspendedCustomSorts()` instead
+     */
+    getAllSuspendedCustomSort(): CustomSort[];
+    /**
+     * @deprecated use `getCustomSortForColumn` instead
+     */
+    getCustomSortByColumn(columnId: string): CustomSort;
+    /**
+     * @deprecated use `openCustomSortSettingsPanel` instead
+     */
     showCustomSortPopup(): void;
 }