Hiding Sections on a Dashboard or Document Using the URL API

There may be instances when you want to display only a MicroStrategy dashboard or document, without any other information such as navigational path, drop zones, or datasets. For example, you might want to do this when you display a MicroStrategy dashboard in a portal. You can do this using a URL parameter called hiddensections. You set the value of this parameter to the name of the section you want to hide. You can hide multiple sections by setting the value of the parameter to a comma-separated list of sections.

This value is stored in temp cookies, so it remains in effect for the duration of the session. Any subsequent request within the same http session will keep the specified sections hidden. To make the sections visible again during the same session, you need to add the hiddensections=none parameter to the URL.

The page sections you can hide on a dashboard and a document are different as described below.

• Hiding sections of an HTML5 dashboard

  

  The hiddensections parameter for an HTML5 dashboard can have the values listed below. The values are case-sensitive.

  • dockTop
  • path
  • gallery
  • datasets
  • vipane
  • editor
  • properties
  • filter

  You can hide any of these sections by including the hiddensections parameter in the URL when you run the dashboard. However, if you hide a section such as the Editor tab or the Properties tab, but leave the menu item to view this tab visible, users can toggle the section back into view. For example, if you used hiddensections=vipane, the Editor tab, the Properties tab, and the Filter tab would all be hidden. To make sure that users could not make them visible again, you would need to write code to hide the menu items as well.

  The default behavior for a dashboard is to hide the path section. When the hiddensections parameter is used in a URL, it overrides the default behavior. If you use the parameter and do not include path as a value, the path will render in the dashboard.

  
  

• Hiding sections of a document

  The hiddensections parameter for a document can have the values listed below. The values are case-sensitive.

  • path
  • dockTop