URL parameters
Datagrok reads query parameters from the browser URL to control startup behavior, navigation, embedding, debugging, and more.
Startup
| Parameter | Values | Default | Description |
|---|---|---|---|
mode | embed | Hides menus, sidebars, and toolbars for iframe embeds | |
initPackageFunctions | true | false | true | Load and register package functions |
includePackages | package names | Only load the listed packages | |
excludePackages | package names | Exclude the listed packages (or all, if value is empty) | |
cmd | semicolon-separated commands | Execute commands after startup |
Package filtering
Use includePackages and excludePackages to control which packages are loaded.
Package names are delimited by spaces, commas, or hyphens. Matching is case-insensitive.
?includePackages=Chem // only load Chem
?includePackages=Chem,Bio // only load Chem and Bio
?excludePackages=Bio Chem // load everything except Bio and Chem
?excludePackages // exclude all packages
When both parameters are present, includePackages takes precedence.
Commands
The cmd parameter executes one or more commands at startup, separated by semicolons.
Parameterized commands use the command(param) syntax:
?cmd=OpenHelp
?cmd=OpenHelp;TogglePresentationMode
Navigation
| Parameter | Values | Default | Description |
|---|---|---|---|
browse | tree path | Select a node in the browse panel | |
layout | name or GUID | Apply a saved layout to the current view | |
v | viewer ID | Show a single viewer (used with mode=embed) | |
q | search text | Pre-fill the search filter in the functions browser |
Presentation
| Parameter | Values | Default | Description |
|---|---|---|---|
mode | presentation | Enter presentation mode on startup |
Authentication
These parameters are typically generated by the platform, not typed manually.
| Parameter | Description |
|---|---|
token | Auth token (removed from URL after use) |
sessionToken | Guest session token for embedded views |
sso | SSO provider name or payload |
sig | SSO signature |
code | OAuth or email confirmation code |
email | Email for signup or password reset |
action | Account action: invite, confirm |
enableOpenIdAutoLogin | Auto-login via OpenID (true by default) |
groupPassword | Group access password for signup |
shared | Entity ID shared with the user |
sharedBy | User ID of who shared it |
Debugging
| Parameter | Values | Default | Description |
|---|---|---|---|
debug | Enable debug mode (uses localhost defaults for API) | ||
debug-* | JSON value | Override a debug setting (e.g., debug-logLevel="verbose") | |
dapiUrl | URL | Override the API root URL | |
loadSrcMaps | true | false | Force-load or disable Dart source maps for stack traces | |
tests | filter pattern | Run tests matching the pattern (pipe-separated segments) |
Debug settings
Any parameter starting with debug- is JSON-decoded and applied to the
corresponding property in DebugSettings. For example:
?debug-logLevel="verbose"&debug-traceQueries=true
Running tests
The tests parameter triggers the test runner with a pipe-separated filter:
?tests=d4|Viewers|Scatter // run Scatter viewer tests
?tests=ddt|DataFrame // run DataFrame tests
Project parameters
Projects can define custom URL parameters that map to their creation script's function parameters. When you open a project URL with extra query parameters, those values are forwarded to the corresponding function inputs:
/p/user.dashboard?region=France&year=2025