canvas-datagrid 0.3.20 → 0.3.24

package/dist/types.d.ts

@@ -505,6 +505,11 @@ declare class canvasDatagrid {
      * @param offsetY - The number of rows to offset the selection.
      */
     static moveSelection(offsetX: number, offsetY: number): void;
+    /**
+     * Deletes currently selected data.
+     * @param dontDraw - Suppress the draw method after the selection change.
+     */
+    static deleteSelectedData(dontDraw: boolean): void;
     /**
      * Moves data in the provided selection to another position in the grid.  Moving data off the edge of the schema (columns/x) will truncate data.
      * @param sel - 2D array representing selected rows and columns.  `canvasDatagrid.selections` is in this format and can be used here.

package/lib/button.js

@@ -150,6 +150,7 @@ export default function (self) {
         if (item.click) {
           menuItemContainer.addEventListener('click', function (ev) {
             item.click.apply(self, [ev]);
+            self.disposeButton();
           });
         }
       }

package/lib/docs.js

@@ -460,6 +460,14 @@
  * @param {object} e.boundRowIndexMap Mapping of view data row to bound data row index.
  * @param {object} e.boundColumnIndexMap Mapping of view column order to bound column order.
  */
+/**
+ * Fires when the selected is deleted by pressing backspace or delete key.
+ * @event
+ * @name canvasDatagrid#afterdelete
+ * @param {object} e Event object.
+ * @param {object} e.ctx Canvas context.
+ * @param {array} e.cells Cells affected by the delete action. Each item in the array is a tuple of [rowIndex, columnIndex, boundRowIndex, boundColumnIndex].
+ */
 /**
  * Fires when the user clicks on the "drill in" arrow.  When the arrow is clicked a new
  * grid is created and nested inside of the row.  The grid, the row data and row index are passed
@@ -552,7 +560,7 @@
  * @name canvasDatagrid#afterpaste
  * @param {object} e Event object
  * @param {object} e.ctx Canvas context.
- * @param {array} e.cells Cells affected by the paste action. Each item in the array is a tuple of [rowIndex, columnIndex].
+ * @param {array} e.cells Cells affected by the paste action. Each item in the array is a tuple of [rowIndex, columnIndex, boundRowIndex, boundColumnIndex].
  */
 /**
  * Fired just before a cell is drawn onto the canvas.  `e.preventDefault();` prevents the cell from being drawn.

package/lib/events/index.js

@@ -472,10 +472,18 @@ export default function (self) {
         };
         if (
           cell.isFilterable &&
-          x > cell.x + cell.width - self.style.filterButtonWidth &&
-          x < cell.x + cell.width &&
-          y > cell.y + cell.height - self.style.filterButtonHeight &&
-          y < cell.y + cell.height
+          x >
+            cell.x +
+              cell.width +
+              self.canvasOffsetLeft -
+              self.style.filterButtonWidth &&
+          x < cell.x + cell.width + self.canvasOffsetLeft &&
+          y >
+            cell.y +
+              cell.height +
+              self.canvasOffsetTop -
+              self.style.filterButtonHeight &&
+          y < cell.y + cell.height + self.canvasOffsetTop
         ) {
           self.hovers.onFilterButton = true;
           self.draw();
@@ -789,7 +797,26 @@ export default function (self) {
     }
     self.ellipsisCache = {};
   };
-  self.stopDragResize = function () {
+  self.stopDragResize = function (event) {
+    const pos = self.getLayerPos(event);
+
+    if (self.dragMode === 'ew-resize') {
+      const hasMoved = !!(pos.x - self.dragStart.x);
+      // Check that dragItem is selected or part of selection.
+      const dragItemIsSelected = self.isColumnSelected(
+        self.dragItem.columnIndex,
+      );
+
+      if (hasMoved && dragItemIsSelected) {
+        const width = Math.max(
+          self.resizingStartingWidth + pos.x - self.dragStart.x,
+          self.style.minColumnWidth,
+        );
+        // If the column is selected, resize it to width plus any other selected columns.
+        self.fitSelectedColumns(width);
+      }
+    }
+
     self.resize();
     document.body.removeEventListener(
       'mousemove',
@@ -1420,6 +1447,8 @@ export default function (self) {
       self.selectNone();
     } else if (ctrl && e.key === 'a') {
       self.selectAll();
+    } else if (['Backspace', 'Delete'].includes(e.key)) {
+      self.deleteSelectedData();
     } else if (e.key === 'ArrowDown') {
       y += 1;
     } else if (e.key === 'ArrowUp') {
@@ -1599,7 +1628,17 @@ export default function (self) {
       self.currentCell.context === 'ew-resize' &&
       self.currentCell.style === 'columnHeaderCell'
     ) {
-      self.fitColumnToValues(self.currentCell.header.name);
+      // Check that double-clicked cell is selected or part of selection.
+      const currentCellIsSelected = self.isColumnSelected(
+        self.currentCell.columnIndex,
+      );
+
+      if (currentCellIsSelected) {
+        // There might be more
+        self.fitSelectedColumns();
+      } else {
+        self.fitColumnToValues(self.currentCell.header.name);
+      }
     } else if (
       self.currentCell.context === 'ew-resize' &&
       self.currentCell.style === 'cornerCell'
@@ -1831,105 +1870,40 @@ export default function (self) {
       self.draw();
     });
   };
-  self.cut = function (e) {
-    self.copy(e);
-    const schema = self.getSchema();
+  self.cut = function (event) {
+    if (self.dispatchEvent('cut', { NativeEvent: event })) {
+      return;
+    }
 
-    var affectedCells = [];
-    for (const [rowIndex, row] of self.selections.entries()) {
-      if (!row) continue;
+    // Expecting instance of `ClipboardEvent` with `clipboardData` attribute
+    if (!self.hasFocus || !event.clipboardData) {
+      return;
+    }
 
-      const boundRowIndex = self.getBoundRowIndexFromViewRowIndex(rowIndex);
+    self.copySelectedCellsToClipboard(event.clipboardData);
 
-      for (const columnIndex of row) {
-        const boundColumnIndex = self.getBoundColumnIndexFromViewColumnIndex(
-          columnIndex,
-        );
-        const colName = schema[boundColumnIndex].name;
-
-        self.viewData[rowIndex][colName] = '';
+    const affectedCells = self.clearSelectedCells();
 
-        affectedCells.push([
-          rowIndex,
-          columnIndex,
-          boundRowIndex,
-          boundColumnIndex,
-        ]);
-      }
-    }
+    self.dispatchEvent('aftercut', {
+      cells: affectedCells,
+    });
 
-    if (self.dispatchEvent('cut', { NativeEvent: e, cells: affectedCells })) {
-      return;
-    }
+    requestAnimationFrame(() => self.draw());
+    event.preventDefault();
   };
-  self.copy = function (e) {
-    if (self.dispatchEvent('copy', { NativeEvent: e })) {
+  self.copy = function (event) {
+    if (self.dispatchEvent('copy', { NativeEvent: event })) {
       return;
     }
-    if (!self.hasFocus || !e.clipboardData) {
+
+    // Expecting instance of `ClipboardEvent` with `clipboardData` attribute
+    if (!self.hasFocus || !event.clipboardData) {
       return;
     }
-    var t = '',
-      d = '',
-      textRows = [],
-      sData = self.getSelectedData(),
-      s = self.getSchema(),
-      sSorted = [],
-      firstRowKeys,
-      isNeat = true; // Selected like [[0, 1], [0, 1]] of [[0, 3]] is neat; Selected like [[0, 1], [1, 2]] is untidy
-    function htmlSafe(v) {
-      if (typeof v === 'number') return v;
-      return v.replace(/</g, '&lt;').replace(/>/g, '&gt;');
-    }
-    s.forEach(function (column, columnIndex) {
-      sSorted.push(s[self.orders.columns[columnIndex]]);
-    });
-    if (sData.length > 0) {
-      sData.forEach((row) => {
-        if (!row) return;
-        var rowKeys = Object.keys(row);
-        var textRow = [];
-        if (!firstRowKeys) firstRowKeys = Object.keys(row);
-        if (isNeat && rowKeys.length !== firstRowKeys.length) isNeat = false;
-        sSorted.forEach(function (column, columnIndex) {
-          if (rowKeys.indexOf(String(column.name)) < 0) {
-            if (firstRowKeys.indexOf(String(column.name)) < 0) {
-              return;
-            } else if (isNeat) {
-              isNeat = false;
-            }
-          }
-          textRow.push(row[column.name] || '');
-        });
-        textRows.push(textRow);
-      });
-      if (isNeat) {
-        t = textRows.map((row) => row.join('\t')).join('\n');
-        /**
-         * The html content copied by Excel has not header
-         */
-        d += '<table>';
-        d += textRows
-          .map(
-            (row) =>
-              '<tr>' +
-              row.map((value) => '<td>' + htmlSafe(value) + '</td>').join('') +
-              '</tr>',
-          )
-          .join('');
-        d += '</table>';
-      } else {
-        t = textRows.map((row) => row.join('')).join('');
-        d = t;
-      }
-      if (t) {
-        e.clipboardData.setData('text/html', d);
-        e.clipboardData.setData('text/plain', t);
-        e.clipboardData.setData('text/csv', t);
-        e.clipboardData.setData('application/json', JSON.stringify(sData));
-      }
-      e.preventDefault();
-    }
+
+    self.copySelectedCellsToClipboard(event.clipboardData);
+
+    event.preventDefault();
   };
   return;
 }

