Add a Script to Set the Dashboard Title

This applies to: Managed Dashboards, Managed Reports

This article shows you how to add a Label component to a dashboard to display a title that changes dynamically.

Specifically, you add a script that changes the label text based on the current name of the dashboard. So if the dashboard is ever renamed by a designer, the title will still be correct when the dashboard is viewed.

Script is added to the dashboard's Ready actions, which are triggered whenever the dashboard is viewed and loaded.

Create a Dashboard

For this example, create a new dashboard from the main menu.

Go to the status bar at the bottom and double click the name of the dashboard to edit it.

Type a new name Customer Orders 2015 and press Enter.

Add a Label Component

Go to the toolbar, select Components, and then select Label to add a label component to the canvas.

With the label on the canvas selected, select the Properties window.

In the text properties, make the following changes:

• Set the Font Size to x-large.

• Set the Font Weight to Bold.

Add a Script

Add script to the dashboard's Ready event using the Properties window:

1. Select the dashboard canvas, outside of any visualizations or components and open the Properties window to see the properties of the dashboard.

2. In the Actions tab select the + button to add script to run when the dashboard is Ready.

3. Select to edit the new script action, which opens in the Script Editor.

In the editor, use JavaScript like the following:

• For a script action added to a dashboard, this.control refers to the Dashboard.control property.

• The dashboard entity name is set as the label's text using the Label.labelText property.

Click Build to check for any script errors. (There's no need to save because the Script Editor auto-saves as you type.)

Test the Script

The Ready action is triggered when the dashboard is opened for viewing directly or when the page is reloaded, but not when switching between Edit and View mode.

Select Sandbox View to test the script in a new browser tab.

For more information, see:

• JavaScript API

• Use the Script Editor

• Edit Versus View Mode and Sandbox View