.input_column_sort() -> .input_sort(); .input_column_filter() -> .input_filter()

Author: schloerke

CHANGELOG.md

@@ -11,15 +11,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 * Restored `@render.data_frame`'s (prematurely removed in v0.9.0) input value `input.<ID>_selected_rows()`. Please use `<ID>.input_cell_selection()["rows"]` and consider `input.<ID>_selected_rows()` deprecated. (#1345, #1377)
 
-* `@render.data_frame`'s input value `input.<ID>_data_view_indices` has been renamed to `input.<ID>_data_view_rows` for consistent naming. Please use `input.<ID>_data_view_rows` and consider `input.<ID>_data_view_indices` deprecated. (#1377)
-
-* `@render.data_frame`'s input value `input.<ID>_data_view_indices` has been renamed to `input.<ID>_data_view_rows` for consistent naming. Please use `input.<ID>_data_view_rows` and consider `input.<ID>_data_view_indices` deprecated. (#1374)
-
-* Restored `@render.data_frame`'s (prematurely removed in v0.9.0) input value `input.<ID>_selected_rows()`. Please use `<ID>.input_cell_selection()["rows"]` and consider `input.<ID>_selected_rows()` deprecated. (#1345)
+* Some of `@render.data_frame`'s input values have been renamed for consistent naming. Please consider any old value deprecated. (#1374)
+  * `input.<ID>_data_view_indices` has been renamed to `input.<ID>_data_view_rows` (#1377)
+  * `input.<ID>_column_sort()` has been renamed to `input.<ID>_sort()` (#1374)
+  * `input.<ID>_column_filter()` has been renamed to `input.<ID>_filter()` (#1374)
 
 ### New features
 
-* Added `@render.data_frame`'s `.data_view_info()` which is a reactive value that contains `sort` (a list of sorted column information), `filter` (a list of filtered column information), `rows` (a list of row numbers for the sorted and filtered data frame), and `selected_rows` (`rows` that have been selected by the user). (#1374)
+* `@render.data_frame` has added a few new methods:
+  * `.data_view_rows()` which is a reactive value representing the sorted and filtered row numbers. This value wraps `input.<ID>_data_view_rows()`(#1374)
+  * `.input_sort()` which is a reactive value representing the sorted column information (dictionaries containing `col: int` and `desc: bool`). This value wraps `input.<ID>_sort()`. (#1374)
+  * `.input_filter()` which is a reactive value representing the filtered column information (dictionaries containing `col: int` and `value` which is either a string or a length 2 array of at least one non-`None` number). This value wraps `input.<ID>_filter()`. (#1374)
+  * `.update_sort(sort=)` to update the sorting of the data frame. (#1374)
+  * `.update_filter(filter=)` to update the filtering of the data frame. (#1374)
 
 * Added busy indicators to provide users with a visual cue when the server is busy calculating outputs or otherwise serving requests to the client. More specifically, a spinner is shown on each calculating/recalculating output, and a pulsing banner is shown at the top of the page when the app is otherwise busy. Use the new `ui.busy_indicator.options()` function to customize the appearance of the busy indicators and `ui.busy_indicator.use()` to disable/enable them. (#918)
 

js/data-frame/index.tsx

@@ -417,6 +417,9 @@ const ShinyDataGrid: FC<ShinyDataGridProps<unknown>> = ({
         desc: sortObj.desc,
       });
     });
+    Shiny.setInputValue!(`${id}_sort`, shinySort);
+
+    // Deprecated as of 2024-05-21
     Shiny.setInputValue!(`${id}_column_sort`, shinySort);
   }, [columns, id, sorting]);
   useEffect(() => {
@@ -432,6 +435,9 @@ const ShinyDataGrid: FC<ShinyDataGridProps<unknown>> = ({
         value: filterObj.value as FilterValue,
       });
     });
+    Shiny.setInputValue!(`${id}_filter`, shinyFilter);
+
+    // Deprecated as of 2024-05-21
     Shiny.setInputValue!(`${id}_column_filter`, shinyFilter);
   }, [id, columnFilters, columns]);
   useEffect(() => {

shiny/render/_data_frame.py

@@ -334,7 +334,7 @@ def data_view(self, *, selected: bool = False) -> pd.DataFrame:
         The data frame with all the user's edit patches applied to it.
     """
 
-    input_column_sort: reactive.Calc_[tuple[ColumnSort, ...]]
+    input_sort: reactive.Calc_[tuple[ColumnSort, ...]]
     """
     Reactive value of the data frame's column sorting information.
 
@@ -424,11 +424,11 @@ def self_input_cell_selection() -> CellSelection | None:
         self.input_cell_selection = self_input_cell_selection
 
         @reactive.calc
-        def self_input_column_sort() -> tuple[ColumnSort, ...]:
+        def self_input_sort() -> tuple[ColumnSort, ...]:
             column_sort = self._get_session().input[f"{self.output_id}_column_sort"]()
             return tuple(column_sort)
 
-        self.input_column_sort = self_input_column_sort
+        self.input_sort = self_input_sort
 
         @reactive.calc
         def self_input_column_filter() -> tuple[ColumnFilter, ...]:

shiny/www/shared/py-shiny/data-frame/data-frame.js

@@ -56,7 +56,7 @@ def penguins_df():
 
     @render.code
     def sort():
-        return str(penguins_df.input_column_sort())
+        return str(penguins_df.input_sort())
 
     @render.code
     def filter():

shiny/www/shared/py-shiny/data-frame/data-frame.js.map

@@ -95,7 +95,7 @@ def _():
     def _():
         print(
             "Sorting:",
-            summary_data.input_column_sort(),
+            summary_data.input_sort(),
         )
 
     @reactive.effect