@adaptabletools/adaptable 11.0.1 → 11.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "11.0.1",
+  "version": "11.0.3",
   "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: 1646327668940;
+declare const _default: 1646417924493;
 export default _default;

package/publishTimestamp.js

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

package/src/AdaptableInterfaces/IAdaptable.d.ts

@@ -109,7 +109,7 @@ export interface IAdaptable {
     redrawBody(): void;
     redrawHeader(): void;
     redrawRow(rowNode: RowNode): void;
-    refreshCells(rowNodes: RowNode[], columns: (string | any)[], forceUpdate: boolean): void;
+    refreshCells(rowNodes: RowNode[], columns: (string | any)[], forceUpdate: boolean, suppressFlash?: boolean): void;
     setSelectedCells(): SelectedCellInfo | undefined;
     setSelectedRows(): SelectedRowInfo | undefined;
     jumpToRow(rowNode: RowNode): void;

package/src/Strategy/FormatColumnModule.js

@@ -15,6 +15,25 @@ const getFormatColumnStyleViewItems_1 = require("./Utilities/getFormatColumnStyl
 class FormatColumnModule extends AdaptableModuleBase_1.AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.FormatColumnModuleId, 'Format Column', 'format-column', 'FormatColumnPopup', 'Create a column style, display format or cell alignment', api);
+        /**
+         * Use Case: Data (cell/row) has changed
+         * Action: Any CheckboxFormatColumns need to be updated, as their disabled state may have changed
+         */
+        this.api.internalApi.getDataService().on('DataChanged', (dataChangedInfo) => {
+            const activeCheckboxColumnIds = this.api.columnApi
+                .getColumns()
+                .filter((aColumn) => {
+                const checkboxFormatColumn = this.api.formatColumnApi.getCheckBoxStyleFormatColumn(aColumn);
+                return checkboxFormatColumn && !checkboxFormatColumn.IsSuspended;
+            })
+                .map((aColumn) => aColumn.columnId);
+            // no need to refresh the CheckboxColumns if the change was triggered by one of them
+            if (!activeCheckboxColumnIds.includes(dataChangedInfo.column.columnId)) {
+                this.api.internalApi
+                    .getAdaptableInstance()
+                    .refreshCells(null, activeCheckboxColumnIds, true, true);
+            }
+        });
     }
     getModuleAdaptableObjects() {
         return this.api.formatColumnApi.getAllFormatColumn();

package/src/Utilities/Services/DataService.d.ts

@@ -16,8 +16,8 @@ export declare class DataService implements IDataService {
     CreateDataChangedEvent(dataChangedInfo: DataChangedInfo): void;
     logUndoChange(change: DataChangedInfo): void;
     extractUndoChange(change: DataChangedInfo): DataChangedInfo | undefined;
+    destroy(): void;
     private getUndoChangeKey;
     private logDataChange;
     private extractDataChangeLogEntry;
-    destroy(): void;
 }

package/src/Utilities/Services/DataService.js

@@ -57,6 +57,10 @@ class DataService {
         }
         return result;
     }
