diff --git a/get-started/exploring-data/dashboards.mdx b/get-started/exploring-data/dashboards.mdx index 0b9b2e73..9388c04e 100644 --- a/get-started/exploring-data/dashboards.mdx +++ b/get-started/exploring-data/dashboards.mdx @@ -272,6 +272,21 @@ Until viewers have set a value for the filter, the dashboard will not run. /> +#### Locking a filter + +Locking a filter prevents viewers, URL parameters, and embedded SDK overrides from changing the filter's saved value. Use this when a filter is part of the dashboard's intended scope — for example, restricting an executive dashboard to a single region — and you don't want consumers to override it. + + +Filter locking is rolling out behind a feature flag. If you don't see the lock icon, contact your workspace admin or Lightdash support to enable it for your organization. + + +To lock a filter, enter edit mode and click the open padlock icon on the filter chip. The icon switches to a closed padlock to show the filter is locked. + +- **Dashboards without tabs:** the filter is locked across the whole dashboard. +- **Dashboards with tabs:** the filter is locked only on the active tab. Switch tabs to lock or unlock it elsewhere. + +In view mode, locked filters display a read-only padlock badge and cannot be edited. Any override sent through the URL or the embed SDK for a locked field is ignored, and viewers see a toast confirming the override was dropped. + To learn more about adding filters to your dashboards, check out our guide on [using filters](/guides/limiting-data-using-filters).