Setting properties for the Comment Panel

The following parameter and value are used to set docking properties for the Comment Panel and specify whether the Comment Panel 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.comment=%7B%22dockedPosition%22%3A%22left%22%2C

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

%22dockChangeable%22%3Afalse%2C

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

If ui.navigation.comment = "false", the Comment Panel will always be docked when it is open.

Parameter	Setting Level	Value	Target Component	Behavior
ui.comment	Group	Possible values include: {"dockedPosition": "left" | "right" (default), "canClose": true (default) | false, "dockChangeable": true(default) | false, "isDocked": true | false (default) }	Comment Panel	Specifies properties for the Comment Panel, such as docking properties and whether it can be closed.

The sample URLs below show how to set different properties for the Comment Panel.

Sample URL for setting the docked position of the Comment Panel to left

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

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

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

Sample URL for specifying that the Comment Panel is docked

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

Sample URL for specifying that the Comment Panel cannot be closed

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