canvas-datagrid 0.3.25 → 0.4.3

package/dist/types.d.ts

@@ -74,6 +74,8 @@
  * @param [args.blanksText = (Blanks)] - The text that appears on the context menu for filtering blank values (i.e. `undefined`, `null`, `''`).
  * @param [args.ellipsisText = ...] - The text used as ellipsis text on truncated values.
  * @param [args.allowSorting = true] - Allow user to sort rows by clicking on column headers.
+ * @param [args.allowGroupingColumns = true] - Allow user to group columns by clicking on column headers.
+ * @param [args.allowGroupingRows = true] - Allow user to group rows by clicking on rows headers.
  * @param [args.showFilter = true] - When true, filter will be an option in the context menu.
  * @param [args.pageUpDownOverlap = 1] - Amount of rows to overlap when pageup/pagedown is used.
  * @param [args.persistantSelectionMode = false] - When true, selections will behave as if the command/control key is held down at all times. Conflicts with singleSelectionMode.
@@ -101,6 +103,18 @@
  * @param [args.clearSettingsOptionText = 'Clear saved settings'] - Text that appears on the clear settings option.
  * @param [args.showOrderByOptionTextDesc = 'Order by %s ascending'] - Text that appears on the order by descending option.
  * @param [args.showOrderByOptionTextAsc = 'Order by %s desc'] - Text that appears on the order by ascending option.
+ * @param [args.showGroupColumns = 'Group columns %s'] - Text that appears on the group columns option.
+ * @param [args.showGroupRows = 'Group row %s'] - Text that appears on the group rows option.
+ * @param [args.showRemoveGroupColumns = 'Remove group %s'] - Text that appears on the remove columns group option.
+ * @param [args.showRemoveGroupRows = 'Remove group %s'] - Text that appears on the remove rows group option.
+ * @param [args.showRemoveAllGroupColumns = 'Remove all column groups'] - Text that appears on the remove all column groups option.
+ * @param [args.showRemoveAllGroupRows = 'Remove all row groups'] - Text that appears on the remove all row groups option.
+ * @param [args.showExpandAllGroupColumns = 'Expand all column groups'] - Text that appears on the expand all column groups option.
+ * @param [args.showExpandAllGroupRows = 'Expand all row groups'] - Text that appears on the expand all row groups option.
+ * @param [args.showCollapseAllGroupColumns = 'Collapse all column groups'] - Text that appears on the collapsed all column groups option.
+ * @param [args.showCollapseAllGroupRows = 'Collapse all row groups'] - Text that appears on the collapsed all row groups option.
+ * @param [args.columnGroupIndicatorPosition = 'right'] - The position of the column group inidcator(icon), available values: 'left' and 'right'.
+ * @param [args.rowGroupIndicatorPosition = 'bottom'] - Ths position of the row group indicator(icon), available values: 'top' and 'bottom'.
  * @param [args.showOrderByOption = true] - Show an option on the context menu sort rows.
  * @param [args.showPaste = false] - Show the paste option in the context menu when applicable.
  * @param [args.schema = []] - Sets the schema. See {@link canvasDatagrid.schema}.
