416.467.9100 | Dundas Data Visualization | Login
Welcome Guest
This is the support page for the legacy Dundas Dashboard application. For assistance with the current Dundas BI application please click here.
Dashboard v5.0

This site makes extensive use of JavaScript.

Please enable JavaScript in your web browser and reload the page before proceeding.

Using the Script Console

Hide navigation
RSS
Modified on Thu, 23 May 2013 05:30 PM Categorized as Scripting
Click to return to: Documentation | Designing Dashboards


Overview

While previewing a dashboard at design-time, you can open a script console that lets you debug scripting interactions, try out new code, and more.

Note: The Script Console is similar to the Script Editor which dashboard designers use to write interaction scripts.

Activating the Script Console

To activate the script console while previewing a dashboard, click the Show/hide script console button in the top-right corner of the preview window:

The Script Console.

The Script Console.


The Script Console appears in the bottom-half of the Preview window, and initially shows:

  • A toolbar at the top.
  • A console pane for entering a script.
  • A trace pane that displays the output of TRACE statements in scripts.

Elements of the Script Console

The following figure shows the main elements of the Script Console:

Elements of the Script Console.

Elements of the Script Console.


Object Explorer

The Object Explorer lists all of the currently-available objects on your dashboard (in alphabetical order). These objects exist in the dashboard and can be manipulated by the statements you write in the editor.

The Object Explorer in the script console.

The Object Explorer in the script console.


Use the disclosure triangles to see what properties and methods are available on each object.

Expand triangles to see properties and methods.

Expand triangles to see properties and methods.


Type Explorer

The Type Explorer lists all of the currently-available types in your dashboard (in alphabetical order).

The Type Explorer in the script console.

The Type Explorer in the script console.


These types can often be used with new to create a new object.

Expand the disclosure triangles to see what properties and methods are available in each class.

The figure below shows what the different kinds of icons mean in the Type Explorer:

Type Explorer icons.

Type Explorer icons.


Tip: Hover over a property or method in the Object/Type Explorer to see its description displayed in a tooltip.

Console

Type script statements into the Console pane and click the Run button to run them.

Note: Scripts running from the console are not running as a normal dashboard interaction. There are no sender or event arguments (e), for example.

As an example, if you've got an Image control on the dashboard named Image1, you can use this script to pop up a message box telling you the dimensions:

services.ShowMessage( String.Format( "Image1 is {0} x {1}", Image1.Width, Image1.Height ), "Image1 dimensions" );

When you click the Run button, you will see this:

Message box opened from script.

Message box opened from script.


Tip: The Console supports auto-completion features just like the Script Editor.

Related topics


Click to return to: Documentation | Designing Dashboards

About Dundas | Contact Us Follow us on Twitter! | Privacy Statement | Report Site Issues

Copyright © 2009-2014 Dundas Data Visualization, Inc.