Skip to main content

Navigation API

Note: If you are using Qlik Sense Business, Qlik Sense Enterprise SaaS, or Qlik Sense Enterprise on Kubernetes, see the API documentation at the Qlik Developer Portal (

This API is reliable and breaking changes are unlikely.


The Navigation API allows you to navigate within a Qlik Sense app, and is meant to be used in widgets and visualization extensions, and will not work in Mashup scenarios.

Version history

Each method and property contain information around when it was introduced, updated, deprecated or removed. A list of all relevant API changes per version release can be found in API version history.

Introduced 2.1

Getting started

The following example shows how the Navigation API can be used when creating navigation button widgets.

<div class="lui-buttongroup">
	<lui-button ng-click="navigation.nextSheet()">Next sheet</lui-button>
	<lui-button ng-click="navigation.prevSheet()">Previous sheet</lui-button>
	<lui-button ng-click="navigation.setMode('edit')">Edit mode</lui-button>


Name Type Description
analysis String Used for analysis mode.
edit String Used for edit mode.

Possible errors