How to include/exclude menu options and UI elements in TIBCO Spotfire Web Player (web client)

How to include/exclude menu options and UI elements in TIBCO Spotfire Web Player (web client)

book

Article ID: KB0072303

calendar_today

Updated On:

Products Versions
Spotfire Web Player 10.3 and higher

Description

This article briefly describes how to include/exclude the UI elements and menu options as mentioned in the image below when viewing Spotfire dashboards in Web Player.

User-added image

Issue/Introduction

This article describes how to use the options parameter to include or exclude menu options and UI elements in TIBCO Spotfire Web Player (web client)

Environment

All

Resolution

To include/exclude menu options and UI elements for analysis, do the following:

1. Open the dashboard in Web Player, go to File >> Share >> Copy link.
2. In the Copy link dialog, click on Advanced >> go to 'Include the following UI elements' section and uncheck the elements you don't need.
3. Similarly in 'Include the following menu options' section, you can disable the options you want to hide.
4. When you uncheck the elements, the URL in 'Link to analysis' will be modified. You can also see the changes getting reflected in the 'HTML embed code' at the same time.
5. Copy the updated URL from 'Link to analysis' and paste it into another browser tab.
6. Now you can see the dashboard with those elements removed from it.

User-added image

This all works by appending an “options” parameter to the analysis URL, which contains value pairs for each option and if it should be shown or not (“1” to show the item (default), "0" to hide it). 
Using the method described above, this is created automatically for you, but you could also create this manually.  

Example to hide the status bar and close button:
https://www.example.com/spotfire/wp/OpenAnalysis?file=/Test/myanalysis&options=2-0,13-0

Example to hide the Close, Logout and Edit button: 
http://www.example.com/SpotfireWeb/ViewAnalysis.aspx?file=/folder/samplefile&options=13-0,14-0,15-0

Here is a list of available options and their respective codes:
Header 1
Status bar 2
Toolbar 3
Page navigation 4
Filter panel 5
Details on demand 6
Undo\Redo 7
Export visualization image 8
Analysis information 9
Download as DXP file 10
Help 11
About 12
Close 13
Logout 14
Edit button 15
Collaboration 17
Toolbar menus 18

Additional Information