+    destroy() {
+        this.emitter.clearListeners();
+        this.emitter = null;
+    }
     getUndoChangeKey(primaryKeyValue, columnId, previousValue, newValue) {
         return JSON.stringify({
             primaryKeyValue,
@@ -77,8 +81,5 @@ class DataService {
         return Object.assign(Object.assign({}, dataChangedInfo), { rowNode,
             rowData });
     }
-    destroy() {
-        // TO DO
-    }
 }
 exports.DataService = DataService;

package/src/agGrid/Adaptable.d.ts

@@ -187,7 +187,7 @@ export declare class Adaptable implements IAdaptable {
     redrawBody(): void;
     redrawHeader(): void;
     redrawRow(rowNode: RowNode): void;
-    refreshCells(rowNodes: RowNode[], columns: (string | Column)[], forceUpdate: boolean): void;
+    refreshCells(rowNodes: RowNode[], columns: (string | Column)[], forceUpdate: boolean, suppressFlash?: boolean): void;
     jumpToRow(rowNode: RowNode): void;
     jumpToColumn(columnId: string): void;
     jumpToCell(columnId: string, rowNode: RowNode): void;

package/src/agGrid/Adaptable.js

@@ -1507,7 +1507,8 @@ class Adaptable {
         return selectedRowInfo;
     }
     setValue(dataChangedInfo) {
-        // note: because we use rownode set data value this will cause Validation to fire
+        // note: because we use RowNode.setDataValue() this will cause Validation to fire
+        // see https://www.ag-grid.com/javascript-data-grid/change-detection/#triggering-value-change-detection
         let newValue;
         let dataType = dataChangedInfo.column.dataType;
         newValue =
@@ -1959,7 +1960,7 @@ class Adaptable {
             LoggingHelper_1.ConsoleLogError('ag-grid redrawRows was unable to find some row nodes. Tried to redraw row node: ', rowNode, ex);
         }
     }
-    refreshCells(rowNodes, columns, forceUpdate) {
+    refreshCells(rowNodes, columns, forceUpdate, suppressFlash = false) {
         const api = this.gridOptions.api;
         // in order to get a fresh reference to rowNodes
         // rowNodes = this.getRowNodesForPrimaryKeys(
@@ -1969,6 +1970,7 @@ class Adaptable {
             rowNodes,
             columns: columns,
             force: forceUpdate,
+            suppressFlash,
         };
         api.refreshCells(refreshCellParams);
     }

package/src/agGrid/CheckboxRenderer.d.ts

@@ -3,6 +3,8 @@ import { AdaptableApi } from '../Api/AdaptableApi';
 import { ICellEditorComp, ICellEditorParams } from '@ag-grid-community/core/dist/cjs/es5/interfaces/iCellEditor';
 export declare const getCheckboxRendererForColumn: (columnId: string, isColumnReadOnly: boolean, api: AdaptableApi) => ICellRendererFunc;
 export declare class CheckboxEditor implements ICellEditorComp {
+    private eGui;
+    private value;
     isCancelBeforeStart(): boolean;
     init(params: ICellEditorParams): void;
     getGui(): HTMLElement;

package/src/agGrid/CheckboxRenderer.js

@@ -21,17 +21,36 @@ exports.getCheckboxRendererForColumn = (columnId, isColumnReadOnly, api) => {
                                align-items: center;
                                justify-content: center;`;
         this.eGui.appendChild(inputElement);
+        if (!inputElement.disabled) {
+            this.suppressEditEvent = this.suppressEditEvent.bind(this);
+            this.eGui.addEventListener('click', this.suppressEditEvent);
+            this.eGui.addEventListener('dblclick', this.suppressEditEvent);
+        }
     };
     CheckboxRenderer.prototype.checkedHandler = function (e) {
         let checked = e.target.checked;
         this.params.node.setDataValue(columnId, checked);
         api.formatColumnApi.fireCheckboxColumnClickedEvent(columnId, this.params.node.data, api.gridApi.getPrimaryKeyValueForRowNode(this.params.node), checked);
     };
+    CheckboxRenderer.prototype.suppressEditEvent = function (event) {
+        if (event.target === this.eGui) {
+            event.preventDefault();
+            event.stopPropagation();
+        }
+    };
     CheckboxRenderer.prototype.getGui = function () {
         return this.eGui;
     };
     CheckboxRenderer.prototype.refresh = function () {
-        return true;
+        // by returning FALSE, AG Grid will remove the component from the DOM
+        // and (re)create a new component in its place with the new value & disabled state
+        return false;
+    };
+    CheckboxRenderer.prototype.destroy = function () {
+        var _a, _b, _c, _d;
+        (_b = (_a = this.eGui) === null || _a === void 0 ? void 0 : _a.firstChild) === null || _b === void 0 ? void 0 : _b.removeEventListener('click', this.checkedHandler);
+        (_c = this.eGui) === null || _c === void 0 ? void 0 : _c.removeEventListener('click', this.suppressEditEvent);
+        (_d = this.eGui) === null || _d === void 0 ? void 0 : _d.removeEventListener('dblclick', this.suppressEditEvent);
     };
     return CheckboxRenderer;
 };
@@ -41,10 +60,30 @@ class CheckboxEditor {
         // never show the editor, we edit it via the checkbox input element
         return true;
     }
-    init(params) { }
+    // the initialisation below is not required in 99% of cases,  as the editor is never shown
+    // however, using ReactUI makes some race conditions possible, in which cases the editor will be displayed for a few milliseconds
+    // we provide this logic for those few cases (to avoid a flicker effect)
+    init(params) {
+        const adaptable = params.api.__adaptable;
+        const inputElement = document.createElement('input');
+        inputElement.type = 'checkbox';
+        inputElement.checked = params.value;
+        inputElement.disabled = adaptable.api.internalApi
+            .getAdaptableInstance()
+            .isCellEditable(params.node, params.column);
+        this.eGui = document.createElement('div');
+        this.eGui.style.cssText = `display: flex;
+                               height: 100%;
+                               align-items: center;
+                               justify-content: center;`;
+        this.eGui.appendChild(inputElement);
+        this.value = params.value;
+    }
     getGui() {
-        return undefined;
+        return this.eGui;
+    }
+    getValue() {
+        return this.value;
     }
-    getValue() { }
 }
 exports.CheckboxEditor = CheckboxEditor;

package/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "11.0.1";
+declare const _default: "11.0.3";
 export default _default;

package/version.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = '11.0.1'; // PLEASE DONT UPDATE THIS!!! - will be updated at build time with the correct version
+exports.default = '11.0.3'; // PLEASE DONT UPDATE THIS!!! - will be updated at build time with the correct version