Description

This PR introduces dynamic filters for the following selectors (so, all Vizro selectors except vm.DatePicker):
vm.Dropdown, vm.RadioItems, vm.Checklist, vm.Slider and vm.RangeSlider

You can test the feature by altering values in the scratch_dev/data.yaml (in the way that's described in the comment) and running the scratch_dev/app.py.

TODOs:

This PR TODOs:

• - Improve the UI of the dynamic placeholder -> 86171e0
• - Unit tests -> db017a2
• - Documentation -> [Docs] Dynamic filters #891

This or next PR TODOs (we should decide it):

• - Support dynamic for the vm.DatePicker. (Maybe it's better to wait for the dash persistence bugfix as persistence doesn't work for the vm.DatePicker even on the main branch)

Next PRs:

• - Enhance the default selector.value handling for new users. There are a few cases marked with 🟠 in this Issue -> https://github.com/McK-Internal/vizro-internal/issues/1356. There are two inconsistencies listed at the bottom of the Issue description. This TODO points to the second inconsistency.
• - Introduce "Universal Vizro placeholder component" -> https://github.com/McK-Internal/vizro-internal/issues/1307
• - Fix the multi=False vm.Dropdown dynamic selector bug when the value is cleared. This will be solved when Vizro universal placeholder component become introduced.
• - Enable dynamic filter to work with the empty data_frame.
• - Propagate data_frame Parameter default values from the model_manager into the DM._multi_load() that's called from the vm.Filter.pre_build(). -> PoC can be found in the comment.
• - Implement "Select ALL" for the multi=True categorical selectors.
• - Implement "Select the entire range" for the multi=True numerical selectors.
• - Enhance filter.build UI for the returned object. -> [Feat] Enable dynamic filter #879 (comment), [Feat] Enable dynamic filter #879 (comment)

References:

• Miro board link
• poc branch for testing dash persistence mechanism -> https://github.com/mckinsey/vizro/tree/poc/dynamic-filter
• poc branch where the default selector value for a the new user is aligned with new dynamic min/max https://github.com/mckinsey/vizro/tree/feat/dynamic-filter-slider-support-for-new-user - This improvement can wait until dash persistence bug is fixed.

Open questions:

1. How to enable dynamic Parameters? Should we allow, for example, the "options" property of a categorical parameter selector to be a function that dynamically calculates and returns new options?
2. How to enable a dynamic filter to be targeted by any predefined action? For example the parameter_action target. Or like this: update_figures(targets=[”filter_1_id”])
3. What exactly is a new way of dash persistence handling we expect (this fix will be implemented by us)?
4. If we introduce the data_frame property for the vm.Filter component, and if the data_frame Parameters change the targeting form to data_manager_key.function_argument, does is mean that our dynamic Filters could be handled in a same way as any other dynamic figure components?

Notice

• I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":

  • I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.
  • I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorized to submit this contribution on behalf of the original creator(s) or their licensees.
  • I certify that the use of this contribution as authorized by the Apache 2.0 license does not violate the intellectual property rights of anyone else.
  • I have not referenced individuals, products or companies in any commits, directly or indirectly.
  • I have not added data or restricted code in any commits, directly or indirectly.