@adaptabletools/adaptable-cjs 22.0.0-canary.0 → 22.0.0-canary.10

package/src/AdaptableState/FormatColumnState.d.ts

@@ -3,11 +3,11 @@ import { AdaptableStyle } from './Common/AdaptableStyle';
 import { AdaptableFormat } from './Common/AdaptableFormat';
 import { ColumnScope } from './Common/ColumnScope';
 import { RowScope } from './Common/RowScope';
-import { SuspendableObject } from './Common/SuspendableObject';
 import { XOR } from '../Utilities/Extensions/TypeExtensions';
 import { TypeHint } from './Common/Types';
 import { AdaptableBooleanQuery, LayoutExtendedConfig } from '../types';
 import { AdaptableColumnPredicate } from './Common/AdaptablePredicate';
+import { SuspendableObject } from '../types';
 /**
  * Adaptable State Section for Format Column Module
  */
@@ -21,6 +21,10 @@ export interface FormatColumnState extends BaseState {
  * Object used in Format Column function
  */
 export interface FormatColumn extends SuspendableObject {
+    /**
+     * Name of the Format Column definition
+     */
+    Name: string;
     /**
      * Where Format will be applied: whole Row, some Columns, or Columns of DataType
      */
@@ -43,10 +47,6 @@ export interface FormatColumn extends SuspendableObject {
      * Display Format to apply to Column can be Numeric, String or Date
      */
     DisplayFormat?: AdaptableFormat;
-    /**
-     * Align cells 'Left' or 'Right' or 'Center'
-     */
-    CellAlignment?: CellAlignment;
     /**
      * Which types of Rows to apply format (data, grouped, summary, total)
      */
@@ -65,10 +65,6 @@ export type FormatColumnTarget = 'cell' | 'columnHeader';
  * Defines Column Group Scope
  */
 export type ColumnGroupScope = 'Expanded' | 'Collapsed' | 'Both';
-/**
- * Behaviour for aligning Cell contents
- */
-export type CellAlignment = 'Left' | 'Right' | 'Center';
 /**
  * The Format Column Rule - can be either a Predicate or a BooleanExpression
  */

package/src/AdaptableState/InitialState.d.ts

@@ -19,6 +19,7 @@ import { StatusBarState } from './StatusBarState';
 import { StyledColumnState } from './StyledColumnState';
 import { ThemeState } from './ThemeState';
 import { ToolPanelState } from './ToolPanelState';
+import { UserInterfaceState } from './UserInterfaceState';
 /**
  * The initial state of Adaptable which is populated at design-time and used to create the Adaptable State - must include at least one Layout.
  */
@@ -107,6 +108,10 @@ export interface InitialState {
      * Sets order & visibility of Tool Panel controls in AdapTable ToolPanel (on right of grid)
      */
     ToolPanel?: ToolPanelState;
+    /**
+     * Controls the visibility of AdapTable UI elements (Dashboard, Tool Panel, Status Bar, Menus etc.)
+     */
+    UserInterface?: UserInterfaceState;
 }
 /**
  * Deprecated initial state object (now replaced by InitialState)
@@ -134,7 +139,7 @@ export interface PredefinedConfig {
      */
     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
+     * Large series of properties to give users full control over the look and feel of the *Dashboard* - the section (typically above the grid) with toolbars and buttons
      */
     Dashboard?: DashboardState;
     /**
@@ -197,4 +202,8 @@ export interface PredefinedConfig {
      * Sets the order and visibility of the Tool Panel controls in the AdapTable ToolPanel (on right of grid)
      */
     ToolPanel?: ToolPanelState;
+    /**
+     * Controls the visibility of AdapTable UI elements (Dashboard, Tool Panel, Status Bar, Menus etc.)
+     */
+    UserInterface?: UserInterfaceState;
 }

package/src/AdaptableState/InternalState.d.ts

@@ -15,6 +15,7 @@ import { SelectedCellInfo } from './Selection/SelectedCellInfo';
 import { SelectedRowInfo } from './Selection/SelectedRowInfo';
 import { AdaptableMenuItem } from './Common/Menu';
 import { CellHighlightInfo } from './Common/CellHighlightInfo';
+import { ColumnHighlightInfo } from './Common/ColumnHighlightInfo';
 import { RowHighlightInfo } from './Common/RowHighlightInfo';
 export type { IPushPullReport, IPushPullDomain };
 export type { OpenFinReport };
@@ -31,6 +32,7 @@ export interface InternalState extends IPushPullState, OpenFinState {
     SelectedCellInfo: SelectedCellInfo;
     SelectedRowInfo: SelectedRowInfo;
     CellHighlightInfo: CellHighlightInfo[];
+    ColumnHighlightInfo: ColumnHighlightInfo[];
     RowHighlightInfo: RowHighlightInfo[];
     SettingsPanelModuleEntries: AdaptableMenuItem[];
     AdaptableAlerts: AdaptableAlert[];

package/src/AdaptableState/LayoutState.d.ts

@@ -1,8 +1,8 @@
 import { BaseState } from './BaseState';
-import { AdaptableObject } from './Common/AdaptableObject';
+import { AdaptableObject } from '../types';
 import { ColumnSort } from './Common/ColumnSort';
 import { ColumnFilter, GridFilter } from '../types';
-import { TableAggregationColumns, PivotAggregationColumns } from './Common/AggregationColumns';
+import { PivotAggregationColumns, TableAggregationColumns } from './Common/AggregationColumns';
 import { RowSummary } from './Common/RowSummary';
 import { NonEmptyArray } from '../Utilities/Extensions/ArrayExtensions';
 import { XOR } from '../Utilities/Extensions/TypeExtensions';
@@ -32,7 +32,7 @@ export interface LayoutState extends BaseState {
  */
 export interface LayoutBase extends AdaptableObject {
     /**
-     * Name of Layout as will appear in Layout toolbar and tool panel
+     * Name of the Layout as it appears in the Layout toolbar and tool panel
      */
     Name: string;
     /**
@@ -165,6 +165,10 @@ export interface PivotLayout extends LayoutBase {
      * Display automatically calculated Totals within EACH Pivot Column Group, in the position specified
      */
     PivotColumnTotal?: PivotTotalPosition;
+    /**
+     * Ordered list of Pivot Result Columns; set to `true` to track current display order, or provide custom list
+     */
+    PivotResultColumnsOrder?: string[] | boolean;
 }
 /**
  * Defines the position of Pivot Total position - 'before' or 'after' the Value Column(s)

package/src/AdaptableState/NamedQueryState.d.ts

@@ -15,7 +15,7 @@ export interface NamedQueryState extends BaseState {
  */
 export interface NamedQuery extends AdaptableBooleanQuery, AdaptableObject {
     /**
-     * Name of the Query - how it will appear in the Expression
+     * Name of the Query, used to reference it in AdaptableQL Expressions
      */
     Name: string;
 }

package/src/AdaptableState/PlusMinusState.d.ts

@@ -1,7 +1,7 @@
 import { BaseState } from './BaseState';
 import { ColumnScope } from './Common/ColumnScope';
 import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
-import { SuspendableObject } from './Common/SuspendableObject';
+import { SuspendableObject } from '../types';
 /**
  * Adaptable State Section for Plus Minus Module
  */
@@ -15,6 +15,10 @@ export interface PlusMinusState extends BaseState {
  * Defines a Plus Minus Rule - used in the Plus Minus Module
  */
 export interface PlusMinusNudge extends SuspendableObject {
+    /**
+     * Name of the Plus Minus Nudge rule
+     */
+    Name: string;
     /**
      * Where Rule is applied
      */

package/src/AdaptableState/Selection/GridCell.d.ts

@@ -54,6 +54,9 @@ export interface GridCell<TData = any> {
      */
     isRowGroupCell: boolean;
 }
+/**
+ * Extended GridCell, props to show how often appears in data source and how often visible
+ */
 export interface GridCellWithCount extends GridCell {
     /**
      * How many times Cell appears in Data Source
@@ -64,6 +67,9 @@ export interface GridCellWithCount extends GridCell {
      */
     visibleCount?: number;
 }
+/**
+ * Grid Cell used in Grouped Rows
+ */
 export interface GridCellWithChildren extends GridCell {
     /**
      * Children of Cell
@@ -74,6 +80,9 @@ export interface GridCellWithChildren extends GridCell {
      */
     leafChildrenCount?: number;
 }
+/**
+ * Defines a Unique Cell Value (incl. how many times it appears in Grid)
+ */
 export interface UniqueGridCell<TData = any> {
     /**
      * Raw value of Cell

package/src/AdaptableState/ShortcutState.d.ts

@@ -1,6 +1,6 @@
 import { BaseState } from './BaseState';
 import { ColumnScope } from './Common/ColumnScope';
-import { SuspendableObject } from './Common/SuspendableObject';
+import { SuspendableObject } from '../types';
 /**
  * Adaptable State Section for Shortcut Module
  */
@@ -18,6 +18,10 @@ export type ShortcutScopeDataType = 'number';
  * Used to define a Shortcut as used in Shortcut State
  */
 export interface Shortcut extends SuspendableObject {
+    /**
+     * Name of the Shortcut
+     */
+    Name: string;
     /**
      * Numeric Columns where Shortcut is applied
      */

package/src/AdaptableState/StyledColumnState.d.ts

@@ -1,9 +1,9 @@
 import { BaseState } from './BaseState';
-import { SuspendableObject } from './Common/SuspendableObject';
 import { AdaptablePredicate, AdaptableStyle, AdaptableBooleanQuery, AdaptableIcon } from '../types';
 import { TypeHint } from './Common/Types';
 import { RowScope } from './Common/RowScope';
 import { AgSparklineOptions } from 'ag-charts-types';
+import { SuspendableObject } from './Common/SuspendableObject';
 /**
  * Adaptable State Section for Styled Column Module
  */

package/src/AdaptableState/ThemeState.d.ts

@@ -23,7 +23,7 @@ export interface ThemeState extends BaseState {
  */
 export interface AdaptableTheme extends AdaptableObject {
     /**
-     * Name of the Theme
+     * Name of the Theme as it appears in the Theme toolbar and tool panel
      */
     Name: string;
     /**

package/src/AdaptableState/UserInterfaceState.d.ts

@@ -0,0 +1,14 @@
+import { BaseState } from './BaseState';
+/**
+ * Adaptable State Section for the User Interface
+ *
+ * Controls the visibility and behaviour of AdapTable UI elements
+ */
+export interface UserInterfaceState extends BaseState {
+    /**
+     * Whether to hide all AdapTable UI elements (Dashboard, Tool Panel, Status Bar, Column and Context Menus etc.)
+     *
+     * @defaultValue false
+     */
+    HideAdaptableUI?: boolean;
+}

package/src/AdaptableState/UserInterfaceState.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/Api/AlertApi.d.ts

@@ -34,6 +34,12 @@ export interface AlertApi {
      * @returns alert definition
      */
     getAlertDefinitionById(id: AlertDefinition['Uuid'], config?: LayoutExtendedConfig): AlertDefinition;
+    /**
+     * Retrieves an Alert Definition by its Name
+     * @param name Name of the Alert Definition
+     * @returns Alert Definition or undefined if not found
+     */
+    getAlertDefinitionByName(name: string): AlertDefinition | undefined;
     /**
      * Adds given Alert Definition to Adaptable State
      * @param alertDefinition AlertDefinition to add

package/src/Api/CustomSortApi.d.ts

@@ -19,6 +19,12 @@ export interface CustomSortApi {
      * @returns Custom Sort
      */
     getCustomSortById(id: CustomSort['Uuid'], config?: LayoutExtendedConfig): CustomSort;
+    /**
+     * Retrieves a Custom Sort by its Name
+     * @param name Name of the Custom Sort
+     * @returns Custom Sort or undefined if not found
+     */
+    getCustomSortByName(name: string): CustomSort | undefined;
     /**
      * Retrieves all Custom Sorts in Adaptable State that are currently applied
      * @returns Custom Sorts
@@ -52,11 +58,14 @@ export interface CustomSortApi {
     addCustomSort(customSort: CustomSort): CustomSort;
     /**
      * Creates new Custom Sort based on given values
-     * @param columnId Id of Column to which to apply Custom Sort
-     * @param values Custom Sort values to apply
+     * @param params Parameters for creating a Custom Sort
      * @returns Custom Sort
      */
-    createCustomSort(columnId: string, values: string[]): CustomSort;
+    createCustomSort(params: {
+        name: string;
+        columnId: string;
+        values: string[];
+    }): CustomSort;
     /**
      * Updates existing Custom Sort with new set of Sorted Values
      * @param columnId Id of Column on which to edit the Custom Sort

package/src/Api/DataSetApi.d.ts

@@ -14,7 +14,7 @@ export interface DataSetApi {
      */
     getCurrentDataSet(): DataSet | undefined;
     /**
-     * Retreives Data Set from State with given name
+     * Retrieves Data Set from State with given name
      * @param dataSetName name of Data Set to retrieve
      * @returns data Set
      */

package/src/Api/FlashingCellApi.d.ts

@@ -23,6 +23,12 @@ export interface FlashingCellApi {
      * @returns Flashing Cell Definition
      */
     getFlashingCellDefinitionById(id: FlashingCellDefinition['Uuid'], config?: LayoutExtendedConfig): FlashingCellDefinition;
+    /**
+     * Retrieves a Flashing Cell Definition by its Name
+     * @param name Name of the Flashing Cell Definition
+     * @returns Flashing Cell Definition or undefined if not found
+     */
+    getFlashingCellDefinitionByName(name: string): FlashingCellDefinition | undefined;
     /**
      * Retrieves all active (non-suspended) cell Definitions in Flashing Cell State
      * @returns flashing cell definitions

package/src/Api/FormatColumnApi.d.ts

@@ -19,6 +19,12 @@ export interface FormatColumnApi {
      * @returns format column
      */
     getFormatColumnByUuId(id: FormatColumn['Uuid'], config?: FormatColumnConfig): FormatColumn;
+    /**
+     * Retrieves a Format Column by its Name
+     * @param name Name of the Format Column
+     * @returns Format Column or undefined if not found
+     */
+    getFormatColumnByName(name: string): FormatColumn | undefined;
     /**
      * Retrieves all active (not-suspended) Format Columns in Adaptable State
      * @returns format columns
@@ -41,10 +47,10 @@ export interface FormatColumnApi {
      */
     addFormatColumn(formatColumn: FormatColumn): FormatColumn;
     /**
-     * Adds Format Columns to Format Column State
-     * @param formatColumn Format Columns to Add
-     * @returns format columns
-     */
+    * Adds Format Columns to Format Column State
+    * @param formatColumn Format Columns to Add
+    * @returns format columns
+    */
     addFormatColumns(formatColumns: FormatColumn[]): FormatColumn[];
     /**
      * Edits the Format Column

package/src/Api/GridApi.d.ts

@@ -2,7 +2,7 @@ import { SelectedCellInfo } from '../AdaptableState/Selection/SelectedCellInfo';
 import { SelectedRowInfo } from '../AdaptableState/Selection/SelectedRowInfo';
 import { ColumnSort } from '../AdaptableState/Common/ColumnSort';
 import { CellUpdateRequest, GridCell } from '../AdaptableState/Selection/GridCell';
-import { DataUpdateConfig } from '../AdaptableState/Common/DataUpdateConfig';
+import { DataRowConfig, DataUpdateConfig } from '../AdaptableState/Common/DataUpdateConfig';
 import { CellDataChangedInfo } from '../AdaptableState/Common/CellDataChangedInfo';
 import { CellHighlightInfo } from '../AdaptableState/Common/CellHighlightInfo';
 import { RowHighlightInfo } from '../AdaptableState/Common/RowHighlightInfo';
@@ -13,6 +13,7 @@ import { RowsHighlightInfo } from '../AdaptableState/Common/RowsHighlightInfo';
 import { TransposeConfig } from '../AdaptableState/Common/TransposeConfig';
 import { AdaptableVariant } from '../AdaptableInterfaces/IAdaptable';
 import { InternalState } from '../AdaptableState/InternalState';
+import { ColumnHighlightInfo } from '../AdaptableState/Common/ColumnHighlightInfo';
 /**
  * Provides access to important properties and functionalities of AdapTable e.g. sorting, selected cells etc.
  */
@@ -69,6 +70,16 @@ export interface GridApi {
      * @param config batch option and callback function to run post deletion
      */
     deleteGridData(dataRows: any[], config?: DataUpdateConfig): Promise<IRowNode[]>;
+    /**
+     * Adds, Updates or Deletes rows in AdapTable (and AG Grid) in single transaction
+     * @param dataRowConfig - Rows to add, update or remove
+     * @param dataUpdateConfig - batch option and callback function to run post transaction
+     */
+    manageGridData(dataRowConfig: DataRowConfig, dataUpdateConfig?: DataUpdateConfig): Promise<{
+        addedRows: IRowNode[];
+        updatedRows: IRowNode[];
+        removedRows: IRowNode[];
+    }>;
     /**
      * Updates cell in AdapTable (first performs Cell & Server Validation)
      * @param cellUpdateRequest (contains columnId, newValue and primaryKeyValue
@@ -428,14 +439,28 @@ export interface GridApi {
     highlightCell(cellHighlightInfo: CellHighlightInfo): void;
     /**
      * Unhighlights a Cell in AdapTable
-     * @param cellHighlightInfo cell to unhighlight
+     * @param primaryKeyValue pkvalue of cell to unhilight
+     * @param columnId column id of cell to unhilight
      */
-    unHighlightCell(primaryKeyValue: CellHighlightInfo['primaryKeyValue'], columnId: CellHighlightInfo['columnId']): void;
+    unHighlightCell(primaryKeyValue: any, columnId: string): void;
     /**
      * Unhighlights all highlighted Cells in AdapTable
-     * @param cellHighlightInfo cell to highlight
      */
     unHighlightAllCells(): void;
+    /**
+     * Highlights a Column in AdapTable
+     * @param columnHighlightInfo column to highlight
+     */
+    highlightColumn(columnHighlightInfo: ColumnHighlightInfo): void;
+    /**
+     * Unhighlights a Column in AdapTable
+     * @param columnId column to unhighlight
+     */
+    unHighlightColumn(columnId: string): void;
+    /**
+     * Unhighlights all highlighted Columns in AdapTable
+     */
+    unHighlightAllColumns(): void;
     /**
      * Highlight a row using an adaptable style
      * @param rowHighlightInfo highlight instructions

package/src/Api/Implementation/ActionColumnApiImpl.js

@@ -4,6 +4,7 @@ exports.ActionColumnApiImpl = void 0;
 const ApiBase_1 = require("./ApiBase");
 const ActionColumnInternalApi_1 = require("../Internal/ActionColumnInternalApi");
 class ActionColumnApiImpl extends ApiBase_1.ApiBase {
+    internalApi;
     constructor(_adaptable) {
         super(_adaptable);
         this.internalApi = new ActionColumnInternalApi_1.ActionColumnInternalApi(_adaptable);

package/src/Api/Implementation/AdaptableApiImpl.js

@@ -52,6 +52,58 @@ const ContextMenuApiImpl_1 = require("./ContextMenuApiImpl");
 const FilterApiImpl_1 = require("./FilterApiImpl");
 const RowFormApiImpl_1 = require("./RowFormApiImpl");
 class AdaptableApiImpl {
+    adaptable;
+    internalApi;
+    optionsApi;
+    actionColumnApi;
+    applicationApi;
+    alertApi;
+    flashingCellApi;
+    predicateApi;
+    bulkUpdateApi;
+    calendarApi;
+    calculatedColumnApi;
+    cellSummaryApi;
+    columnApi;
+    stateApi;
+    customSortApi;
+    dashboardApi;
+    dataSetApi;
+    entitlementApi;
+    eventApi;
+    exportApi;
+    formatColumnApi;
+    freeTextColumnApi;
+    gridApi;
+    layoutApi;
+    plusMinusApi;
+    quickSearchApi;
+    rowFormApi;
+    scheduleApi;
+    shortcutApi;
+    smartEditApi;
+    filterApi;
+    systemStatusApi;
+    pluginsApi;
+    themeApi;
+    userInterfaceApi;
+    expressionApi;
+    settingsPanelApi;
+    styledColumnApi;
+    toolPanelApi;
+    teamSharingApi;
+    columnScopeApi;
+    dataChangeHistoryApi;
+    chartingApi;
+    statusBarApi;
+    noteApi;
+    columnMenuApi;
+    contextMenuApi;
+    fdc3Api;
+    dataImportApi;
+    namedQueryApi;
+    commentApi;
+    destroyed;
     constructor(adaptable) {
         this.adaptable = adaptable;
         this.destroyed = false;

package/src/Api/Implementation/AlertApiImpl.d.ts

@@ -16,6 +16,7 @@ export declare class AlertApiImpl extends ApiBase implements AlertApi {
     getActiveAlertDefinitions(config?: LayoutExtendedConfig): AlertDefinition[];
     deleteAlertDefinition(alertDefinition: AlertDefinition): void;
     getAlertDefinitionById(id: AlertDefinition['Uuid'], config?: LayoutExtendedConfig): AlertDefinition;
+    getAlertDefinitionByName(name: string): AlertDefinition | undefined;
     addAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
     displayAdaptableAlert(alertToShow: AdaptableAlert): Promise<void>;
     displayAdaptableAlertNotification(alert: AdaptableAlert): void;

package/src/Api/Implementation/AlertApiImpl.js

@@ -11,7 +11,9 @@ const ObjectFactory_1 = tslib_1.__importDefault(require("../../Utilities/ObjectF
 const AdaptableAlert_1 = require("../../AdaptableState/Common/AdaptableAlert");
 const StringExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/StringExtensions"));
 const AlertInternalApi_1 = require("../Internal/AlertInternalApi");
+const resolveContainerElement_1 = require("../../Utilities/resolveContainerElement");
 class AlertApiImpl extends ApiBase_1.ApiBase {
+    internalApi;
     constructor(_adaptable) {
         super(_adaptable);
         this.internalApi = new AlertInternalApi_1.AlertInternalApi(_adaptable);
@@ -35,6 +37,9 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
     getAlertDefinitionById(id, config) {
         return this.getAlertDefinitions(config).find((alert) => alert?.Uuid === id);
     }
+    getAlertDefinitionByName(name) {
+        return this.getAlertDefinitions().find((alertDefinition) => alertDefinition.Name === name);
+    }
     addAlertDefinition(alertDefinition) {
         this.addUidToAdaptableObject(alertDefinition);
         this.dispatchAction(AlertRedux.AlertDefinitionAdd(alertDefinition));
@@ -62,12 +67,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
             }
             // Show Alert in a Div (if one has been set)
             if (alertProperties.ShowInDiv) {
-                let alertDiv;
-                let optionsDiv = this.getContainerOptions().alertContainer;
-                if (optionsDiv) {
-                    alertDiv =
-                        typeof optionsDiv === 'string' ? document.getElementById(optionsDiv) : optionsDiv;
-                }
+                const alertDiv = (0, resolveContainerElement_1.resolveContainerElement)(this.getContainerOptions().alertContainer, this.getAdaptableInternalApi().buildBaseContext());
                 if (alertDiv) {
                     let alertString = alertToShow.header + ': ' + alertToShow.message;
                     alertDiv.innerHTML = alertString;

package/src/Api/Implementation/ApiBase.d.ts

@@ -19,7 +19,7 @@ export declare abstract class ApiBase {
     protected _adaptable: IAdaptable;
     /**
      * Constructor for all the api classes which simply takes and assigns an instance of Adaptable
-     * @param _adaptable the core IAdaptable object
+     * @param _adaptable core IAdaptable object - for INTERNAL USE ONLY and not part of public API
      */
     constructor(_adaptable: IAdaptable);
     protected getAdatableLogger(): AdaptableLogger;

package/src/Api/Implementation/ApiBase.js

@@ -6,9 +6,10 @@ const Helper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/Helper
 const Uuid_1 = require("../../AdaptableState/Uuid");
 // Base class for the Api - provides checking dispatching methods
 class ApiBase {
+    _adaptable;
     /**
      * Constructor for all the api classes which simply takes and assigns an instance of Adaptable
-     * @param _adaptable the core IAdaptable object
+     * @param _adaptable core IAdaptable object - for INTERNAL USE ONLY and not part of public API
      */
     constructor(_adaptable) {
         this._adaptable = _adaptable;

package/src/Api/Implementation/CalculatedColumnApiImpl.js

@@ -8,6 +8,7 @@ const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/
 const CalculatedColumnInternalApi_1 = require("../Internal/CalculatedColumnInternalApi");
 const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
 class CalculatedColumnApiImpl extends ApiBase_1.ApiBase {
+    internalApi;
     constructor(_adaptable) {
         super(_adaptable);
         this.internalApi = new CalculatedColumnInternalApi_1.CalculatedColumnInternalApi(_adaptable);

package/src/Api/Implementation/ChartingApiImpl.js

@@ -9,6 +9,10 @@ const StringExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Exte
 const ChartingInternalApi_1 = require("../Internal/ChartingInternalApi");
 const ObjectFactory_1 = tslib_1.__importDefault(require("../../Utilities/ObjectFactory"));
 class ChartingApiImpl extends ApiBase_1.ApiBase {
+    /**
+     * @internal
+     */
+    internalApi;
     constructor(_adaptable) {
         super(_adaptable);
         this.internalApi = new ChartingInternalApi_1.ChartingInternalApi(_adaptable);
@@ -122,8 +126,8 @@ class ChartingApiImpl extends ApiBase_1.ApiBase {
         else {
             const alert = {
                 alertType: 'generic',
-                header: 'Save chart',
-                message: 'Do you want to save this Chart?',
+                header: 'Save Chart',
+                message: 'Would you like to save this chart?',
                 alertDefinition: {
                     ...ObjectFactory_1.default.CreateEmptyAlertDefinition(),
                     MessageType: 'Info',

package/src/Api/Implementation/ColumnApiImpl.d.ts

@@ -83,7 +83,7 @@ export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
     getPrimaryKeyColumn(): AdaptableColumn<any>;
     getDefaultAggFunc(columnId: string): string;
     openColumnInfoSettingsPanel(): void;
-    getColumnTypes(): import("../../AdaptableState/Common/Types").TypeHint<string, import("../../types").AdaptableColumnType>[];
+    getColumnTypes(): import("../../AdaptableState/Common/Types").TypeHint<string, import("../../types").AdaptableColumnTypeName>[];
     getColumnsByColumnType(columnType: string): AdaptableColumn[];
     getRowGroupedColumns(): AdaptableColumn[];
     setColumnCaption(columnId: string, caption: string): void;

package/src/Api/Implementation/ColumnApiImpl.js

@@ -122,6 +122,7 @@ function isPivotGrandTotal(columnId) {
     return columnId?.startsWith(GeneralConstants.AG_GRID_PIVOT_GRAND_TOTAL_COLUMN);
 }
 class ColumnApiImpl extends ApiBase_1.ApiBase {
+    internalApi;
     constructor(_adaptable) {
         super(_adaptable);
         this.internalApi = new ColumnInternalApi_1.ColumnInternalApi(_adaptable);

package/src/Api/Implementation/ColumnFilterApiImpl.js

@@ -9,6 +9,7 @@ const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Exten
 const ColumnFilterInternalApi_1 = require("../Internal/ColumnFilterInternalApi");
 const StringExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/StringExtensions"));
 class ColumnFilterApiImpl extends ApiBase_1.ApiBase {
+    internalApi;
     constructor(_adaptable) {
         super(_adaptable);
         this.internalApi = new ColumnFilterInternalApi_1.ColumnFilterInternalApi(_adaptable);

package/src/Api/Implementation/CommentsApiImpl.js

@@ -8,6 +8,7 @@ const ObjectFactory_1 = tslib_1.__importDefault(require("../../Utilities/ObjectF
 const AdaptableHelper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/AdaptableHelper"));
 const CommentsInternalApi_1 = require("../Internal/CommentsInternalApi");
 class CommentsApiImpl extends ApiBase_1.ApiBase {
+    internalApi;
     constructor(_adaptable) {
         super(_adaptable);
         this.internalApi = new CommentsInternalApi_1.CommentsInternalApi(_adaptable);

package/src/Api/Implementation/CustomSortApiImpl.d.ts

@@ -11,6 +11,7 @@ export declare class CustomSortApiImpl extends ApiBase implements CustomSortApi
     getCustomSortState(): CustomSortState;
     getCustomSorts(config?: LayoutExtendedConfig): CustomSort[];
     getCustomSortById(id: CustomSort['Uuid'], config?: LayoutExtendedConfig): CustomSort;
+    getCustomSortByName(name: string): CustomSort | undefined;
     getLiveCustomSorts(): CustomSort[];
     getLiveCustomSortComparers(): ColumnValuesComparer[];
     getActiveCustomSorts(config?: LayoutExtendedConfig): CustomSort[];
@@ -18,7 +19,11 @@ export declare class CustomSortApiImpl extends ApiBase implements CustomSortApi
     getCustomSortByColumn(column: string): CustomSort;
     getCustomSortForColumn(columnId: string): CustomSort | undefined;
     addCustomSort(customSort: CustomSort): CustomSort;
-    createCustomSort(columnId: string, values: string[]): CustomSort;
+    createCustomSort(params: {
+        name: string;
+        columnId: string;
+        values: string[];
+    }): CustomSort;
     editCustomSortValues(columnId: string, values: string[]): CustomSort;
     editCustomSort(customSort: CustomSort): CustomSort;
     deleteCustomSort(column: string): void;