Dashboard window properties

The GainSeeker Charts module features multiple options for versatile dashboard design that were developed specifically for GainSeeker Suite users.

 

Contents  [Hide]

 

The Properties dialog opens anytime the dashboard window is open in design/edit mode. it is used to change settings for a dashboard window.

Adding a background Image to a dashboard window

You can add a background image to a dashboard window.

To add an image:

To remove a selected image from the background of the control:

Note: You can use the BackroundImageLayout property to determine how the image displays:

Adding a Caption to a dashboard window

You can use the Caption property in the Appearance section to display a label that is different from the name of the dashboard, in these areas:

If the Caption property is left blank, these areas will display the name of the dashboard.

To set a Caption for the dashboard, click the value cell opposite the Caption property. Then, type the text for the caption in the value cell.

To remove the Caption for a dashboard, click the value cell. Then, select all the caption text and delete it from the cell.

Note: The Caption you set for a dashboard will not alter the dashboard name—the name of the dashboard you opened on the Open Dashboard dialog. To change a dashboard name, see copying a dashboard.

Using Behavior properties

Note: GainSeeker Publish is required for the PythonRunAtRefresh, PythonRunBefore, TemplateRunAfter, TemplateRunBefore, and TimerFileNameExport properties.

Locking a dashboard

On the Properties dialog, set the Locked property value in the Data category to True to lock a dashboard so that its properties can only be changed by users whose role is set to enable changing of locked items. Those who do not have rights will receive an informational dialog stating that the dashboard is locked if they attempt to change it.

To change the properties of a locked dashboard if you have the rights:

  1. Click the dashboard name in the list field of the Open Dashboard dialog

  2. Click the Edit... button on the dialog. That dashboard will open in design/edit mode where you can make changes to the properties. For more information, see Editing a dashboard window

Even if you have rights to change locked items, you will be unable to switch a dashboard to design/edit mode from run (view) mode using the right-click menu Design Dashboard... option for that dashboard. Refer to steps 1 and 2 above for information about opening a locked dashboard in design/edit mode to make changes to it.

You can use the Show locked... button on the Open Dashboard dialog to display a list of saved dashboards to which you have access that are locked. For more information, see Show locked...

Using the LockedControls setting

If you are creating a dashboard with multiple controls similar to this example, you may want to size and position your finished controls before creating the next dashboard control. The LockedControls property allows you to lock all the dashboard controls on a dashboard so you do not accidentally resize or move them around with your mouse as you are working in design/edit mode.

With the property set to True, you will still be able to resize or move any of the controls using these controls properties:

 

Using SnapToGrid and SnapToGridSize

When SnapToGrid is enabled, GainSeeker will automatically adjust the size and location of dashboard controls so that their edges line up with a design grid. You can also adjust the size of that design grid.

The effect on any one dashboard control may be to make it larger or smaller, and to shift its location up or down and right or left.

When the SnapToGrid property is set to True, the SnapToGrid functionality will automatically adjust:

Several properties of some dashboard controls can override aspects of the SnapToGrid functionality:

Related Topics