docs(embed): drop the jargon, name the header and navigation instead
This commit is contained in:
1 parent
17bdecff89
commit
73222aa9bd
1 file changed
+4
-4
+4
-4
@@ -20,17 +20,17 @@ Open the editor as a DDC by appending `?embed=va` to the editor route:
|
|||||||
|
|
||||||
The `?embed=` parameter accepts three values:
|
The `?embed=` parameter accepts three values:
|
||||||
|
|
||||||
| Value | Chrome | Filter button | Report drives filtering and columns |
|
| Value | Data Controller header and navigation | Filter button | Report drives filtering and columns |
|
||||||
|---|---|---|---|
|
|---|---|---|---|
|
||||||
| `true` | hidden | **shown** - Data Controller's own filter builder works as usual | no |
|
| `true` | hidden | **shown** - Data Controller's own filter builder works as usual | no |
|
||||||
| `va` | hidden | **hidden** - filtering comes from the report instead | yes |
|
| `va` | hidden | **hidden** - filtering comes from the report instead | yes |
|
||||||
| `false` (or omitted) | shown | shown | no |
|
| `false` (or omitted) | shown | shown | no |
|
||||||
|
|
||||||
Chrome means the header, the back button and the sub-nav.
|
The header and navigation means the Data Controller title bar (with its user menu), the back button and the sub-nav - everything Data Controller would normally show around the grid.
|
||||||
|
|
||||||
`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=true` hides that 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:
|
`embed=va` hides the same furniture **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.
|
- **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.
|
- **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.
|
||||||
|
|||||||
Reference in new issue
Block a user