Add hide column option to context menu

Signed-off-by: gjmooney <[email protected]>

Author: gjmooney

js/core/gridContextMenu.ts

@@ -97,6 +97,13 @@ export class FeatherGridContextMenu extends GridContextMenu {
     // Add menu items based on the region of the grid that was clicked on.
     switch (hit.region) {
       case 'column-header':
+        this._menu.addItem({
+          command: FeatherGridContextMenu.CommandID.HideColumn,
+          args: args,
+        });
+        this._menu.addItem({
+          type: 'separator',
+        });
         this._menu.addItem({
           command: FeatherGridContextMenu.CommandID.SortAscending,
           args: args,
@@ -141,6 +148,17 @@ export class FeatherGridContextMenu extends GridContextMenu {
         });
         break;
       case 'corner-header':
+        this._menu.addItem({
+          command: FeatherGridContextMenu.CommandID.ShowAllColumns,
+          args: args,
+        });
+        this._menu.addItem({
+          command: FeatherGridContextMenu.CommandID.HideAllColumns,
+          args: args,
+        });
+        this._menu.addItem({
+          type: 'separator',
+        });
         this._menu.addItem({
           command: FeatherGridContextMenu.CommandID.SortAscending,
           args: args,
@@ -258,6 +276,9 @@ export namespace FeatherGridContextMenu {
     SaveSelectionAsCsv = 'saveSelectionAsCsv',
     SaveAllAsCsv = 'saveAllAsCsv',
     ClearSelection = 'clearSelection',
+    HideColumn = 'hideColumn',
+    HideAllColumns = 'hideAllColumns',
+    ShowAllColumns = 'showAllColumns',
   }
 
   /**

js/core/transform.ts

@@ -2,7 +2,10 @@
  * A declarative spec for specifying transformations.
  */
 export namespace Transform {
-  export type TransformSpec = Transform.Sort | Transform.Filter;
+  export type TransformSpec =
+    | Transform.Sort
+    | Transform.Filter
+    | Transform.Hide;
 
   /**
    * A declarative spec for the `Sort` transformation.
@@ -30,6 +33,26 @@ export namespace Transform {
     desc: boolean;
   };
 
+  /**
+   * A declarative spec for the `Hide` transformation.
+   */
+  export type Hide = {
+    /**
+     * A type alias for this trasformation.
+     */
+    type: 'hide';
+
+    /**
+     * The column in the data schema to apply the transformation to.
+     */
+    columnIndex: number;
+
+    /**
+     * Boolean indicating if all columns should be hidden
+     */
+    hideAll: boolean;
+  };
+
   /**
    * A declarative spec for the `Filter` transformation.
    */

js/core/transformExecutors.ts

@@ -1,7 +1,7 @@
 import { Dict } from '@jupyter-widgets/base';
 
-import { Transform } from './transform';
 import { DataSource } from '../datasource';
+import { Transform } from './transform';
 
 import * as moment from 'moment';
 
@@ -25,6 +25,52 @@ export namespace TransformExecutor {
   export type IData = Readonly<DataSource>;
 }
 
+export class HideExecutor extends TransformExecutor {
+  constructor(options: HideExecutor.IOptions) {
+    super();
+    this._options = options;
+  }
+
+  // input has data and schema
+  public apply(input: TransformExecutor.IData): TransformExecutor.IData {
+    const newSchema = { ...input.schema };
+
+    if (this._options.hideAll) {
+      newSchema.fields = newSchema.fields.filter(
+        (field) => field.name === 'key',
+      );
+    } else {
+      newSchema.fields = newSchema.fields.filter(
+        (field) => field.name !== this._options.field,
+      );
+    }
+
+    return new DataSource(input.data, input.fields, newSchema);
+  }
+
+  protected _options: HideExecutor.IOptions;
+}
+
+/**
+ * The namespace for the `HideExecutor` class statics.
+ */
+export namespace HideExecutor {
+  /**
+   * An options object for initializing a Hide.
+   */
+  export interface IOptions {
+    /**
+     * The name of the field to hide in the data source.
+     */
+    field: string;
+
+    /**
+     * Boolean indicating if all columns should be hidden
+     */
+    hideAll: boolean;
+  }
+}
+
 /**
  * A transformation that filters a single field by the provided operator and
  * value.

js/core/transformStateManager.ts

@@ -3,16 +3,17 @@ import { Transform } from './transform';
 import { View } from './view';
 
 import {
-  SortExecutor,
   FilterExecutor,
+  HideExecutor,
+  SortExecutor,
   TransformExecutor,
 } from './transformExecutors';
 
 import { each } from '@lumino/algorithm';
 
 import { JSONExt } from '@lumino/coreutils';
 
-import { Signal, ISignal } from '@lumino/signaling';
+import { ISignal, Signal } from '@lumino/signaling';
 import { DataSource } from '../datasource';
 
 /**
@@ -25,6 +26,7 @@ export class TransformStateManager {
       this._state[transform.column] = {
         sort: undefined,
         filter: undefined,
+        hide: undefined,
       };
     }
 
@@ -41,6 +43,9 @@ export class TransformStateManager {
       case 'filter':
         this._state[transform.column]['filter'] = transform;
         break;
+      case 'hide':
+        this._state[transform.columnIndex]['hide'] = transform;
+        break;
       default:
         throw 'unreachable';
     }
@@ -110,6 +115,7 @@ export class TransformStateManager {
   private _createExecutors(data: Readonly<DataSource>): TransformExecutor[] {
     const sortExecutors: SortExecutor[] = [];
     const filterExecutors: FilterExecutor[] = [];
+    const hideExecutors: HideExecutor[] = [];
 
     Object.keys(this._state).forEach((column) => {
       const transform: TransformStateManager.IColumn = this._state[column];
@@ -146,10 +152,17 @@ export class TransformStateManager {
         });
         filterExecutors.push(executor);
       }
+      if (transform.hide) {
+        const executor = new HideExecutor({
+          field: data.schema.fields[transform.hide.columnIndex]['name'],
+          hideAll: transform.hide.hideAll,
+        });
+        hideExecutors.push(executor);
+      }
     });
 
     // Always put filters first
-    return [...filterExecutors, ...sortExecutors];
+    return [...filterExecutors, ...sortExecutors, ...hideExecutors];
   }
 
   /**
@@ -171,10 +184,12 @@ export class TransformStateManager {
         columnState.sort = undefined;
       } else if (transformType === 'filter') {
         columnState.filter = undefined;
+      } else if (transformType === 'hide') {
+        columnState.hide = undefined;
       } else {
         throw 'unreachable';
       }
-      if (!columnState.sort && !columnState.filter) {
+      if (!columnState.sort && !columnState.filter && !columnState.hide) {
         delete this._state[column];
       }
       this._changed.emit({
@@ -229,6 +244,9 @@ export class TransformStateManager {
       if (this._state[column].filter) {
         transforms.push(this._state[column].filter!);
       }
+      if (this._state[column].hide) {
+        transforms.push(this._state[column].hide!);
+      }
     });
     return transforms;
   }
@@ -255,6 +273,7 @@ export namespace TransformStateManager {
   export interface IColumn {
     filter: Transform.Filter | undefined;
     sort: Transform.Sort | undefined;
+    hide: Transform.Hide | undefined;
   }
   export interface IState {
     [key: string]: IColumn;

js/core/view.ts

@@ -42,6 +42,7 @@ export class View {
     if (region === 'body') {
       return this._data.length;
     } else {
+      // If there are no body rows, return one for the header row
       return this._bodyFields[0]?.rows.length ?? 1;
     }
   }

js/core/viewbasedjsonmodel.ts

@@ -10,8 +10,8 @@ import { View } from './view';
 
 import { TransformStateManager } from './transformStateManager';
 
-import { ArrayUtils } from '../utils';
 import { DataSource } from '../datasource';
+import { ArrayUtils } from '../utils';
 
 /**
  * A view based data model implementation for in-memory JSON data.
@@ -76,6 +76,7 @@ export class ViewBasedJSONModel extends MutableDataModel {
    */
   updateDataset(data: DataSource): void {
     this._dataset = data;
+    // does not happen when selecting hide column
     this._updatePrimaryKeyMap();
     const view = new View(this._dataset);
     this.currentView = view;
@@ -566,6 +567,7 @@ export class ViewBasedJSONModel extends MutableDataModel {
     }
     // We need to rerun the transforms, as the changed cells may change the order
     // or visibility of other rows
+    console.log('update row value');
     this.currentView = this._transformState.createView(this._dataset);
   }
 

js/feathergrid.ts

@@ -1070,6 +1070,57 @@ export class FeatherGrid extends Widget {
         this.grid.selectionModel?.clear();
       },
     });
+    commands.addCommand(FeatherGridContextMenu.CommandID.HideColumn, {
+      label: 'Hide Column',
+      mnemonic: -1,
+      execute: (args) => {
+        const cellClick: FeatherGridContextMenu.CommandArgs =
+          args as FeatherGridContextMenu.CommandArgs;
+        const colIndex = this._dataModel.getSchemaIndex(
+          cellClick.region,
+          cellClick.columnIndex,
+        );
+        this._dataModel.addTransform({
+          type: 'hide',
+          columnIndex: colIndex,
+          hideAll: false,
+        });
+      },
+    });
+    commands.addCommand(FeatherGridContextMenu.CommandID.HideAllColumns, {
+      label: 'Hide All Columns',
+      mnemonic: -1,
+      execute: (args) => {
+        const cellClick: FeatherGridContextMenu.CommandArgs =
+          args as FeatherGridContextMenu.CommandArgs;
+        const colIndex = this._dataModel.getSchemaIndex(
+          cellClick.region,
+          cellClick.columnIndex,
+        );
+        this._dataModel.addTransform({
+          type: 'hide',
+          columnIndex: colIndex,
+          hideAll: true,
+        });
+      },
+    });
+    commands.addCommand(FeatherGridContextMenu.CommandID.ShowAllColumns, {
+      label: 'Show All Columns',
+      mnemonic: -1,
+      execute: () => {
+        const activeTransforms: Transform.TransformSpec[] =
+          this._dataModel.activeTransforms;
+        console.log(
+          'this._dataModel.activeTransforms',
+          this._dataModel.activeTransforms,
+        );
+        const newTransforms = activeTransforms.filter(
+          (val) => val.type !== 'hide',
+        );
+        console.log('newTransforms', newTransforms);
+        this._dataModel.replaceTransforms(newTransforms);
+      },
+    });
 
     return commands;
   }