Help Center

Display Custom Legends

The Data - Custom Legends tab of the Windows Properties dialog box is used to change the legend labels on charts. This is done to make legends more meaningful by including additional information such as node names, user names, process names etc. Custom Legends can also be used in tables to provide headings for data rows such as totals, subtotals, averages, minimum and maximum fields that are configured.

A more detailed legend label can consist of a number of components, for example:

META.NODE Busy NtCpu.BUSY% META.USERDEF01

This example illustrates a legend label that consists of the Node Name (META.NODE) followed by text "Busy", the percentage CPU busy field (NtCpu.BUSY), text "%", then the User Defined field text (USERDEF01). This example might show on the window as the following legend label:

/MYNODE Busy 90% WARNING

Each of the label components are selected by double-clicking on the appropriate data field or metafile name as listed in the 'Data Fields plus Allowed Meta Fields' box, this will add the field or meta name to the Label box at the bottom of the dialog. Free format text can also be added in the Label box if required.

Most windows that are included in the Displays that are supplied already have a legend label set. However, by using this functionality you can clear the default setting and make your own legend labels or edit the existing ones. For new windows, you can set your own legend labels.

Creating a Custom Legend

To create a Custom Legend label proceed as follows.

Open the Windows properties dialog box.

The Data tab will open by default. Select the Custom Legend sub-tab.

The Data View field provides a list of all records that have been configured for this window. If there are multiple records select the record name that this Custom Legend will apply to.

The Configured Data Fields plus Allowed Meta Fields box shows the data field and metafile names associated with the Record configured for this window (as shown in the Data View field). To use a field or meta name in the legend label, double-click on the name to add it to the legend definition as shown in the Label field at the bottom of the dialog.

The Label box shows the legend name definition. Free format text can be added to the field and meta names if required.

Clear Button
Clears current legend name definition.

Default Button
Inserts the default legend name.

After this dialog box has been completed choose the OK button to save the data or select another tab to complete the window properties.

For a new window, after setting up the Custom Legend tab, there are two other areas that need to be configured to set up the legend.

Window Configuration → Presentation → Preferences Tab
Select the Presentation tab, then the Preferences tab. Go to the Legend field at the bottom of the screen to turn the legend on or off and also to set its style and position.

Windows Configuration → Presentation → Colors/Fonts Tab
Select the Colors/fonts tab to set the colors for the legend background and text. For a Display you can also set the legend font style.

  

Provide feedback on this article