Dashboard.open

Opens specified dashboard.

Syntax

Dashboard.open( <dashboardName or dashboardTraits>, initialStructure, options );

Parameters

Parameter Type Description
dashboardName String Name of dashboard to open
dashboardTraits Dictionary Dashboard descriptor see below
initialStructure Dictionary Default preferences
options Dictionary Additional OpenURI query options, everything can be customized except type and id

Dashboard Traits

Name Type Description
name String Name of dashboard to open
category String ???

Options

Name Type Description
form String Name of dashboard form to open (intended for legacy dashboards)
new_window Boolean Open in new window or in the same

For comprehensive list see Available Keys for OpenURI

Description

Dashboard.open performs the following sequence of actions:

  • Checks if there is already Dashboard record for specified dashboard form and current user. If there is none, such record is created.
  • Opens dashboard form on this record.

Returns

This function does not return value.

Example of opening legacy dashboard

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.