@adaptabletools/adaptable 11.0.5 → 11.0.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "11.0.5",
+  "version": "11.0.8",
   "description": "Powerful data-agnostic HTML5 datagrid add-on that sits on top of an underlying grid component and provides all the rich functionality that advanced users expect from their DataGrids and Data Tables",
   "keywords": [
     "web-components",

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1647181545760;
+declare const _default: 1647511077741;
 export default _default;

package/publishTimestamp.js

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

package/src/AdaptableOptions/GeneralOptions.d.ts

@@ -35,9 +35,9 @@ export interface GeneralOptions {
      */
     showGroupingTotalsAsHeader?: boolean;
     /**
-     * Sort Grouped Column automatically (using Custom Sort if one applied)
+     * Order Grouped Column automatically, deriving from Adaptable State if available (CustomSort or Layout ColumnSort)
      *
-     * Order Grouped Column automatically, trying to sort them (in the specified priority order) based on an active CustomSort, a defined Column Comparator, or at least alphanumerically
+     * The default group order will be derived from (in the specified priority): 1. an active CustomSort,  2. the defined ColDef Comparator, 3. current Layout ColumnSort or 4. alphanumerically
      * @defaultValue true
      * @gridInfoItem
      */

package/src/Api/AlertApi.d.ts

@@ -131,7 +131,7 @@ export interface AlertApi {
      */
     showAlertError(alertHeader: string, alertMessage: string): void;
     /**
-     * Opens the Alert popup screen
+     * Opens Settings Panel with Alert section selected and visible
      */
     showAlertPopup(): void;
     /**

package/src/Api/BulkUpdateApi.d.ts

@@ -8,7 +8,7 @@ export interface BulkUpdateApi {
      */
     getBulkUpdateValue(): string;
     /**
-     * Opens Bulk Update popup screen
+     * Opens Settings Panel with Bulk Update section selected and visible
      */
     showBulkUpdatePopup(): void;
     /**

package/src/Api/CalculatedColumnApi.d.ts

@@ -48,7 +48,7 @@ export interface CalculatedColumnApi {
      */
     deleteCalculatedColumn(calcColumn: string): void;
     /**
-     * Opens Calculated Column popup screen
+     * Opens Settings Panel with Calculated Column section selected and visible
      */
     showCalculatedColumnPopup(): void;
     /**

package/src/Api/CellSummaryApi.d.ts

@@ -16,7 +16,7 @@ export interface CellSummaryApi {
      */
     getCellSummaryOperationDefinitions(): CellSummaryOperation[];
     /**
-     * Opens Cell Summary popup screen
+     * Opens Settings Panel with Cell Summary section selected and visible
      */
     showCellSummaryPopup(): void;
 }

package/src/Api/ConditionalStyleApi.d.ts

@@ -30,7 +30,7 @@ export interface ConditionalStyleApi {
      */
     getAllSuspendedConditionalStyle(): ConditionalStyle[];
     /**
-     * Opens Conditional Style popup screen
+     * Opens Settings Panel with Conditional Style section selected and visible
      */
     showConditionalStylePopup(): void;
     /**

package/src/Api/CustomSortApi.d.ts

@@ -71,7 +71,7 @@ export interface CustomSortApi {
      */
     unSuspendCustomSort(customSort: CustomSort): CustomSort;
     /**
-     * Opens Custom Sort popup screen
+     * Opens Settings Panel with Custom Sort section selected and visible
      */
     showCustomSortPopup(): void;
 }

package/src/Api/DashboardApi.d.ts

@@ -119,7 +119,7 @@ export interface DashboardApi {
      */
     isToolbarVisible(toolbar: AdaptableDashboardToolbar | string): boolean;
     /**
-     * Opens the Dashboard popup screen
+     * Opens Settings Panel with Dashboard section selected and visible
      */
     showDashboardPopup(): void;
     /**

package/src/Api/DataSourceApi.d.ts

@@ -52,7 +52,7 @@ export interface DataSourceApi {
      */
     clearDataSource(): void;
     /**
-     * Opens Data Source popup screen
+     * Opens Settings Panel with Data Source section selected and visible
      */
     showDataSourcePopup(): void;
 }

package/src/Api/ExportApi.d.ts

@@ -77,7 +77,7 @@ export interface ExportApi {
      */
     exportDataToExcel(reportData: ReportData, fileName: string): void;
     /**
-     * Opens Export popup screen
+     * Opens Settings Panel with Export section selected and visible
      */
     showExportPopup(): void;
     /**
@@ -121,5 +121,10 @@ export interface ExportApi {
      * Runs the report function of the CustomReport with the given reportName
      * @param reportName custom report name
      */
-    runCustomReport(reportName: string): ReportData;
+    runCustomReport(reportName: string): ReportData | undefined;
+    /**
+     * Returns the ReportData for the Report with the given name
+     * @param reportName - the name of the report
+     */
+    getReportDataForReport(reportName: string): ReportData | undefined;
 }

package/src/Api/FormatColumnApi.d.ts

@@ -99,7 +99,7 @@ export interface FormatColumnApi {
      */
     applyFormatColumnDisplayFormats(): void;
     /**
-     * Opens the Format Column popup screen
+     * Opens Settings Panel with Format Column section selected and visible
      */
     showFormatColumnPopup(): void;
     /**

package/src/Api/FreeTextColumnApi.d.ts

@@ -65,7 +65,7 @@ export interface FreeTextColumnApi {
      */
     checkFreeTextColumnForDataChange(dataChangedInfo: DataChangedInfo): void;
     /**
-     * Opens FreeTextColumn popup screen
+     * Opens Settings Panel with Free Text Column section selected and visible
      */
     showFreeTextColumnPopup(): void;
     /**

package/src/Api/GridApi.d.ts

@@ -433,7 +433,7 @@ export interface GridApi {
      */
     getGridContainerElement(): HTMLElement | null;
     /**
-     * Opens Grid Info popup screen
+     * Opens Settings Panel with Grid Info section selected and visible
      */
     showGridInfoPopup(): void;
 }

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

@@ -27,5 +27,6 @@ export declare class ExportApiImpl extends ApiBase implements ExportApi {
     editReports(reports: Report[]): Report[];
     isDataChangeInReport(dataChangedInfo: DataChangedInfo, report: Report): boolean;
     exportVisualDataToExcel(): void;
-    runCustomReport(customReportName: string): ReportData;
+    runCustomReport(customReportName: string): ReportData | undefined;
+    getReportDataForReport(reportName: string): ReportData | undefined;
 }

package/src/Api/Implementation/ExportApiImpl.js

@@ -6,6 +6,7 @@ const ExportRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/Ex
 const ApiBase_1 = require("./ApiBase");
 const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
 const Enums_1 = require("../../PredefinedConfig/Common/Enums");
+const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
 class ExportApiImpl extends ApiBase_1.ApiBase {
     getExportState() {
         return this.getAdaptableState().Export;
@@ -162,7 +163,19 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
     runCustomReport(customReportName) {
         var _a;
         const customReport = (_a = this.getExportOptions().customReports) === null || _a === void 0 ? void 0 : _a.find((cr) => cr.name == customReportName);
-        return customReport ? customReport.onRunReport() : undefined;
+        if (!customReport) {
+            LoggingHelper_1.LogAdaptableWarning(`Custom Report '${customReportName}' not found!`);
+            return undefined;
+        }
+        return customReport.onRunReport();
+    }
+    getReportDataForReport(reportName) {
+        const report = this.getReportByName(reportName);
+        if (!report) {
+            LoggingHelper_1.LogAdaptableWarning(`Report '${reportName}' not found!`);
+            return undefined;
+        }
+        return this.adaptable.api.internalApi.getReportService().getReportData(report);
     }
 }
 exports.ExportApiImpl = ExportApiImpl;

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

@@ -2,6 +2,7 @@ import { ApiBase } from './ApiBase';
 import { LayoutApi } from '../LayoutApi';
 import { LayoutState, Layout } from '../../PredefinedConfig/LayoutState';
 import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
+import { ColumnSort } from '../../PredefinedConfig/Common/ColumnSort';
 export declare class LayoutApiImpl extends ApiBase implements LayoutApi {
     getLayoutState(): LayoutState;
     shouldAutoSaveLayout: (layout?: Layout) => boolean;
@@ -12,6 +13,7 @@ export declare class LayoutApiImpl extends ApiBase implements LayoutApi {
     setLayout(layoutName: string): void;
     fireLayoutChangedEvent(trigger: string, oldSate: LayoutState, newState: LayoutState): void;
     getCurrentLayout(): Layout;
+    getCurrentLayoutColumnSort(columnId: string): ColumnSort['SortOrder'] | null;
     getCurrentLayoutName(): string;
     getLayoutByName(layoutName: string): Layout | null;
     getAllLayout(): Layout[];
@@ -30,5 +32,6 @@ export declare class LayoutApiImpl extends ApiBase implements LayoutApi {
     createDefaultLayoutIfNeeded(): Layout | null;
     showChangeColumnCaption(column: AdaptableColumn): void;
     showLayoutPopup(): void;
+    showLayoutEditor(): void;
     isCurrentLayoutReadOnly(): boolean;
 }

package/src/Api/Implementation/LayoutApiImpl.js

@@ -5,6 +5,7 @@ const tslib_1 = require("tslib");
 const LayoutRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/LayoutRedux"));
 const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
 const ApiBase_1 = require("./ApiBase");
+const PopupRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/PopupRedux"));
 const StringExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/StringExtensions"));
 const ObjectFactory_1 = tslib_1.__importDefault(require("../../Utilities/ObjectFactory"));
 const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
@@ -69,6 +70,11 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
         let layoutName = state.Layout.CurrentLayout;
         return (this.getLayoutByName(layoutName) || ObjectFactory_1.default.CreateEmptyLayout({ Name: GeneralConstants_1.DEFAULT_LAYOUT }));
     }
+    getCurrentLayoutColumnSort(columnId) {
+        var _a, _b, _c, _d;
+        const currentLayout = this.getCurrentLayout();
+        return ((_d = (_c = (_b = (_a = currentLayout === null || currentLayout === void 0 ? void 0 : currentLayout.ColumnSorts) === null || _a === void 0 ? void 0 : _a.find) === null || _b === void 0 ? void 0 : _b.call(_a, (sort) => sort.ColumnId === columnId)) === null || _c === void 0 ? void 0 : _c.SortOrder) !== null && _d !== void 0 ? _d : null);
+    }
     getCurrentLayoutName() {
         return this.getAdaptableState().Layout.CurrentLayout;
     }
@@ -243,6 +249,12 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
     showLayoutPopup() {
         this.showModulePopup(ModuleConstants.LayoutModuleId);
     }
+    showLayoutEditor() {
+        this.dispatchAction(PopupRedux.PopupShowScreen(ModuleConstants.LayoutModuleId, 'LayoutPopup', {
+            action: 'Edit',
+            source: 'Other',
+        }));
+    }
     isCurrentLayoutReadOnly() {
         const currentLayout = this.getCurrentLayout();
         if (currentLayout) {

package/src/Api/LayoutApi.d.ts

@@ -1,4 +1,4 @@
-import { AdaptableColumn } from '../../types';
+import { AdaptableColumn, ColumnSort } from '../../types';
 import { LayoutState, Layout } from '../PredefinedConfig/LayoutState';
 /**
  * Provides run-time access to the Layout Module and associated state
@@ -24,6 +24,11 @@ export interface LayoutApi {
      * @returns layout
      */
     getCurrentLayout(): Layout;
+    /**
+     * Retrieves the sort order of a column from the current layout
+     * @param columnId Column id
+     */
+    getCurrentLayoutColumnSort(columnId: string): ColumnSort['SortOrder'] | null;
     /**
      * Retrieves map with visible columns in current Layout
      */
@@ -119,15 +124,22 @@ export interface LayoutApi {
      */
     createDefaultLayoutIfNeeded(): Layout | null;
     /**
-     * Opens Layout popup screen
+     * Opens Settings Panel with Layout section selected and visible
      */
     showLayoutPopup(): void;
+    /**
+     * Opens the Layout Editor for the current Layout
+     */
+    showLayoutEditor(): void;
     /**
      * Sets a new Caption / Header for a Column (this Layout only)
      * @param columnId Column to Update
      * @param caption New Caption to display
      */
     setColumnCaption(columnId: string, caption: string): void;
+    /**
+     * Specifies where Current Layout is editable
+     */
     isCurrentLayoutReadOnly(): boolean;
     /**
      * Opens change column caption popup

package/src/Api/PlusMinusApi.d.ts

@@ -42,7 +42,7 @@ export interface PlusMinusApi {
      */
     applyPlusMinus(cells: GridCell[]): void;
     /**
-     * Opens Plus Minus popup screen
+     * Opens Settings Panel with Plus Minus section selected and visible
      */
     showPlusMinusPopup(): void;
     /**

package/src/Api/QueryApi.d.ts

@@ -36,7 +36,7 @@ export interface QueryApi {
      */
     getNamedQueryModuleReferences(namedQueryName: string): string[];
     /**
-     * Opens Query Popup screen
+     * Opens Settings Panel with Query section selected and visible
      */
     showQueryPopup(): void;
     /**

package/src/Api/QuickSearchApi.d.ts

@@ -31,7 +31,7 @@ export interface QuickSearchApi {
      */
     setQuickSearchStyle(style: AdaptableStyle): void;
     /**
-     * Opens Quick Search popup screen
+     * Opens Settings Panel with Quick Search section selected and visible
      */
     showQuickSearchPopup(): void;
 }

package/src/Api/ScheduleApi.d.ts

@@ -247,7 +247,7 @@ export interface ScheduleApi {
      */
     applySchedule(schedule: BaseSchedule, scheduleType: 'Report' | 'ipushpull' | 'Glue42' | 'Reminder' | 'OpenFin'): void;
     /**
-     * Opens Schedule popup screen
+     * Opens Settings Panel with Schedule section selected and visible
      */
     showSchedulePopup(): void;
 }

package/src/Api/ShortcutApi.d.ts

@@ -56,7 +56,7 @@ export interface ShortcutApi {
      */
     unSuspendShortcut(shortcut: Shortcut): Shortcut;
     /**
-     * Opens Shortcut popup screen
+     * Opens Settings Panel with Shortcut section selected and visible
      */
     showShortcutPopup(): void;
 }

package/src/Api/SmartEditApi.d.ts

@@ -22,7 +22,7 @@ export interface SmartEditApi {
      */
     getSmartEditValue(): number;
     /**
-     * Opens Smart Edit popup screen
+     * Opens Settings Panel with Smart Edit section selected and visible
      */
     showSmartEditPopup(): void;
     /**

package/src/Api/TeamSharingApi.d.ts

@@ -20,7 +20,7 @@ export interface TeamSharingApi {
      */
     hasTeamSharingFullRights(): boolean;
     /**
-     * Opens Team Sharing popup screen
+     * Opens Settings Panel with Team Sharing section selected and visible
      */
     showTeamSharingPopup(): void;
     /**

package/src/Api/ThemeApi.d.ts

@@ -53,7 +53,7 @@ export interface ThemeApi {
      */
     getAllTheme(): AdaptableTheme[];
     /**
-     * Opens Theme popup screen
+     * Opens Settings Panel with Theme section selected and visible
      */
     showThemePopup(): void;
 }

package/src/Utilities/Constants/DocumentationLinkConstants.js

@@ -3,12 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LicenseDocsLink = exports.PrimaryKeyDocsLink = exports.PredicateDocsLink = exports.AggregatedScalarQueryDocsLink = exports.AggregatedBooleanQueryDocsLink = exports.ObservableQueryDocsLink = exports.ScalarQueryDocsLink = exports.BooleanQueryDocsLink = exports.ExpressionEditorDocsLink = exports.HOST_URL_DOCS = void 0;
 exports.HOST_URL_DOCS = 'https://docs.adaptabletools.com';
 //export const HOST_URL_DOCS = 'http://localhost:3000';
-exports.ExpressionEditorDocsLink = `${exports.HOST_URL_DOCS}/learn/ui-expression-editor`;
-exports.BooleanQueryDocsLink = `${exports.HOST_URL_DOCS}/learn/adaptable-ql-expression#boolean-expressions`;
-exports.ScalarQueryDocsLink = `${exports.HOST_URL_DOCS}/learn/adaptable-ql-expression#scalar-expressions`;
-exports.ObservableQueryDocsLink = `${exports.HOST_URL_DOCS}/learn/adaptable-ql-expression#observable-expressions`;
-exports.AggregatedBooleanQueryDocsLink = `${exports.HOST_URL_DOCS}/learn/adaptable-ql-expression#aggregation-boolean-expressions`;
-exports.AggregatedScalarQueryDocsLink = `${exports.HOST_URL_DOCS}/learn/adaptable-ql-expression#aggregation-scalar-expressions`;
-exports.PredicateDocsLink = `${exports.HOST_URL_DOCS}/learn/adaptable-ql-predicate`;
-exports.PrimaryKeyDocsLink = `${exports.HOST_URL_DOCS}/learn/dev-guide-tutorial-primary-key`;
+exports.ExpressionEditorDocsLink = `${exports.HOST_URL_DOCS}/guide/ui-expression-editor`;
+exports.BooleanQueryDocsLink = `${exports.HOST_URL_DOCS}/guide/adaptable-ql-expression-boolean`;
+exports.ScalarQueryDocsLink = `${exports.HOST_URL_DOCS}/guide/adaptable-ql-expression-scalar`;
+exports.ObservableQueryDocsLink = `${exports.HOST_URL_DOCS}/guide/adaptable-ql-expression-observable`;
+exports.AggregatedBooleanQueryDocsLink = `${exports.HOST_URL_DOCS}/guide/adaptable-ql-expression-aggregation#aggregated-boolean-expressions`;
+exports.AggregatedScalarQueryDocsLink = `${exports.HOST_URL_DOCS}/guide/adaptable-ql-expression-aggregation#aggregated-scalar-expressions`;
+exports.PredicateDocsLink = `${exports.HOST_URL_DOCS}/guide/adaptable-ql-predicate`;
+exports.PrimaryKeyDocsLink = `${exports.HOST_URL_DOCS}/guide/dev-guide-tutorial-primary-key`;
 exports.LicenseDocsLink = `${exports.HOST_URL_DOCS}/licensing`;

package/src/agGrid/PercentBarRenderer.js

@@ -77,7 +77,8 @@ exports.getPercentBarRendererForColumn = (formatColumn, api) => {
             return this.eGui;
         }
         refresh(params) {
-            return true;
+            // by returning FALSE we force a re-render every time the cell value changes
+            return false;
         }
     };
 };

package/src/agGrid/agGridHelper.js

@@ -516,6 +516,10 @@ class agGridHelper {
                 if (definedColumnComparator) {
                     return definedColumnComparator(nodeA.key, nodeB.key);
                 }
+                const sortOder = adaptable.api.layoutApi.getCurrentLayoutColumnSort(firstGroupedColumn.columnId);
+                if (sortOder === 'Desc') {
+                    return nodeA.key > nodeB.key ? -1 : 1;
+                }
             }
             // if no comparator available, just sort alphanumerically
             if (nodeA.key == nodeB.key) {