dc/docs.datacontroller.io
6
1 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(embed): document va_parmap and the Filter button per embed mode #26

Merged
allan merged 10 commits from docs/va-param-map into main 2026-10-28 17:56:05 +00:00
Conversation 0 Commits 10 Files Changed 4
+17 -7
1 changed files with 17 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 17bdecff89 - Show all commits
docs/embed-va.md
+17 -7
View File
@@ -20,15 +20,25 @@ Open the editor as a DDC by appending `?embed=va` to the editor route:
The `?embed=` parameter accepts three values:
| Value | Chrome | Filter button |
|---|---|---|
| `true` | hidden | **shown** - Data Controller's own filter builder works as usual |
| `va` | hidden | **hidden** - filtering comes from the report instead (see below) |
| `false` (or omitted) | shown | shown |
| Value | Chrome | Filter button | Report drives filtering and columns |
|---|---|---|---|
| `true` | hidden | **shown** - Data Controller's own filter builder works as usual | no |
| `va` | hidden | **hidden** - filtering comes from the report instead | yes |
| `false` (or omitted) | shown | shown | no |
Chrome means the header, the back button and the sub-nav. In `va` mode the editor is also VA-aware: the report's filters are captured and applied as you change selections, and the columns the grid shows can be controlled from the report's Edit Report interface. Because the report owns the filter in that mode, Data Controller's own **Filter** button is not offered - use the report's controls instead.
Chrome means the header, the back button and the sub-nav.
The two are not combined. A filter built inside Data Controller and a filter driven by the report are alternatives, not layers: applying one replaces the other, and in `va` mode the report's filter is re-applied the next time the selection changes. Showing the button there would offer a filter that silently stops applying as soon as the report is touched, which is why it is hidden rather than disabled. If you need Data Controller's own filtering, embed with `embed=true` (or with no `embed` parameter) and leave the report's parameters unassigned.
`embed=true` hides the chrome and nothing else: the editor behaves exactly as it does outside a report, including the Filter button, Add Record, and any filtering you apply yourself.
`embed=va` hides the same chrome **and** hands these over to the report:
- **filtering** - the report's filters are captured and applied as selections change, in either live mode or confirm mode (see Filter Modes below). The first table load is already filtered, so there is no unfiltered flash.
- **column visibility** - the grid shows the columns the report sends, controlled from the report's Edit Report interface; primary-key columns are always kept visible.
- **the Filter button is not offered** - filtering belongs to the report in this mode.
- **Add Record is not offered** - rows are still added from Edit mode's "Add Row".
- **a "Back to Edit table" bar** appears on the stage, approve and review pages, so a user who follows the review workflow can return to the editor without knowing Data Controller's page paths.
The two filters are not combined. A filter built inside Data Controller and a filter driven by the report are alternatives, not layers: applying one replaces the other, and in `va` mode the report's filter is re-applied the next time the selection changes. Showing the button there would offer a filter that silently stops applying as soon as the report is touched, which is why it is hidden rather than disabled.
## How VA drives the editor