Last updated: 2026-11-07
Information noteSTABLE.
This API is reliable and breaking changes are unlikely.
This API is reliable and breaking changes are unlikely.
return
Return value from mode related navigation methods.
Version history
| Version state | Details |
|---|---|
| Introduced | 2.1 |
Properties
success
Type: Boolean
Returns true if successful.
mode
Type: String
The new mode. Can be one of:
- qlik.navigation.EDIT
- qlik.navigation.ANALYSIS
For more details, see Members.
error
Type: String
The error code if an error occurred, for example:
- MODENOTALLOWED
errorMsg
Type: String
Error message, for example 'Mode not allowed'.