MicroStrategy ONE

Setting properties for the Table of Contents (TOC)

The following parameter and value are used to set docking properties for the Table of Contents (TOC), set the color theme to be used, and specify whether it can be closed. You do not need to explicitly set default properties. These settings only target the web view; the mobile view will ignore the settings.

This is a group-level UI setting. It can be overridden by a feature-level setting.

The values for this parameter need to be encoded in the URL, as shown in the sample below:

ui.toc=%7B%22dockedPosition%22%3A%22left%22%2C

%22canClose%22%3A%20false%2C

%22dockChangeable%22%3Afalse%2C

%22isDocked%22%3A%20true%7D

Parameter Setting Level Value Target Component Behavior

ui.toc

Group

Possible values include:

  • {"dockedPosition": "left" (default) | "right",
  • "theme": "dark" (default) | "light",
  • "canClose": true (default) | false,
  • "dockChangeable": true | false (default),
  • "isDocked": true | false (default) }

Table of Contents (TOC)

Specifies properties for the Table of Contents (TOC), such as docking properties, color theme, and whether it can be closed.

The sample URLs below show how to set different properties for the Table of Contents (TOC).

Sample URL for setting the docked position of the TOC to left

http(s)://webserver:port/webapp/app/<projectId>/<dashboardId>/[<pagekey?ui.toc=%7B%22dockedPosition%22%3A%22left%22%7D

Sample URL for specifying that the docked position of the TOC cannot be changed

http(s)://webserver:port/webapp/app/<projectId>/<dashboardId>/[<pagekey>]?ui.toc=%7B%22dockChangeable%22%3Afalse%7D

Sample URL for specifying that the TOC is docked

http(s)://webserver:port/webapp/app/<projectId>/<dashboardId>/[<pagekey>]?ui.toc=%7B%22isDocked%22%3A%20true%7D

Sample URL for specifying that the TOC cannot be closed

http(s)://webserver:port/webapp/app/<projectId>/<dashboardId>/[<pagekey>]?ui.toc=%7B%22canClose%22%3A%20false%7D

Sample URL for specifying that the color theme of the TOC is light

http(s)://webserver:port/webapp/app/<projectId>/<dashboardId>/[<pagekey>]?ui.toc=%7B%22theme%22%3A%20light%7D