Skip to content

docs: document locking dashboard filters #651

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document locking dashboard filters #651

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions get-started/exploring-data/dashboards.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,21 @@ Until viewers have set a value for the filter, the dashboard will not run.
/>
</Frame>

#### 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.

<Info>
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.
</Info>

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).


Expand Down
Loading