@adaptabletools/adaptable 15.4.2 → 15.4.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "15.4.2",
+  "version": "15.4.3",
   "description": "Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
   "keywords": [
     "web-components",

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1687108346180;
+declare const _default: 1688649437408;
 export default _default;

package/publishTimestamp.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = 1687108346180;
+exports.default = 1688649437408;

package/src/AdaptableInterfaces/AdaptableNoCodeWizard.d.ts

@@ -7,6 +7,9 @@ export declare type AdaptableNoCodeWizardInitFn = ({ gridOptions, adaptableOptio
     adaptableOptions: AdaptableOptions;
     agGridModules: Module[];
 }) => Promise<AdaptableApi>;
+/**
+ * AdapTable Options used by the No Code Wizard
+ */
 export interface AdaptableNoCodeWizardOptions {
     onInit?: AdaptableNoCodeWizardInitFn;
     fileAccept?: string;

package/src/AdaptableOptions/FilterOptions.d.ts

@@ -200,6 +200,9 @@ export interface FilterOptions<TData = any> {
      */
     quickFilterValuesWidth?: 'auto' | number;
 }
+/**
+ * Context provided when Filtering
+ */
 export interface FilterContext<TData = any> extends BaseContext {
     /**
      * Column being filtered

package/src/AdaptableOptions/FinancePluginOptions.d.ts

@@ -214,6 +214,9 @@ export interface OrganizationColumn extends FDC3Column {
      */
     intents?: OrganizationIntents;
 }
+/**
+ *
+ */
 export declare type OrganizationIntents = OrganizationIntent[];
 /**
  * FDC3 Intents available to an Organization Column
@@ -274,12 +277,33 @@ export interface RaiseFDC3IntentContext extends ContextMenuContext {
      */
     intent: FDC3Intent | CustomFDC3Intent;
 }
+/**
+ * Function that handles FDC3 Context
+ */
 export declare type FDC3ContextHandler = (context: FDC3Context) => void;
+/**
+ * Defines a Desktop Agent which supports FDC3
+ */
 export interface FDC3DesktopAgent {
+    /**
+     * Raises an Intent
+     */
     raiseIntent: (intent: FDC3Intent, context: FDC3Context) => void;
+    /**
+     * Broadcasts an FDC3 Message
+     */
     broadcast: (context: FDC3Context) => void;
+    /**
+     * Raises an FDC3 Intent for a given Context
+     */
     raiseIntentForContext: (context: FDC3Context) => void;
+    /**
+     * Adds an FDC3 Intent Listener
+     */
     addIntentListener: (intent: FDC3Intent | CustomFDC3Intent, listener: (context: FDC3Context) => void) => void;
+    /**
+    * Adds an FDC3 Context Listener
+    */
     addContextListener: (contextType: string | null, handler: FDC3ContextHandler) => {
         unsubscribe: () => void;
     };

package/src/AdaptableOptions/LayoutOptions.d.ts

@@ -65,6 +65,9 @@ export interface LayoutOptions {
      */
     pivotPreviewColumns?: string[] | ((context: PivotPreviewColumnsContext) => string[]);
 }
+/**
+ * Options for managing Tags in Layouts (used to enhance Layouts)
+ */
 export interface LayoutTagOptions {
     /**
      * Automatically generate an AdaptableObjectTag for each Layout

package/src/AdaptableOptions/ToolPanelOptions.d.ts

@@ -58,6 +58,9 @@ export interface ToolPanelButtonContext extends BaseContext {
      */
     toolPanelState: ToolPanelState;
 }
+/**
+ * Context used for Custom Tool Panels containing Buttons
+ */
 export interface CustomToolPanelButtonContext extends ToolPanelButtonContext {
     /**
      *The Custom ToolPanel which contains the button

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -185,11 +185,17 @@ export interface BulkUpdatePermittedValuesContext<TData = any> extends Permitted
      */
     gridCells: GridCell<TData>[];
 }
+/**
+ * Sets of Tabs avilable in Grid Info Settings Panel
+ */
 export declare type GridInfoSections = GridInfoSection[];
 /**
  * Tabs available in the Grid Info Settings Panel
  */
 export declare type GridInfoSection = 'GridSummary' | 'AdaptableOptions' | 'ColumnInfo' | 'AdaptableObjects';
+/**
+ * Context used when evaluating Object Tags
+ */
 export interface ObjectTagsContext extends BaseContext {
 }
 /**

package/src/Api/ExportApi.d.ts

@@ -98,7 +98,7 @@ export interface ExportApi {
      */
     exportDataToExcel(reportData: ReportData, fileName: string): void;
     /**
-     * Opens Settings Panel with Export section selected and visible
+     * Open Settings Panel with Export section selected
      */
     openExportSettingsPanel(): void;
     /**
@@ -129,11 +129,11 @@ export interface ExportApi {
      */
     getExportDestinationForm(destinationName: string): AdaptableForm<ExportFormContext> | undefined;
     /**
-     * Exports data currently in grid to Excel as What-You-See-Is-What-You-Get
+     * Exports data currently in grid to Excel as WYSIWYG
      */
     exportVisualDataToExcel(): void;
     /**
-     * Whether the given Report is a user-generated (server) one
+     * Is given Report user-generated
      * @param report Report to Check
      */
     isServerReport(report: Report): boolean;

package/src/Api/GridApi.d.ts

@@ -286,9 +286,29 @@ export interface GridApi {
      * @param columnId ColumnId to lookup
      */
     getRawValueFromRowNode(rowNode: IRowNode, columnId: string): any | undefined;
+    /**
+     * Returns all the Grid Cells in a Column that have the given Raw Value
+     * @param columnId ColumnId to lookup
+     * @param rawValue Raw Value to use
+     */
     getGridCellsForRawValue(columnId: string, rawValue: any): GridCell[] | undefined;
+    /**
+     * Gets the count of the cells in a Column that have the given Raw Value
+     * @param columnId ColumnId to lookup
+     * @param rawValue Raw Value to use
+     */
     getCellRawValueCount(columnId: string, rawValue: any): number;
+    /**
+   * Returns all the Grid Cells in a Column that have the given Display Value
+   * @param columnId ColumnId to lookup
+   * @param displayValue Display Value to use
+   */
     getGridCellsForDisplayValue(columnId: string, displayValue: any): GridCell[] | undefined;
+    /**
+   * Gets the count of the cells in a Column that have the given Display Value
+   * @param columnId ColumnId to lookup
+   * @param displayValue Display Value to use
+   */
     getCellDisplayValueCount(columnId: string, displayValue: any): number;
     /**
      * Retrieves Formatted Value for a given Raw Value in given Column

package/src/Api/Implementation/GridApiImpl.js

@@ -399,13 +399,13 @@ class GridApiImpl extends ApiBase_1.ApiBase {
         if (!gridCells) {
             return undefined;
         }
-        const returnValues = [];
+        const returnGridCells = [];
         gridCells.forEach((gc) => {
             if (gc.displayValue === displayValue) {
-                returnValues.push(gc);
+                returnGridCells.push(gc);
             }
         });
-        return returnValues;
+        return returnGridCells;
     }
     getCellDisplayValueCount(columnId, displayValue) {
         const gridCells = this.getGridCellsForDisplayValue(columnId, displayValue);

package/src/PredefinedConfig/AlertState.d.ts

@@ -37,11 +37,11 @@ export interface AlertDefinition extends SuspendableObject {
      */
     MessageType: AdaptableMessageType;
     /**
-     * The Alert Title Message to display
+     * Title of dipslayed Alert Message
      */
     MessageHeader?: string;
     /**
-     * Alert Message; if not provided AdapTable creates dynamically using Rule & Scope (Note: can be provided as a function in AlertOptions)
+     * Title of dipslayed Alert Message; if null, AdapTable creates dynamically using Rule & Scope
      */
     MessageText?: string;
     /**
@@ -53,6 +53,9 @@ export interface AlertDefinition extends SuspendableObject {
      */
     AlertForm?: string | AlertButtonForm;
 }
+/**
+ * Form triggered by an Alert which contains only Buttons
+ */
 export declare type AlertButtonForm = Omit<AdaptableForm<AlertFormContext>, 'title' | 'buttons' | 'description'> & {
     Buttons?: AlertButton<AlertFormContext>[];
 };
@@ -104,15 +107,15 @@ export interface AlertProperties {
      */
     DisplayNotification?: boolean;
     /**
-     * Notifiction duration, it defaults to NotificationOptions.duration
+     * Notifiction duration(defaults to `NotificationOptions.duration`)
      */
     NotificationDuration?: NotificationsOptions['duration'];
     /**
-     * Colours updated cell using `MessageType` property of triggering Alert Definition
+     * Colours updated Row using `MessageType` of triggering Alert Definition
      */
     HighlightCell?: boolean | AdaptableStyle;
     /**
-     * Colours updated cell using `MessageType` property of triggering Alert Definition
+     * Colours updated Row using `MessageType` of triggering Alert Definition
      */
     HighlightRow?: boolean | AdaptableStyle;
     /**

package/src/PredefinedConfig/Common/AdaptablePredicate.d.ts

@@ -15,9 +15,12 @@ export interface AdaptablePredicate {
      */
     Inputs?: any[];
 }
+/**
+ * Restricts a Predicate to a given Column
+ */
 export interface AdaptableColumnPredicate extends AdaptablePredicate {
     /**
-     * If specified, ColumnId restricts the predicate evaluation to the given column
+     * Id of Column which will be evaluated by the Predicate
      */
     ColumnId?: string;
 }
@@ -68,6 +71,9 @@ export interface AdaptablePredicateDef {
      */
     onlyQuickFilter?: boolean;
 }
+/**
+ * Defines an Input to a Predicate
+ */
 export interface PredicateDefInput {
     type: 'number' | 'text' | 'date' | 'boolean';
     label?: string;
@@ -106,9 +112,15 @@ export interface PredicateDefHandlerParams {
      */
     api: AdaptableApi;
 }
+/**
+ * Inputs required for a Predicate
+ */
 export interface PredicateDefToStringParams {
     inputs: any[];
 }
+/**
+ * Defines which in Modules the Predicate is available
+ */
 export declare type PredicateModuleScope = 'filter' | 'alert' | 'flashingcell' | 'formatColumn' | 'badgeStyle';
 /**
  * Array of Predicate Defs which are shipped by AdapTable

package/src/PredefinedConfig/Common/Entitlement.d.ts

@@ -1,4 +1,7 @@
 import { AdaptableModule } from './Types';
+/**
+ * Defines a Permission in AdapTable - Module and Access Level
+ */
 export interface Entitlement {
     /**
      * Name of Adaptable Module that has the Entitlement applied

package/src/PredefinedConfig/StyledColumnState.d.ts

@@ -69,6 +69,9 @@ export interface PercentBarStyle extends NumericStyledColumn {
      */
     BackColor?: string;
 }
+/**
+ * Base type for Numeric Styled Columns (i.e. Gradient and Percent Bar)
+ */
 export interface NumericStyledColumn {
     /**
      * Ranges (e.g. to create traffic light effect)

package/src/View/Components/FilterForm/QuickFilterValues.js

@@ -21,6 +21,13 @@ const QuickFilterValues = (props) => {
         counter: 0,
     });
     const [transientColumnFilter, setTransientColumnFilter] = React.useState(null);
+    const clearColumnFilter = () => {
+        var _a;
+        props.clearColumnFilter();
+        if (!((_a = props.api.optionsApi.getFilterOptions()) === null || _a === void 0 ? void 0 : _a.autoApplyFilter)) {
+            props.api.gridApi.applyGridFiltering();
+        }
+    };
     const onColumnValueSelectedChange = (columnValues) => {
         var _a;
         const { columnFilter } = props;
@@ -151,7 +158,7 @@ const QuickFilterValues = (props) => {
                     width: getPopoverWidth(targetWidth),
                 } },
                 React.createElement(rebass_1.Flex, { m: 2 },
-                    React.createElement(SimpleButton_1.default, { onClick: () => props.clearColumnFilter() }, "Clear Filter"),
+                    React.createElement(SimpleButton_1.default, { onClick: () => clearColumnFilter() }, "Clear Filter"),
                     ((_a = api.optionsApi.getFilterOptions()) === null || _a === void 0 ? void 0 : _a.autoApplyFilter) == false && (React.createElement(SimpleButton_1.default, { ml: 2, onClick: () => {
                             if (transientColumnFilter) {
                                 props.updateColumnFilter(transientColumnFilter);

package/src/agGrid/Adaptable.js

@@ -67,6 +67,7 @@ const ChartingService_1 = require("../Utilities/Services/ChartingService");
 const ThemeService_1 = require("../Utilities/Services/ThemeService");
 const AdaptableLogger_1 = require("./AdaptableLogger");
 const attachAddaptableColumnTypes_1 = require("./attachAddaptableColumnTypes");
+const FormatHelper_1 = require("../Utilities/Helpers/FormatHelper");
 const tinycolor = require('tinycolor2');
 const GROUP_PATH_SEPARATOR = '/';
 // IMPORTANT - we need colId to be set in order for safeSetColDefs to work correctly
@@ -4651,11 +4652,10 @@ class Adaptable {
                     }
                     const excelDataType = this.api.exportApi.internalApi.getExcelDataType(colDef === null || colDef === void 0 ? void 0 : colDef.type);
                     const rawValue = this.getRawValueFromRowNode(node, column.getId());
-                    // don't add the cell style if it has no adaptable custom styles or user defined styles
-                    if (rawValue == undefined ||
-                        (!excelStyles.length &&
-                            // if this is a formatted Date value, we still need to add the AG GRID specific type & numberFormat below
-                            !(excelDataType === 'DateTime' && isDateCellExportedAsFormattedValue))) {
+                    // don't add the cell style if it has no adaptable custom styles
+                    if (!excelStyles.length &&
+                        // if this is a formatted Date value, we still need to add the AG GRID specific type & numberFormat below
+                        !(excelDataType === 'DateTime' && isDateCellExportedAsFormattedValue)) {
                         return;
                     }
                     const cellClassId = this.getExcelClassNameForCell(column.getId(), this.getPrimaryKeyValueFromRowNode(node), userDefinedCellClass);
@@ -4674,9 +4674,10 @@ class Adaptable {
                             if (normalisedValue) {
                                 // we have to pass the date in the ISO format to Excel
                                 // see https://www.ag-grid.com/javascript-data-grid/excel-export-data-types/#dates
-                                // we also need to remove the timezone info from the date
-                                const dateWithoutTimezoneCorrection = new Date(Date.UTC(normalisedValue.getFullYear(), normalisedValue.getMonth(), normalisedValue.getDate()));
-                                const isoFormattedValue = dateWithoutTimezoneCorrection.toISOString();
+                                // we can NOT use Date.toISOString() because we don't want the timezone corrections to kick in
+                                const isoFormattedValue = (0, FormatHelper_1.DateFormatter)(normalisedValue, {
+                                    Pattern: `yyyy-MM-dd'T'HH:mm:ss.SSS`,
+                                });
                                 if (isoFormattedValue) {
                                     finalCellExcelStyle.dataType = 'DateTime';
                                     finalCellExcelStyle.numberFormat = { format: dateFormatPattern };

package/src/metamodel/adaptable.metamodel.d.ts

@@ -284,6 +284,17 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         desc: string;
     };
+    AdaptableColumnPredicate: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+        }[];
+    };
     AdaptableColumnType: {
         name: string;
         kind: string;
@@ -514,6 +525,11 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         desc: string;
     };
+    AdaptableNoCodeWizardOptions: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
     AdaptableObject: {
         name: string;
         kind: string;
@@ -975,6 +991,11 @@ export declare const ADAPTABLE_METAMODEL: {
             ref?: undefined;
         })[];
     };
+    AlertButtonForm: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
     AlertDefinition: {
         name: string;
         kind: string;
@@ -2008,6 +2029,17 @@ export declare const ADAPTABLE_METAMODEL: {
             ref?: undefined;
         })[];
     };
+    CustomToolPanelButtonContext: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: {
+            name: string;
+            kind: string;
+            desc: string;
+            ref: string;
+        }[];
+    };
     DashboardButtonContext: {
         name: string;
         kind: string;
@@ -2271,6 +2303,17 @@ export declare const ADAPTABLE_METAMODEL: {
             defVal?: undefined;
         })[];
     };
+    Entitlement: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: {
+            name: string;
+            kind: string;
+            desc: string;
+            ref: string;
+        }[];
+    };
     EntitlementContext: {
         name: string;
         kind: string;
@@ -2402,6 +2445,11 @@ export declare const ADAPTABLE_METAMODEL: {
             isOpt: boolean;
         }[];
     };
+    ExpressionCategory: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
     ExpressionContext: {
         name: string;
         kind: string;
@@ -2522,6 +2570,16 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         desc: string;
     };
+    FDC3DesktopAgent: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: {
+            name: string;
+            kind: string;
+            desc: string;
+        }[];
+    };
     FDC3Intent: {
         name: string;
         kind: string;
@@ -2543,6 +2601,16 @@ export declare const ADAPTABLE_METAMODEL: {
             isOpt: boolean;
         })[];
     };
+    FilterContext: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: {
+            name: string;
+            kind: string;
+            desc: string;
+        }[];
+    };
     FilterOptions: {
         name: string;
         kind: string;
@@ -3055,6 +3123,11 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         desc: string;
     };
+    GridInfoSections: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
     GridRow: {
         name: string;
         kind: string;
@@ -3317,6 +3390,18 @@ export declare const ADAPTABLE_METAMODEL: {
             isOpt: boolean;
         }[];
     };
+    LayoutTagOptions: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            defVal: string;
+        }[];
+    };
     LayoutViewOptions: {
         name: string;
         kind: string;
@@ -3452,6 +3537,38 @@ export declare const ADAPTABLE_METAMODEL: {
             isOpt: boolean;
         }[];
     };
+    NumericStyledColumn: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: ({
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            ref?: undefined;
+            defVal?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            ref: string;
+            defVal?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            defVal: string;
+            ref: string;
+        })[];
+    };
+    ObjectTagsContext: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
     OpenFinPluginOptions: {
         name: string;
         kind: string;
@@ -3728,6 +3845,21 @@ export declare const ADAPTABLE_METAMODEL: {
             ref?: undefined;
         })[];
     };
+    PredicateDefInput: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
+    PredicateDefToStringParams: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
+    PredicateModuleScope: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
     PredicateOptions: {
         name: string;
         kind: string;