Skip to content

docs(ui): filter the dashboards Global Filters example on the dotted path it means #17767

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

Merged
claude merged 1 commit into from
Sep 12, 2026
Merged

docs(ui): filter the dashboards Global Filters example on the dotted path it means #17767

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
10 changes: 8 additions & 2 deletions content/docs/ui/dashboards.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,15 +350,21 @@ Add interactive filter controls that apply to all widgets:
{/* os:check */}
```typescript
globalFilters: [
{ name: 'region', field: 'region', label: 'Region', type: 'select' },
// `account.region` is a DOTTED PATH walked from the bound widget's
// `dataset.object` (`opportunity`) through the `include: ['account']` the
// dataset declares. It is not the dataset's dimension that is also spelled
// `region` — a filter's `field` never reads dimension names.
{ name: 'region', field: 'account.region', label: 'Region', type: 'select' },
{ field: 'owner', label: 'Sales Rep', type: 'lookup' },
]
```

Each filter's `name` is its stable identity: the key its value is published
under as a dashboard-level variable (readable in widget expressions as
`page.<name>`) and the key widgets reference in `filterBindings`. It defaults
to `field`; the name `dateRange` is reserved for the built-in date range.
to `field`; the name `dateRange` is reserved for the built-in date range. The
filter above names itself `region` for exactly that reason — left to default it
would be keyed `account.region`, dots and all, in every expression and binding.

### Where a Filter's `field` Resolves

Expand Down
Loading