Add pre-filter option to Time Grain dashboard control

[eschutho]

For time grain controls, some users don't need all the values, or they just aren't applicable.

We'd like to add the ability to limit the options that are available in this control, as for example, not all dashboards would have hourly data.

Proposed Solution

We'd like to add the Limit time grain options option to the Time Grain control:

The dropdown should list all supported time grains for the dataset, allowing users to specify which ones should be visible. These values should also include the time grain add-ons from configs. This should look like a multi-select filter on the dashboard level where user can select Week, Day, etc. It should not ask the user to add another filter (ie value > 1 week) like the current Pre-filter available values option does.
These are the configurations currently available:

Consideration

This functionality shouldn't affect existing assets (so the new control should have an “undefined” value for complete backwards compatibility). There should also be full export/import and API support (which is likely already standard by being a filter config).

[betodealmeida]

A few comments:

• To get the list of available time grains it should be possible to reuse the dataset API: GET /api/v1/dataset/{id}
• Once we have the available time grains we can create a multi-select dropdown, with all grains enabled by default.
• The valid time grains should be stored in the dashboard model with the other configuration for the filter (dashboard.json_metadata['native_filter_configuration']).
  • If all time grains are selected we shouldn't store anything.
  • If only some time grains are selected we should store them in a new key inside native_filter_configuration.
• When the filter loads, if the new key is present it should render only those time grains.

{
  "native_filter_configuration": {
    "custom_time_grains": [ { ... }, { ... } ],  // omit when all time grains are selected
    ...
  }
}

[sfirke]

I agree with everything written here by @eschutho and @betodealmeida. I desire this feature for my use case, where our water scientists need the lowest-possible time grain, but it's not appropriate to expose that time grain to the public on e.g., our public-facing rain gauges dashboard. This feature proposal would solve this problem by allowing me to restrict the time grain choices on public-facing dashboards, reducing clutter and confusion for less-technical members of the general public.

[rusackas]