Navigation button extension

The navigation button (Button for navigation) is a visualization extension that lets you add a button that navigates to another sheet, story, or website. You can also add one or more actions that will be executed before navigation. It is included in Dashboard bundle.

When to use it

The navigation button is useful when you want to provide customized navigation options, for example, if you want to go to another sheet and clear all selections.

Creating a navigation button

You can create a navigation button on the sheet you are editing.

Do the following:

1. From the assets panel, under Custom objects > Dashboard bundle drag a Button for navigation object to the sheet.

2. Select a navigation action by setting the option Navigation action in Actions and navigation > Navigation. The navigation options that are available are:

   • None: no navigation action is performed when clicking the button, but you can add another basic action.
   • Go to first sheet: open the first sheet of the app.
   • Go to next sheet: open the next sheet of the app.
   • Go to previous sheet: open the previous sheet of the app.
   • Go to last sheet: open the last sheet of the app.
   • Go to a sheet: open a specified sheet. Select which sheet to open with Select sheet.
   • Go to a sheet (defined by sheet Id): open a specified sheet defined by the sheet ID. Enter the sheet ID of the sheet to open with Sheet Id.
   • Go to a story: open a specified story. Select which sheet to open with Select story.
   • Open a website / eMail: open a specified web site. Enter the URL of the web site in Website URL. You can set if you want to open the website in the same window or in a new window with the Open in same window setting.
   • Switch to edit mode: switch to edit mode of the current sheet.
3. Set the name of the button in Label under Button layout > Label.

When you have created the navigation button, you may want to adjust its appearance and add one or more basic actions to perform before navigation.

Adding actions that are performed before navigation

You can add one or more additional actions that are performed before the navigation action under Actions and navigation > Navigation. The actions are performed in order from the top.

In all actions where you can select a field with Select field you can define the field with an expression by selecting Define field by expression in the drop-down, and then entering the expression in Field.

• Apply a bookmark: apply a bookmark that you specify with Select bookmark.
• Clear all selections: clear all selections in all fields.
• Clear selections in other fields: clear selections in all fields that are related to a field that you specify with Select field. You can choose to override locked fields with the Overwrite locked selections setting.
• Move forwards (in your selections): go one step forward in the selection history.
• Move backwards (in your selections): go one step back in the selection history.
• Clear selections in field: clear all selections in a field that you specify with Select field.
• Lock all selections: lock all selections in all fields.
• Lock a specific field: lock all selections in a field that you specify with Select field.
• Unlock all selections: unlock all selections in all fields.
• Unlock a specific field: unlock all selections in a field that you specify with Select field.
• Unlock all and clear all: unlock and clear all selections in all fields.
• Select a value in a field: select a value, specified with Value, in a field that you specify with Select field.
• Select all values in a field: select all values in a field that you specify with Select field. You can choose to override locked fields with the Overwrite locked selections setting.
• Select multiple values in a field: select multiple values, specified with a list of values separated by a semi-colon in Value, in a field that you specify with Select field.
• Select alternatives: select all alternative values in a field that you specify with Select field. You can choose to override locked fields with the Overwrite locked selections setting.
• Select a value and lock field: select a value, specified with Value, in a field that you specify with Select field, and then lock the field.
• Select excluded: select all excluded values in a field that you specify with Select field. You can choose to override locked fields with the Overwrite locked selections setting.
• Select possible values in a field: select all possible values in a field that you specify with Select field. You can choose to override locked fields with the Overwrite locked selections setting.
• Set variable value: set the value, specified with Value, of a variable that you specify with Variable name.
• Toggle field selection: toggle a value, specified with Value, in a field that you specify with Select field. You can choose to override locked fields with the Overwrite locked selections setting.

Changing appearance

You can change the appearance of the button in several ways under Button layout in the property panel:

• Change the label of the button in Label.
• Add an icon to the button by setting Show icon to On under Icon, and selecting which icon to show in Icon.

• Set size and alignment under Size and alignment.

  You can set the width of the button with Button width. Select Full Width if you want the button to be as wide as possible, and choose the position of the label with Label alignment. You can also select Auto Width if you want the button width adjusted to the length of the label text.

  Set the position of the button within the container with Button position.

• Set a condition for enabling the button by setting Use enable condition to On under Enable condition, and entering the expression to evaluate in Enable condition.

Limitations

For information about general limitations, see Limitations of visualization extension bundles supplied by Qlik.