docs(dashboards): say that a chart opened in the workbook keeps the dashboard's filters - #11719
Conversation
…ashboard's filters Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
Claude finished @mngr's task in 1m 7s —— View job Docs review — no blockers, 2 low-severity clarity notesCorrect place, correct site ( Review details
What's good
Findings
Security / performance / testing sections of the review checklist don't apply — this is a prose-only change with no code, no config, and no navigation edit. Not verified: I didn't run the Mintlify dev server, so rendering is unchecked. The change adds no new components or link refs, so the risk of a render break is essentially nil. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
… report's own filter bar Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
Claude finished @mngr's task in 1m 31s —— View job Docs re-review — both prior notes addressed, 2 new low-severity clarity notes
Review details
Prior threads — both resolved
What the new commit adds well
New findings
Adjacent, out of scope: line 16 still lists dashboard controls as "filters and time granularity switchers", omitting the field switcher documented in #11710 — worth a separate one-word fix, not this PR's job. Security / performance / testing don't apply — prose-only, no code, no Not verified: whether the chips actually render violet and whether they carry a label, and Mintlify rendering (dev server not run). No new components, so render risk is nil. |
…tions the edit bullet answered Review notes: colour was left as the only way to tell a carried filter from a report one, and the chips do carry a "From dashboard" tooltip — so name it and keep the tint as the at-a-glance cue. The second bullet asked "can I change this?" and answered "edit the dashboard control", which is about what viewers get, not about the person in the workbook wanting another value; those are now separate, and the multi-sentence bullets end in full stops. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
Claude finished @mngr's task in 53s —— View job Docs re-review — both prior notes fixed in
|
| Prior note | Status in 1edd5ca |
|---|---|
| Color ("in violet") was the only cue distinguishing a carried filter | Fixed — line 30 now names the durable cue, "Hovering one says From dashboard", and keeps "tinted violet to set them apart" as the secondary at-a-glance signal (resolved) |
One bullet conflated "can I change this?" with "what can viewers filter by?"; ; terminators on multi-sentence bullets |
Fixed — line 33 now answers the workbook user ("add your own filter on the same field, or change the dashboard's control and reopen"), and the viewer-facing guidance stands alone at line 36. All bullets end in full stops (resolved) |
What reads well now
- Line 33's two escape hatches are consistent with line 38's dedup/AND rule — a reader who adds their own filter on the same field can predict what happens, because the page already told them both filters apply.
- The section answers, in order: what the action does (24), what carries (28), how to recognize it (30), what it isn't (32–34), who to talk to about viewer-facing filtering (36), what happens on overlap (38), what doesn't carry (40). No gap I can find.
- Still a surgical edit to an existing page under an existing H2 on the active site, no
docs.jsonchange, no new link refs — matchesdocs-mintlify/CLAUDE.md.
Nits (not worth another inline round)
charts.mdx:16— the page's own controls list still reads "filters and time granularity switchers", omitting the field switcher. This PR's line 40 now names the field switcher explicitly, so the omission at line 16 is an in-page inconsistency the PR surfaces. One-word fix, and arguably a separate PR's job as I noted last round.charts.mdx:34— the lead-in "they are not the report's:" governs bullets 1 and 2 ("they apply…", "their values…") but not bullet 3, which starts with the UI affordance. Reads fine in practice; flagging only for completeness.
Security / performance / testing don't apply — prose-only change, no code, no config.
Not verified: whether the chips actually render violet and carry a "From dashboard" tooltip (that's a product claim I can only take from the linked enterprise PR), and Mintlify rendering — dev server not run. No new components or refs, so render risk is nil.
…eep the third bullet under its lead-in Review nits: the page's controls list predated field switchers and this PR's new paragraph names them, so the omission had become an in-page contradiction; and the third bullet opened on the UI affordance rather than continuing "they are not the report's". Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
Claude finished @mngr's task in 1m 10s —— View job Docs re-review of
|
| # | Location | Severity | Issue |
|---|---|---|---|
| 1 | charts.mdx:16 |
low | Adding field switchers to the list makes the next sentence wrong: "its value is applied to every chart whose query references the targeted dimension". Filters and granularity switchers "always target a dimension", but a field switcher targets a dimension or a measure and scopes on whichever it's set to (controls.mdx:299, 337-338). "member" covers both. inline |
| 2 | charts.mdx:34 |
low | "they can be dropped, but not kept" reads two ways — the removal doesn't stick (what the bullet then says), or you can't save one into the report (what bullet 1 already says). The rest of the bullet already earns the lead-in. inline |
Finding 1 is the more interesting one: it's a knock-on the commit created rather than an error in what it wrote. Widening a list is cheap; the sentence that generalizes over that list is where the widening has to be paid for.
Checked and fine
- "filters, time granularity switchers and field switchers" at line 16 matches
controls.mdx:297verbatim, including the absent serial comma — so the missing Oxford comma is sibling-page consistency, not a slip. Nothing to raise. - Terminology matches the taxonomy in
docs-mintlify/CLAUDE.md(Widget → Controls → Filter / Time granularity / Field switcher / Parent). Parent controls are correctly absent from line 16's list, since a parent never applies to a chart query directly (controls.mdx:165). [ref-controls]still resolves (charts.mdx:49); no new refs, nodocs.jsonchange needed.- Still a surgical edit to an existing page under an existing H2 on the active site — matches
docs-mintlify/CLAUDE.md.
Security / performance / testing / comment-hygiene sections of the checklist don't apply — prose-only change, no code, no config.
Not verified: the product claims themselves (violet tint, From dashboard on hover, Clear filter on the chip) — I can only take those from the linked enterprise PR. Mintlify rendering unchecked (dev server not run); no new components or refs, so render risk is nil.
| ## Interaction with controls | ||
|
|
||
| Charts respect the [controls][ref-controls] placed on the same dashboard — filters and time granularity switchers. A single control can drive multiple charts at once: its value is applied to every chart whose query references the targeted dimension. | ||
| Charts respect the [controls][ref-controls] placed on the same dashboard — filters, time granularity switchers and field switchers. A single control can drive multiple charts at once: its value is applied to every chart whose query references the targeted dimension. |
There was a problem hiding this comment.
Adding field switchers to this list makes the next sentence inaccurate. "its value is applied to every chart whose query references the targeted dimension" was true when the list was filters + time granularity switchers, both of which "always target a dimension" (controls.mdx:299). A field switcher targets a dimension or a measure depending on its Field Type, and scopes on whichever it is set to (controls.mdx:299, and the auto-scoping table at controls.mdx:337-338).
So a reader with a measure-mode field switcher is told, on this page, that scoping follows a dimension reference. "member" is the term controls.mdx uses for the general case and covers both.
| Charts respect the [controls][ref-controls] placed on the same dashboard — filters, time granularity switchers and field switchers. A single control can drive multiple charts at once: its value is applied to every chart whose query references the targeted dimension. | |
| Charts respect the [controls][ref-controls] placed on the same dashboard — filters, time granularity switchers and field switchers. A single control can drive multiple charts at once: its value is applied to every chart whose query references the targeted member. |
|
|
||
| - they apply to the results on screen, and are **not** saved to the report. Publishing the workbook again will not pin them onto the chart for everyone. | ||
| - their values cannot be changed in the workbook. To explore a different value, add your own filter on the same field, or change the dashboard's control and reopen the chart. | ||
| - they can be dropped, but not kept: **Clear filter** on the chip removes it for the rest of the session and the report re-runs without it. Reopening the chart from the dashboard brings the current values back. |
There was a problem hiding this comment.
"they can be dropped, but not kept" is ambiguous in a way the previous wording wasn't. Two readings, both plausible under the lead-in "they are not the report's":
- you can remove one, but you can't make the removal stick (which is what the rest of the bullet actually says — reopening brings it back);
- you can remove one, but you can't keep/save one into the report (which is bullet 1's point, already made).
The clause is trying to earn its place under the lead-in, but the rest of the bullet already does that work: a filter whose removal survives only the session is self-evidently not the report's. Dropping the prefix loses nothing.
| - they can be dropped, but not kept: **Clear filter** on the chip removes it for the rest of the session and the report re-runs without it. Reopening the chart from the dashboard brings the current values back. | |
| - **Clear filter** on the chip removes it for the rest of the session and the report re-runs without it — but the removal isn't saved either. Reopening the chart from the dashboard brings the current values back. |
Documents the behaviour shipped in cubedevinc/cubejs-enterprise#14628 (CUB-4102).
"Edit in Workbook" now carries the dashboard's filters into the report session: the report opens on the same slice the chart was showing instead of re-running unfiltered, and the carried filters are shown as a read-only From dashboard row that is never saved into the report.
The docs had no entry for "Edit in Workbook" at all, so this adds it under Updating charts — the action, and then what happens to the filters, including the two things a reader can get wrong: that these are not report filters (publishing will not pin them onto the chart) and that changing what viewers can filter by means editing the control, not the report.