@@ -163,6 +177,8 @@ declare class canvasDatagrid {
         blanksText?: string;
         ellipsisText?: string;
         allowSorting?: boolean;
+        allowGroupingColumns?: boolean;
+        allowGroupingRows?: boolean;
         showFilter?: boolean;
         pageUpDownOverlap?: number;
         persistantSelectionMode?: boolean;
@@ -190,6 +206,18 @@ declare class canvasDatagrid {
         clearSettingsOptionText?: string;
         showOrderByOptionTextDesc?: string;
         showOrderByOptionTextAsc?: string;
+        showGroupColumns?: string;
+        showGroupRows?: string;
+        showRemoveGroupColumns?: string;
+        showRemoveGroupRows?: string;
+        showRemoveAllGroupColumns?: string;
+        showRemoveAllGroupRows?: string;
+        showExpandAllGroupColumns?: string;
+        showExpandAllGroupRows?: string;
+        showCollapseAllGroupColumns?: string;
+        showCollapseAllGroupRows?: string;
+        columnGroupIndicatorPosition?: string;
+        rowGroupIndicatorPosition?: string;
         showOrderByOption?: boolean;
         showPaste?: boolean;
         schema?: any[];
@@ -401,6 +429,16 @@ declare class canvasDatagrid {
      * @param imgSrc - icon path to add into button.
      */
     static addButton(columnIndex: number, rowIndex: number, offset: any, items: any, imgSrc: string): void;
+    /**
+     * Expand/Collapse CellTree.
+     * @param treeData - The array of cellTree to expand or collapse.
+     */
+    static toggleCellCollapseTree(treeData: any[]): void;
+    /**
+     * Expand/Collapse CellTree.
+     * @param treeData - The array of cellTree to expand or collapse.
+     */
+    static expandCollapseCellTree(treeData: any[]): void;
     /**
      * Scrolls the cell at cell x, row y into view if it is not already.
      * @param x - The column index of the cell to scroll into view.
@@ -478,6 +516,18 @@ declare class canvasDatagrid {
      * @returns header with the selected name, or undefined.
      */
     static getHeaderByName(name: string): header;
+    /**
+     * Hide column/columns
+     */
+    static hideColumns: any;
+    /**
+     * Hide rows
+     */
+    static hideRows: any;
+    /**
+     * Unhide rows
+     */
+    static unhideRows: any;
     /**
      * Resizes a column to fit the longest value in the column. Call without a value to resize all columns.
      * Warning, can be slow on very large record sets (1m records ~3-5 seconds on an i7).
@@ -499,6 +549,42 @@ declare class canvasDatagrid {
      * @param [dontSetStorageData] - Don't store this setting for future use.
      */
     static order(columnName: number, direction: string, sortFunction?: (...params: any[]) => any, dontSetStorageData?: boolean): void;
+    /**
+     * Grouping columns
+     * @param firstColumnName - Name of the first column to be grouped.
+     * @param lastColumnName - Name of the last column to be grouped.
+     */
+    static groupColumns(firstColumnName: number | string, lastColumnName: number | string): void;
+    /**
+     * Grouping columns
+     * @param rowIndexFrom - The row index which is the beginning of the group
+     * @param rowIndexTo - The row index which is the end of the group
+     */
+    static groupRows(rowIndexFrom: number, rowIndexTo: number): void;
+    /**
+     * Remove grouping columns
+     * @param firstColumnName - Name of the first column to be grouped.
+     * @param lastColumnName - Name of the last column to be grouped.
+     */
+    static removeGroupColumns(firstColumnName: number | string, lastColumnName: number | string): void;
+    /**
+     * Remove grouping columns
+     * @param rowIndexFrom - The row index which is the beginning of the group
+     * @param rowIndexTo - The row index which is the end of the group
+     */
+    static removeGroupRows(rowIndexFrom: number, rowIndexTo: number): void;
+    /**
+     * Toggle(expand/collapsed) grouping columns
+     * @param firstColumnName - Name of the first column to be grouped.
+     * @param lastColumnName - Name of the last column to be grouped.
+     */
+    static toggleGroupColumns(firstColumnName: number | string, lastColumnName: number | string): void;
+    /**
+     * Toggle(expand/collapsed) grouping rows
+     * @param rowIndexFrom - The row index which is the beginning of the group
+     * @param rowIndexTo - The row index which is the end of the group
+     */
+    static toggleGroupRows(rowIndexFrom: number, rowIndexTo: number): void;
     /**
      * Moves the current selection relative to the its current position.  Note: this method does not move the selected data, just the selection itself.
      * @param offsetX - The number of columns to offset the selection.
@@ -517,6 +603,16 @@ declare class canvasDatagrid {
      * @param y - The row index to start inserting the selection at.
      */
     static moveTo(sel: any[], x: number, y: number): void;
+    /**
+     * Get the column group info given column belongs to
+     * @param columnIndex - Column index.
+     */
+    static getGroupsColumnBelongsTo(columnIndex: number): { from: number; to: number; collapsed: boolean; }[];
+    /**
+     * Get the row group info given row belongs to
+     * @param rowIndex - Row index.
+     */
+    static getGroupsRowBelongsTo(rowIndex: number): { from: number; to: number; collapsed: boolean; }[];
     /**
      * Checks if a given column is visible.
      * @param columnIndex - Column index.
@@ -536,6 +632,24 @@ declare class canvasDatagrid {
      * @returns cell at the selected location.
      */
     static getVisibleCellByIndex(x: number, y: number): cell;
+    /**
+     * Get an unhide indicator at grid pixel coordinate x and y.
+     * @param x - Number of pixels from the left.
+     * @param y - Number of pixels from the top.
+     */
+    static getUnhideIndicator(x: number, y: number): void;
+    /**
+     * Get a column group at grid pixel coordinate x and y.
+     * @param x - Number of pixels from the left.
+     * @param y - Number of pixels from the top.
+     */
+    static getColumnGroupAt(x: number, y: number): void;
+    /**
+     * Get a row group at grid pixel coordinate x and y.
+     * @param x - Number of pixels from the left.
+     * @param y - Number of pixels from the top.
+     */
+    static getRowGroupAt(x: number, y: number): void;
     /**
      * Gets the cell at grid pixel coordinate x and y.  Author's note.  This function ties drawing and events together.  This is a very complex function and is core to the component.
      * @param x - Number of pixels from the left.
@@ -1108,6 +1222,7 @@ declare namespace canvasDatagrid {
      * @property [childContextMenuMarginTop = 0] - Style of childContextMenuMarginTop.
      * @property [childContextMenuArrowHTML = ►] - Style of childContextMenuArrowHTML.
      * @property [childContextMenuArrowColor = rgba(43, 48, 43, 1)] - Style of childContextMenuArrowColor.
+     * @property [columnGroupRowHeight = 25] - Style of columnGroupRowHeight.
      * @property [contextMenuChildArrowFontSize = 12px] - Style of contextMenuChildArrowFontSize.
      * @property [cellWidth = 250] - Style of cellWidth.
      * @property [contextMenuBackground = rgba(240, 240, 240, 1)] - Style of contextMenuBackground.
@@ -1162,6 +1277,8 @@ declare namespace canvasDatagrid {
      * @property [gridBackgroundColor = rgba(240, 240, 240, 1)] - Style of gridBackgroundColor.
      * @property [gridBorderColor = rgba(202, 202, 202, 1)] - Style of gridBorderColor.
      * @property [gridBorderWidth = 1] - Style of gridBorderWidth.
+     * @property [groupIndicatorColor = rgba(155, 155, 155, 1)'] - Foreground color of the group indicator(icon).
+     * @property [groupIndicatorBackgroundColor = rgba(255, 255, 255, 1)'] - Background color of the group indicator(icon).
      * @property [columnHeaderCellCapBackgroundColor = rgba(240, 240, 240, 1)] - Style of columnHeaderCellBackgroundColor.
      * @property [columnHeaderCellCapBorderColor = rgba(172, 172, 172, 1)] - Style of columnHeaderCellBackgroundColor.
      * @property [columnHeaderCellCapBorderWidth = 1] - Style of columnHeaderCellBackgroundColor.
@@ -1196,6 +1313,7 @@ declare namespace canvasDatagrid {
      * @property [reorderMarkerBorderWidth = 1.25] - Style of reorderMarkerBorderWidth.
      * @property [reorderMarkerIndexBorderColor = rgba(66, 133, 244, 1)] - Style of reorderMarkerIndexBorderColor.
      * @property [reorderMarkerIndexBorderWidth = 2.75] - Style of reorderMarkerIndexBorderWidth.
+     * @property [rowGroupColumnWidth = 25] - Style of rowGroupColumnWidth.
      * @property [rowHeaderCellBackgroundColor = rgba(240, 240, 240, 1)] - Style of rowHeaderCellBackgroundColor.
      * @property [rowHeaderCellBorderColor = rgba(152, 152, 152, 1)] - Style of rowHeaderCellBorderColor.
      * @property [rowHeaderCellBorderWidth = 0.25] - Style of rowHeaderCellBorderWidth.
@@ -1466,6 +1584,10 @@ declare namespace canvasDatagrid {
          * Style of childContextMenuArrowColor.
         */
         childContextMenuArrowColor?: string;
+        /**
+         * Style of columnGroupRowHeight.
+        */
+        columnGroupRowHeight?: number;
         /**
          * Style of contextMenuChildArrowFontSize.
         */
@@ -1682,6 +1804,14 @@ declare namespace canvasDatagrid {
          * Style of gridBorderWidth.
         */
         gridBorderWidth?: number;
+        /**
+         * Foreground color of the group indicator(icon).
+        */
+        groupIndicatorColor?: string;
+        /**
+         * Background color of the group indicator(icon).
+        */
+        groupIndicatorBackgroundColor?: string;
         /**
          * Style of columnHeaderCellBackgroundColor.
         */
@@ -1818,6 +1948,10 @@ declare namespace canvasDatagrid {
          * Style of reorderMarkerIndexBorderWidth.
         */
         reorderMarkerIndexBorderWidth?: number;
+        /**
+         * Style of rowGroupColumnWidth.
+        */
+        rowGroupColumnWidth?: number;
         /**
          * Style of rowHeaderCellBackgroundColor.
         */
@@ -2070,3 +2204,10 @@ declare namespace canvasDatagrid {
     }
 }
 
+/**
+ * Merge a new hidden row range into existed ranges array
+ * @param hiddenRowRanges - tuples: Array<[bgeinRowIndex, endRowIndex]>
+ * @param newRange - tuple: [beginRowIndex, endRowIndex]
+ */
+declare function mergeHiddenRowRanges(hiddenRowRanges: any[], newRange: number[]): boolean;
+