package/lib/events/util.js

@@ -86,11 +86,49 @@ const parseData = function (data, mimeType) {
   return parseText(data);
 };
 
+const htmlSafe = function (value) {
+  if (typeof value === 'number') return value;
+  return value.replace(/</g, '&lt;').replace(/>/g, '&gt;');
+};
+
+const createTextString = function (selectedData, isNeat) {
+  // Selected like [[0, 1], [0, 1]] of [[0, 3]] is neat; Selected like [[0, 1], [1, 2]] is untidy.
+  // If not isNeat we just return a simple string of concatenated values.
+  if (!isNeat)
+    return selectedData.map((row) => Object.values(row).join('')).join('');
+
+  // If isNeat, we can create tab separated mutti-line text.
+  return selectedData.map((row) => Object.values(row).join('\t')).join('\n');
+};
+
+const createHTMLString = function (selectedData, isNeat) {
+  if (!isNeat) return createTextString(selectedData, isNeat);
+
+  // If isNeat, we can create a HTML table with the selected data.
+  let htmlString = '<table>';
+  htmlString += selectedData
+    .map(
+      (row) =>
+        '<tr>' +
+        Object.values(row)
+          .map((value) => '<td>' + htmlSafe(value) + '</td>')
+          .join('') +
+        '</tr>',
+    )
+    .join('');
+  htmlString += '</table>';
+
+  return htmlString;
+};
+
 export {
+  createTextString,
+  createHTMLString,
   isSupportedHtml,
-  sanitizeElementData,
+  htmlSafe,
   parseData,
   parseHtmlTable,
   parseHtmlText,
   parseText,
+  sanitizeElementData,
 };

