Use a callback function to determine whether a row should be editable or not.

Author: Tim Shawver

js/src/qgrid.widget.js

@@ -204,7 +204,6 @@ class QgridView extends widgets.DOMWidgetView {
     this.data_view = this.create_data_view(df_json.data);
     this.grid_options = this.model.get('grid_options');
     this.column_definitions = this.model.get('column_definitions');
-    this.row_edit_conditions = this.model.get('row_edit_conditions');
     this.index_col_name = this.model.get("_index_col_name");
 
     this.columns = [];
@@ -483,58 +482,12 @@ class QgridView extends widgets.DOMWidgetView {
     });
 
     // set up callbacks
-
-    // evaluate conditions under which cells in a row should be disabled (contingent on values of other cells in the same row)
-    var evaluateRowEditConditions = function(current_row, obj) {
-      var result;
-
-      for (var op in obj) {
-        if (op == 'AND') {
-            if (result == null) {
-              result = true;
-            }
-            for (var cond in obj[op]) {
-              if (cond == 'AND' || cond == 'OR' || cond == 'NOT') {
-                result = result && evaluateRowEditConditions(current_row, {[cond]: obj[op][cond]});
-              } else {
-                result = result && (current_row[cond] == obj[op][cond]);
-              }
-            }
-        } else if (op == 'OR') {
-          if (result == null) {
-            result = false;
-          }
-          var or_result = false;
-          for (var cond in obj[op]) {
-              if (cond == 'AND' || cond == 'OR' || cond == 'NAND' || cond == 'NOR') {
-                result = result || evaluateRowEditConditions(current_row, {[cond]: obj[op][cond]});
-              } else {
-                result = result || (current_row[cond] == obj[op][cond]);
-              }
-            }
-        } else if (op == 'NAND') {
-            if (result == null) {
-              result = true;
-            }
-            result = result && !evaluateRowEditConditions(current_row, {'AND': obj[op]});
-        } else if (op == 'NOR') {
-            if (result == null) {
-              result = false;
-            }
-            result = result || !evaluateRowEditConditions(current_row, {'OR': obj[op]});
-        } else {
-          alert("Unsupported operation '" + op + "' found in row edit conditions!")
-        }
-      }
-      return result;
-    }
-
-    if ( ! (this.row_edit_conditions == null)) {
-        var conditions = this.row_edit_conditions;
-        var grid = this.slick_grid;
-        this.slick_grid.onBeforeEditCell.subscribe(function(e, args) {
-            return evaluateRowEditConditions(grid.getDataItem(args.row), conditions);
-        });
+    let editable_rows = this.model.get('_editable_rows');
+    if (editable_rows && Object.keys(editable_rows).length > 0) {
+      this.slick_grid.onBeforeEditCell.subscribe((e, args) => {
+        editable_rows = this.model.get('_editable_rows');
+        return editable_rows[args.item[this.index_col_name]]
+      });
     }
 
     this.slick_grid.onCellChange.subscribe((e, args) => {

qgrid/grid.py

@@ -3,6 +3,7 @@
 import numpy as np
 import json
 
+from types import FunctionType
 from IPython.display import display
 from numbers import Integral
 from traitlets import Unicode, Instance, Bool, Integer, Dict, List, Tuple, Any
@@ -179,7 +180,7 @@ def disable():
 def show_grid(data_frame, show_toolbar=None,
               precision=None, grid_options=None,
               column_options=None, column_definitions=None,
-              row_edit_conditions=None):
+              row_edit_callback=None):
     """
     Renders a DataFrame or Series as an interactive qgrid, represented by
     an instance of the ``QgridWidget`` class.  The ``QgridWidget`` instance
@@ -234,15 +235,14 @@ def show_grid(data_frame, show_toolbar=None,
             "data_frame must be DataFrame or Series, not %s" % type(data_frame)
         )
 
-    row_edit_conditions = (row_edit_conditions or {})
     column_definitions = (column_definitions or {})
 
     # create a visualization for the dataframe
     return QgridWidget(df=data_frame, precision=precision,
                        grid_options=grid_options,
                        column_options=column_options,
                        column_definitions=column_definitions,
-                       row_edit_conditions=row_edit_conditions,
+                       row_edit_callback=row_edit_callback,
                        show_toolbar=show_toolbar)
 
 
@@ -366,6 +366,7 @@ class QgridWidget(widgets.DOMWidget):
     _df_json = Unicode('', sync=True)
     _primary_key = List()
     _columns = Dict({}, sync=True)
+    _editable_rows = Dict({}, sync=True)
     _filter_tables = Dict({})
     _sorted_column_cache = Dict({})
     _interval_columns = List([], sync=True)
@@ -391,7 +392,7 @@ class QgridWidget(widgets.DOMWidget):
     grid_options = Dict(sync=True)
     column_options = Dict(sync=True)
     column_definitions = Dict({})
-    row_edit_conditions = Dict(sync=True)
+    row_edit_callback = Instance(FunctionType, sync=False, allow_none=True)
     show_toolbar = Bool(False, sync=True)
 
     def __init__(self, *args, **kwargs):
@@ -573,6 +574,13 @@ def _update_table(self,
                                       double_precision=self.precision)
 
         self._df_json = df_json
+
+        if self.row_edit_callback is not None:
+            editable_rows = {}
+            for index, row in df.iterrows():
+                editable_rows[int(row[self._index_col_name])] = self.row_edit_callback(row)
+            self._editable_rows = editable_rows
+
         if fire_data_change_event:
             data_to_send = {
                 'type': 'update_data_view',

qgrid/tests/test_grid.py

@@ -131,6 +131,29 @@ def test_nans():
         'search_val': None
     })
 
+def test_row_edit_callback():
+    sample_df = create_df()
+
+    def can_edit_row(row):
+        return row['E'] == 'train' and row['F'] == 'bar'
+
+    view = QgridWidget(df=sample_df, row_edit_callback=can_edit_row)
+
+    view._handle_qgrid_msg_helper({
+        'type': 'sort_changed',
+        'sort_field': 'index',
+        'sort_ascending': True
+    })
+
+    expected_dict = {
+        0: False,
+        1: True,
+        2: False,
+        3: False
+    }
+
+    assert expected_dict == view._editable_rows
+
 def test_period_object_column():
     range_index = pd.period_range(start='2000', periods=10, freq='B')
     df = pd.DataFrame({'a': 5, 'b': range_index}, index=range_index)