Implement row setting

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

Author: martinRenou

ipydatagrid/datagrid.py

@@ -516,6 +516,10 @@ def get_cell_value(self, column_name, primary_key_value):
 
         Tuples should be used to index into multi-index columns."""
         row_indices = self._get_row_index_of_primary_key(primary_key_value)
+
+        if isinstance(column_name, list):
+            column_name = tuple(column_name)
+
         return [self._data["data"][row][column_name] for row in row_indices]
 
     def set_cell_value(self, column_name, primary_key_value, new_value):
@@ -529,6 +533,9 @@ def set_cell_value(self, column_name, primary_key_value, new_value):
         if not row_indices:
             return False
 
+        if isinstance(column_name, list):
+            column_name = tuple(column_name)
+
         # Iterate over all indices
         outcome = True
         for row_index in row_indices:
@@ -540,6 +547,32 @@ def set_cell_value(self, column_name, primary_key_value, new_value):
                 outcome = False
         return outcome
 
+    def set_row_value(self, primary_key_value, new_value):
+        """Sets the value for a row by and primary key.
+
+        Note: This method returns a boolean to indicate if the operation
+        was successful.
+        """
+        row_indices = self._get_row_index_of_primary_key(primary_key_value)
+        # Bail early if key could not be found
+        if not row_indices:
+            return False
+
+        # Iterate over all indices
+        for row_index in row_indices:
+            column_index = 0
+            column = DataGrid._column_index_to_name(self._data, column_index)
+            while column is not None:
+                self._data["data"][row_index][column] = new_value[column_index]
+
+                column_index = column_index + 1
+                column = DataGrid._column_index_to_name(
+                    self._data, column_index
+                )
+
+            self._notify_row_change(row_index, new_value)
+        return True
+
     def get_cell_value_by_index(self, column_name, row_index):
         """Gets the value for a single cell by column name and row index."""
         return self._data["data"][row_index][column_name]
@@ -582,6 +615,19 @@ def _notify_cell_change(self, row, column, value):
             }
         )
 
+    def _notify_row_change(self, row, value):
+        # notify front-end
+        self.comm.send(
+            data={
+                "method": "custom",
+                "content": {
+                    "event_type": "row-changed",
+                    "row": row,
+                    "value": value,
+                },
+            }
+        )
+
     def get_visible_data(self):
         """Returns a dataframe of the current View."""
         data = deepcopy(self._data)

js/core/viewbasedjsonmodel.ts

@@ -307,6 +307,34 @@ export class ViewBasedJSONModel extends MutableDataModel {
     return true;
   }
 
+  /**
+   * Updates the row value of the currently displayed View.
+   *
+   * @param row - The row index of the cell of interest.
+   *
+   * @param value - The new value to update the indicated row with.
+   *
+   */
+  setRowData(
+    row: number,
+    value: any,
+  ): boolean {
+    this.updateRowValue({
+      row: row,
+      value: value,
+    });
+    this.emitChanged({
+      type: 'cells-changed',
+      region: 'body',
+      row,
+      column: 0,
+      rowSpan: 1,
+      columnSpan: 1,
+    });
+
+    return true;
+  }
+
   public columnNameToIndex(name: string): number {
     const schema = this.dataset.schema;
     const primaryKeysLength = schema.primaryKey.length - 1;
@@ -550,6 +578,36 @@ export class ViewBasedJSONModel extends MutableDataModel {
     this.currentView = this._transformState.createView(this._dataset);
   }
 
+  /**
+   * Updates a row in the full dataset of the model.
+   *
+   * @param options - The options for this function.
+   */
+  updateRowValue(options: ViewBasedJSONModel.IUpdateRowValuesOptions): void {
+    // Create new row and add it to new dataset
+    const newRow = { ...this._dataset.data[options.row] };
+    for (const columnIndex of Array(5).keys()) {
+      newRow[this.metadata('body', 0, columnIndex)['name']] = options.value[columnIndex];
+    }
+    const newData = Array.from(this._dataset.data);
+    newData[options.row] = newRow;
+
+    this._dataset = {
+      data: newData,
+      schema: this._dataset.schema,
+    };
+
+    if (options.syncData) {
+      this.dataSync.emit({
+        type: 'cell-updated',
+      });
+    }
+
+    // We need to rerun the transforms, as the changed cells may change the order
+    // or visibility of other rows
+    this.currentView = this._transformState.createView(this._dataset);
+  }
+
   /**
    * A signal emitted when the data model has changes to sync to the kernel.
    */
@@ -704,6 +762,23 @@ export namespace ViewBasedJSONModel {
     syncData?: boolean;
   }
 
+  export interface IUpdateRowValuesOptions {
+    /**
+     * The index of the target row in the current view.
+     */
+    row: number;
+
+    /**
+     * The new value to replace the old one.
+     */
+    value: any[];
+
+    /**
+     * The flag to trigger full data sync with backend.
+     */
+    syncData?: boolean;
+  }
+
   /**
    * A type alias for a data source for a JSON data model.
    *

js/datagrid.ts

@@ -93,6 +93,13 @@ export class DataGridModel extends DOMWidgetModel {
           content.value,
         );
       }
+
+      if (content.event_type === 'row-changed') {
+        this.data_model.setRowData(
+          content.row,
+          content.value,
+        );
+      }
     });
   }
 

tests/js/datagrid.test.ts

@@ -97,6 +97,33 @@ describe('Test trait: data', () => {
     });
   });
 
+  test('Backend driven row update propagates properly', async () => {
+    const testData = Private.createBasicTestData();
+    const grid = await Private.createGridWidget({ data: testData.set1 });
+    const row = 1;
+    const value = [1.23];
+    grid.model.set('_data', testData.set2);
+
+    return new Promise<void>((resolve, reject) => {
+      grid.model.data_model.changed.connect(
+        (model: ViewBasedJSONModel, args: any) => {
+          if (args.type === 'cells-changed') {
+            const updatedValue = [model.data(args.region, args.row, 0)];
+            expect(args.row).toBe(row);
+            expect(updatedValue).toStrictEqual(value);
+            resolve();
+          }
+        },
+      );
+
+      emulateCustomCommMessage(grid.model, 'iopub', {
+        event_type: 'row-changed',
+        row: row,
+        value: value,
+      });
+    });
+  });
+
   test('Selection model updated on trait update', async () => {
     const testData = Private.createBasicTestData();
     const grid = await Private.createGridWidget({