package/lib/intf.js

@@ -2,6 +2,8 @@
 /*globals HTMLElement: false, Reflect: false, define: true, MutationObserver: false, requestAnimationFrame: false, performance: false, btoa: false*/
 'use strict';
 
+import { createHTMLString, createTextString } from './events/util';
+
 export default function (self, ctor) {
   self.scale = 1;
   self.orders = {
@@ -242,6 +244,89 @@ export default function (self, ctor) {
 
     return selectedCells;
   };
+  self.copySelectedCellsToClipboard = function (clipboardData) {
+    const selectedData = [];
+    const schema = self.getSchema();
+    let firstRowAsString;
+    let isNeat = true; // Selected like [[0, 1], [0, 1]] of [[0, 3]] is neat; Selected like [[0, 1], [1, 2]] is untidy
+
+    for (const [rowIndex, row] of self.selections.entries()) {
+      // If no cells are selected for a particular rowIndex the selections array will contain an empty element for that rowIndex.
+      if (!row) continue;
+
+      // Convert to string for easy comparison to the first row.
+      const rowAsString = row.join(',').toString();
+      const rowDict = {};
+
+      if (!firstRowAsString) firstRowAsString = row.join(',').toString();
+      if (isNeat && rowAsString !== firstRowAsString) isNeat = false;
+
+      const boundRowIndex = self.getBoundRowIndexFromViewRowIndex(rowIndex);
+
+      for (let columnIndex of row) {
+        // If the whole row is selected the columnIndex for the rowHeader is -1.
+        if (columnIndex < 0) continue;
+
+        const boundColumnIndex = self.getBoundColumnIndexFromViewColumnIndex(
+          columnIndex,
+        );
+        const columnName = schema[boundColumnIndex].name;
+
+        const value = self.originalData[boundRowIndex][columnName];
+
+        rowDict[columnName] = value;
+      }
+      selectedData.push(rowDict);
+    }
+
+    if (selectedData.length > 0) {
+      const textString = createTextString(selectedData, isNeat);
+      const htmlString = createHTMLString(selectedData, isNeat);
+
+      const copiedData = {
+        'text/plain': textString,
+        'text/html': htmlString,
+        'text/csv': textString,
+        'application/json': JSON.stringify(selectedData),
+      };
+
+      for (const [mimeType, data] of Object.entries(copiedData)) {
+        clipboardData.setData(mimeType, data);
+      }
+    }
+  };
+  self.clearSelectedCells = function () {
+    const schema = self.getSchema();
+    const affectedCells = [];
+
+    for (const [rowIndex, row] of self.selections.entries()) {
+      // If no cells are selected for a particular rowIndex the selections array will contain an empty element for that rowIndex.
+      if (!row) continue;
+
+      const boundRowIndex = self.getBoundRowIndexFromViewRowIndex(rowIndex);
+
+      for (let columnIndex of row) {
+        // If the whole row is selected the columnIndex for the rowHeader is -1.
+        if (columnIndex < 0) continue;
+
+        const boundColumnIndex = self.getBoundColumnIndexFromViewColumnIndex(
+          columnIndex,
+        );
+        const columnName = schema[boundColumnIndex].name;
+
+        self.viewData[boundRowIndex][columnName] = '';
+
+        affectedCells.push([
+          rowIndex,
+          columnIndex,
+          boundRowIndex,
+          boundColumnIndex,
+        ]);
+      }
+    }
+
+    return affectedCells;
+  };
   self.getBoundRowIndexFromViewRowIndex = function (viewRowIndex) {
     if (self.boundRowIndexMap && self.boundRowIndexMap.has(viewRowIndex)) {
       return self.boundRowIndexMap.get(viewRowIndex);
@@ -311,6 +396,27 @@ export default function (self, ctor) {
   self.createRowOrders = function () {
     self.orders.rows = fillArray(0, self.originalData.length - 1);
   };
+  self.fitSelectedColumns = function (width) {
+    const selectedColumns = self.selections[0];
+    const schema = self.getSchema();
+
+    for (const selectedColumn of selectedColumns) {
+      // Make sure the column is not the row header and that the whole column has in fact been selected.
+      if (selectedColumn >= 0 && self.isColumnSelected(selectedColumn)) {
+        if (isNaN(width)) {
+          const column = schema[self.orders.columns[selectedColumn]];
+          self.fitColumnToValues(column.name);
+        } else {
+          self.sizes.columns[selectedColumn] = width;
+          self.dispatchEvent('resizecolumn', {
+            x: width,
+            y: self.resizingStartingHeight,
+            draggingItem: self.currentCell,
+          });
+        }
+      }
+    }
+  };
   self.getVisibleSchema = function () {
     return self.getSchema().filter(function (col) {
       return !col.hidden;
@@ -557,6 +663,7 @@ export default function (self, ctor) {
     self.controlInput.removeEventListener('keypress', self.keypress, false);
     self.controlInput.removeEventListener('keyup', self.keyup, false);
     self.controlInput.removeEventListener('keydown', self.keydown, false);
+    document.body.removeEventListener('mousemove', self.mousemove);
     window.removeEventListener('resize', self.resize);
     if (self.observer && self.observer.disconnect) {
       self.observer.disconnect();
@@ -734,6 +841,7 @@ export default function (self, ctor) {
     self.pointerLockPosition = { x: 0, y: 0 };
     Object.keys(self.style).forEach(self.parseStyleValue);
     self.intf.moveSelection = self.moveSelection;
+    self.intf.deleteSelectedData = self.deleteSelectedData;
     self.intf.moveTo = self.moveTo;
     self.intf.addEventListener = self.addEventListener;
     self.intf.removeEventListener = self.removeEventListener;

package/lib/publicMethods.js

@@ -734,9 +734,23 @@ export default function (self) {
     if (!self.canvas) {
       return;
     }
-    self.sizes.columns[
-      name === 'cornerCell' ? -1 : self.getHeaderByName(name).index
-    ] = Math.max(self.findColumnMaxTextLength(name), self.style.minColumnWidth);
+
+    const columnIndex =
+      name === 'cornerCell' ? -1 : self.getHeaderByName(name).index;
+
+    const newSize = Math.max(
+      self.findColumnMaxTextLength(name),
+      self.style.minColumnWidth,
+    );
+
+    self.sizes.columns[columnIndex] = newSize;
+
+    self.dispatchEvent('resizecolumn', {
+      x: newSize,
+      y: self.resizingStartingHeight,
+      draggingItem: self.currentCell,
+    });
+
     if (!internal) {
       self.resize();
       self.draw(true);
@@ -856,6 +870,26 @@ export default function (self) {
     });
     self.selections = sel;
   };
+  /**
+   * Deletes currently selected data.
+   * @memberof canvasDatagrid
+   * @name deleteSelectedData
+   * @method
+   * @param {boolean} dontDraw Suppress the draw method after the selection change.
+   */
+  self.deleteSelectedData = function (dontDraw) {
+    const affectedCells = self.clearSelectedCells();
+
+    self.dispatchEvent('afterdelete', {
+      cells: affectedCells,
+    });
+
+    if (dontDraw) {
+      return;
+    }
+
+    requestAnimationFrame(() => self.draw());
+  };
   /**
    * Moves data in the provided selection to another position in the grid.  Moving data off the edge of the schema (columns/x) will truncate data.
    * @memberof canvasDatagrid

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "canvas-datagrid",
-  "version": "0.3.20",
+  "version": "0.3.24",
   "description": "Canvas based data grid web component. Capable of displaying millions of contiguous hierarchical rows and columns without paging or loading, on a single canvas element.",
   "main": "./dist/canvas-datagrid.js",
   "module": "./dist/canvas-datagrid.module.js",