Lightweight Chart Property Designer

When creating a Lightweight Chart (Shortened LChart herein) using the Report Designer, as described in Creating a Lightweight Chart on page 211, you can use the Lightweight Chart Property Designer window to customize the look and feel of the lchart. Besides, you can also start the Lightweight Chart Property Designer outside of the Report Designer to create lightweight chart property files and invoke those files within the Report Designer to format LCharts.

This section provides an introduction to lightweight chart property files and depicts all the issues relating to the Lightweight Chart Property Designer.

Introduction

LChart is one of the chart types that can be generated using the Report Designer. From technical point of view, lightweight charts utilize a different charting technology when compared with other legacy charts. Legacy charts are standard interactive charts in Java, and some of these charts could be those created using the Chart mode of the Report Designer. While the legacy charts are controlled through standard chart descriptor files, LCharts are attached with lightweight chart property files that contain their formatting information.

A lightweight chart property file is a set of formatting rules that specify the way a chart looks and behaves. They may control the following types of items or behaviors associated with a particular chart:

Lightweight Chart property files can be easily applied to more than one chart, thus creating a common look and feel for LCharts throughout an organization's reporting information.

The following sections are going to provide such information:

Launching the Lightweight Chart Property Designer

To start the Lightweight Chart Property Designer, use one of the following ways:

 

   Figure 194: Lightweight Chart Property Designer Window---Launched via Report Designer

 

   Figure 195: Lightweight Chart Property Designer Icon

The Lightweight Chart Property Designer window opens with a menu bar displayed across the top, as shown in the figure below.

 

   Figure 196: Lightweight Chart Property Designer Window---Launched via the Report Designers Page

Managing Property Files

Once you have started the Lightweight Chart Property Designer, you can either create a new property file or edit an existing one. Refer to the following sections for operation of managing your Lightweight Chart property files (choose the option appropriate to the version of the Lightweight Chart Property Designer you are using).

Creating Lightweight Chart Property Files

Use one of the following to create a new Lightweight Chart property file:

The Lightweight Chart Property Designer settings are set to their default values. None of the changes you make are permanent until you save the property file.

Opening a Property File

Use one of the following to open an existing chart property file:

The File Selector window is displayed, as shown below.

 

   Figure 197: File Selector Window: Open Property File

Use the File Selector window to locate the desired property file, and then click Open to view the file. Click Cancel to close the window.

If you are not sure of the name of the property file you want to open, click the Search button. This opens the File Search window which you can use to find a text string in either the file's name or description. The simple search only looks for files in the current folder and not in sub-folders.

Once you have opened a property file, you can modify any of the formatting as described below.

If the file is not in your current folder, select a sub-folder from the list and click the Browse button. To move to the parent folder select the <..> entry and click Browse.

Saving a Property File

Use one of the following to save an existing chart property file:

You can also use one of the following to save an existing property file under a new name:

If you are saving an existing property file under a new name, the old property file will still exist in the state it was in when you last saved it.

The File Selector window is displayed, as shown below.

 

   Figure 198: File Selector Window: Save Property File

To save an item using File Selector window:

1.   Enter a name for the item, without a file extension, into the Name field.

2.   Enter a description for the property file.

3.   Make sure LChart Property File is selected in the File Type drop-down list.

4.   From the folder and channel list, select the name of the folder or channel into which you wish to save the item.

5.   Click Save to save the item into the folder or channel you have selected.

Publishing a Property File

Lightweight Chart property files are stored in the user's Inbox folder. Therefore, the property files can be published to other users in the same manner as other standard Netcool Reporter files.

Once a Lightweight Chart property file has been associated with an LChart, if that LChart is published to another user, the other user will see the LChart displayed with the property file applied. It is, therefore, not necessary to publish the property file to other users unless the users will be modifying the property file.

Further, it is possible to apply a Lightweight Chart property file (whether it is one that was created by or published to a user) to a Lightweight Chart, as described in the section below.

Applying a Property File to an Lightweight Chart

While designing a lightweight chart using the Report Designer, you can invoke an existing LChart property file and apply it to the LChart you are working on, or you can also create a new property file to apply to the current LChart.

Firstly, start the Lightweight Chart Property Designer window by clicking the Properties button on the LChart tab of the LChart mode of the Report Designer, then either:

When the actual LChart definition file is saved within the Report Designer, it will embed the named LChart property file as referenced in part of the LChart definition file. When an LChart definition file is run within the Report Designer, outside using scheduling or directly from the Netcool Reporter pages, it will automatically apply the LChart property file when the LChart is displayed.

Other Management Functions

The version of the Lightweight Chart Property Designer that is opened from the Report Designers page has a number of additional menu options. These menu options achieve some of the functionality available on the LChart tab of the Report Designer application.

Previewing Lightweight Chart Property Files---The Action Menu

When the Lightweight Chart Property Designer is launched as an independent application using the Report Designers page, its window contains a menu bar across the top, as shown in Figure 196 on page 302. The Action menu is provided to enable you to view the formatting choices that have been made.

To view the formatting changes:

1.   Select the menu options ActionÆPreview or ActionÆPreview As.... The File Selector window is displayed.

2.   Use the File Selector window to browse to a chart you wish to use to preview the formatting.

3.   Select a type of chart from the File Type drop-down list. For more information on the File Selector window, see Opening a Property File on page 303.

4.   Once you have selected a chart, click the Open button. If you have selected a parameterized chart the Parameter Value Selection window is displayed. Select the values to use in your report and click OK.

5.   The chart is displayed with the formatting applied.

 

   Note:


    Selecting a chart for preview applies the chart property file temporarily for the purpose of testing your formatting. You can select any chart to preview your formatting options. Other users will not see the formatting you select until you save the property file.


6.   If, after previewing the chart property file, you are satisfied with the formatting, save the property file using the FileÆSave menu option.

Saving the Snapshot of a Lightweight Chart

To save a snapshot of a lightweight chart, select the menu options FileÆSave Snapshot. The Save Snapshot As dialog is displayed. Enter the lightweight chart name and an optional description, select the desired folder to save the lightweight chart, then click Save to continue.

The Lightweight Chart Property Designer runs the report and displays it in a new window. The report is also saved as an HTML file in your Inbox.

Formatting Lightweight Charts

The five tabs on the Lightweight Chart Property window provides formatting controls including some general options, the formatting of the legend, x axis, y axis, and the measures. Functions of each tab are described in the following sections.

Option Tab

Examples of the Option tab can be found in Figure 194 on page 301 and Figure 196 on page 302. The options are described in the following table.

Table 60: Options on the Option Tab

Option

Description

Output Type

Sets the file type to which the chart will be exported. Types include: GIF, JPEG, PNG, and Excel (Excel-data only and Excel-chart only).

Chart Type

Specifies the chart types. Possible values include: Area, Combo, Bar, Line, Pie, Stack, and Time Series. For descriptions of each chart type, see Creating a Lightweight Chart on page 211.

Orientation

Sets the bar and stack chart's orientation, as either Horizontal or Vertical. This option applies to Bar and Stack charts only.

Width

Sets the width of the chart, in pixels.

Height

Sets the height of the chart, in pixels.

Background Color

The background area is that area outside of the plot area.

This option is used to specify a gradient background color for the chart. Click the bars of color and select two colors to get a gradient color. To get a color with no gradient effect, select the same color for both the first and second colors.

Plot Color

Sets the plot color. This is the background color of the plot area of a chart.

Border

Selects whether the border of the chart is visible or not.

2nd Axis to Measure

Activated only when Stack is selected from the Chart Type drop-down list. Select this checkbox to create a new type of Stack chart which allows more than one axis and a single measure. When you are creating a common stack chart, leave this checkbox unselected.

Chart Title

This group of formatting options includes: Visibility, Title Text, Font, and Font Color. The chart title is text that can be placed at the top of the chart.

Null Values

Specifies whether Null Values are not shown in the chart or are represented by a zero (0).

3D

When selected, makes the measures of the chart displayed with 3D effect. This option is available to all chart types except Time Series.

Series Inline

If 3D is enabled, controls whether measures are displayed side by side, or one behind another. Useful only when more than one measure is available in the chart.

Depth

If 3D is enabled, specifies the depth of the 3D effect in the display of the chart.

Legend Tab

The Legend tab contains formatting options that apply specifically to the chart's legend. An example of the Legend tab is shown below.

 

   Figure 199: Legend Tab

The options on the Legend tab are described in the following table.

Table 61: Legend Tab Options

Option

Description

Legend Visibility

When selected, makes the legend visible.

Position

Determines where the legend is placed on the chart. Options include: Bottom, Left, Right, Bottom-Right, and Bottom-Right.

Append Title

Applies to Pie lightweight charts only. When this option is checked, the data values of the pie slices are appended to the legend titles.

Font

Sets the font for the legend. Clicking this link displays the Font Selector window. The Font Selector provides the ability to select the following traits for the font: Font Name, Style, and Size. After selecting the desired values, click OK.

Font Color

To select a color for the legend's font, click the Font Color bar and select a color or enter the RGB values for the desired color. Then, click OK.

Legend Color

To select a color for the legend's background, click the bar of color and select a color or enter the RGB value.

X Axis Tab

The X Axis tab contains formatting options that apply specifically to the chart's x axis. An example of the X Axis tab is shown below (this tab is not available to Pie charts):

 

   Figure 200: X Axis Tab

The options on the X Axis tab are described in the following table.

Table 62: X Axis Tab Options

Options

Description

Axis Title

This section provides control over the x axis title. The title is an optional text string that appears on the x axis. Formatting options include:

  • Title visibility

  • The text of the title

  • The font for the title

  • The title font color.

Grid

The x axis grid is the set of vertical lines that delineate the plot area. The following formatting options are available for the x axis grid:

  • Visibility

  • Weight (width, in pixels)

  • Color

Tics Label

Tics are the markings (for example, numbers) along the x axis. The following formatting options are available for the x axis tics:

  • Visibility

  • Label frequency - (how often to label, in units. For Time Series lightweight charts, see the following table for more information.)

  • Font

  • Font color

  • Font orientation (horizontally or vertically, see below for explanation)

Font Orientation

This is an important feature for the tics label. Selects whether you want the tics label displayed horizontally or vertically along the x axis.

Besides these general x axis options, there is an additional set of formatting options specific to Time Series lightweight charts, as described in the following table:

Table 63: Additional X Axis Tab Options for Time Series LChart

Options

Description

Frequency Type

Selects the type of interval along the time axis. Available options include:

  • Day

  •  Week

  • Month

The number of interval points along the time axis is determined by label Frequency (as described in the above table) and Frequency Type. For example, if you selected 3 for frequency and WEEK for Frequency Type, then the interval along the time axis will be 3 weeks. When MONTH is selected as Frequency Type, the interval along the time axis will be 3 months, and the system will default to the first day of the month.

Data Source Format

The date source format is used to convert the data returned from the database into a date. The date format must match the original data. For example, if the source data is 1998-02-29 then the matching date source format must be yyyy-MM-dd. The Date Source Format drop down list contains some default date formats. The list can be customized by editing the timeseries.xml file located in:

$INFOHOME/websqlbr/chartemplate/timeseries.xml.

See Customizing Date Format File (timeseries.xml) below for more information.

Start Date

Selects the start date along the time axis. The format is given in the standard java date format.

End Date

Selects the end date along the time axis. The format is given in the standard java date format.

Last N Days

Selects the number of days to go back in time starting from the end date. The current date is used as End Date if no End Date is provided. The Start Date is ignored. The Frequency Type will default to DAY.

Data Label Format

Selects the format for displaying the tics labels along the time axis. For example, selecting the format "EEE,MMM d,"yy", will display the labels as "Mon, Jul 27, 87". The formats provided are standard java date formats.

Customizing Date Format File (timeseries.xml)

The Data Source Format drop-down list is used to select a date format that matches your data source. You can customize this list by editing the timeseries.xml file located in:

$INFOHOME/websqlbr/chartemplate/timeseries.xml

Once this file is modified, be sure to restart the Lightweight Chart Property Designer to refresh the Data Source Format drop-down list.

Here below provides a sample timeseries.xml:

<TimeSeries>

<DateSourceFormat>

<dateFormat>yyyy-MM-dd</dateFormat>

<dateFormat>dd-MMM-yyyy</dateFormat>

<dateFormat>dd/MMM/yyyy</dateFormat>

<dateFormat>yyyy/MM/dd</dateFormat>

<dateFormat>MM/dd/yy</dateFormat>

<dateFormat>MM-dd-yy</dateFormat>

<dateFormat>yy/MM/dd</dateFormat>

<dateFormat>yy-MM-dd</dateFormat>

</DateSourceFormat>

</TimeSeries>

You can modify the order of the date formats.

Y Axis Tab

The Y Axis tab contains formatting options that apply specifically to the chart's y axis. An example of the Y Axis tab is shown below.

 

   Figure 201: Y Axis Tab

The options on the Y Axis tab are described in the following table.

Table 64: Y Axis Tab Options

Options

Description

Axis Title

This section provides control over the y axis title. The title is an optional text string that appears on the y axis. Formatting options include:

  •  Title visibility

  • The text of the title

  • The font for the title

  • The title font color.

Grid

The y axis grid is the set of horizontal lines that delineate the plot area. The following formatting options are available for the y axis grid:

  • Visibility

  • Weight (width, in pixels)

  • Color

Tics

Tics are the markings (for example, numbers) along the y axis. The following formatting options are available for the y axis tics:

  • Visibility

  • Font

  • Font color

Scaling Options

Scaling options control the scale along the y axis. Either accept the defaults of using the minimum and maximum values to create a range, or deselect the checkboxes next to these and enter values into the spaces provided. Unit determines the measurement along the y axis. For example, a unit of 100 would give 10 lines if the scale were 0 to 1000. The number format box allows for the selection of preset formatting for numbers. For example, use the "0.00" format to keep all values displayed to the hundredths place after the decimal.

2nd Y Axis

When selected, this checkbox causes a new tab (labeled 2nd Y Axis) added after the Y Axis tab. This new tab's content is identical to that of the Y Axis tab, except for the 2nd Y Axis visibility checkbox.

Note: Two steps are required to use a 2nd Y axis. First, select the 2nd Y axis checkbox as indicated above. Then, you must also click the Measure tab and apply the 2nd Y axis to one of the measures.

Measure Tab

The Measure tab contains formatting options that apply specifically to a chart's measure(s). The Measure tab is displayed below.

 

   Figure 202: Measure Tab

The Measure tab usually contains Foreground Color Options, Display Measure List, Data Label, and some other chart type-specific options. Select a measure from the Display Measure List and set its foreground color, data label and other formatting options.

General Formatting Options

The general options on the Measure tab are described in the following table.

Table 65: Measure Tab Options

Options

Description

Foreground Color Options

This option controls the display color of the measure. Either click the Foreground Color field and select a color to display for the measure from the Color Selector, or, for Bar and Pie charts, select a predefined color mapping file, if available, to apply to the measure. For more information on the color mapping feature, refer to Using Color Mapping Files on page 316.

Data Label

This field is not available to Time Series lightweight charts.

The Data Label is the label for each measure. The formatting options for this include:

  • Visibility

  • Font

  • Font color

  • Base on - Specifies whether the 1st or 2nd Y axis determines the data label. The first Y axis is the default. To display the measure based on the 2nd Y axis, first select the 2nd Y axis visibility checkbox, then select 2nd Y axis from the drop-down list.

Using Color Mapping Files

When choosing a foreground color for the measure selected in the Display Measure List, you can either select the foreground color from the Color Selector, or you can utilize the color-mapping feature -- choosing a predefined color-mapping file from the Custom Color Mapping drop-down list.

The color-mapping feature allows you to design XML color-mapping files that define colors for the measure members. Defining such files enables you to use different colors for displaying each measure member, instead of using a single color.

This color mapping feature applies only to lightweight charts that contain a single measure (this measure may include multiple members), and can only be used to format the measure for Bar and Pie charts.

To use a color mapping file to apply to the measure, you need to:

1.   Define the color mapping file, as described below.

2.   Save the color mapping file to different directories depending on the OS. For UNIX OS, save the file into: $INFHOME/websqlbr/xmc/file_name.xml. For Windows, save it into %INFOHOME%\websqlbr\xmc\file_name.xml. Note that the color mapping file must be saved with the file extension of .xml, and file_name refers to the name you use for the file.

3.   Select the desired color mapping file from the Custom Color Mapping drop-down list in the Measure tab (if necessary, click View to update the list). This drop-down contains a listing of all color mapping files available in the directory specified above. Click View to open the selected color mapping file.

The example below displays a typical color mapping file (ColorMapping.xml), which demonstrates how a color mapping file is structured:

<SeriesSytle>

<Style series="MeasureColor2">

<itemStyle axis="1" value="79;148;205" type="RGB"/>

<itemStyle axis="2" value="255;181;197" type="RGB"/>

<itemStyle axis="3" value="255;215;0" type="RGB"/>

<itemStyle axis="4" value="159;182;205" type="RGB"/>

<itemStyle axis="5" value="23;78;5" type="RGB"/>

<itemStyle axis="6" value="2;235;5" type="RGB"/>

      </Style>

</SeriesSytle>

To define a color mapping file, you can use any text editor. In the example above, the file contains six records, which represent settings for six measure members. The number of records must comply with the number of measure members. The itemStyle node has axis, value and type attributes, which are explained below:

For example, the third record in the above example defines that the third axis (measure member) is displayed in 255;215;0, which is yellow in RGB color model.

When you complete designing the color mapping file, save it as a .xml file into the directory appropriate for your OS.

Defining Measures

The Display Measure List, by default, displays a number of pre-defined formatting schemes for the measure. Each formatting scheme has different settings for the measure's foreground color, data label properties, and so on. Select a format in the list and the settings corresponding to the format are then applied to the property sections.

When the Lightweight Chart Property Designer is started in context with the creation of a lightweight chart in the Report Designer, the Display Measure List provides a listing of all the measures defined in the LChart tab. Select a measure in the list and set the properties in the Foreground Color and Data Label sections as well as other chart-type specific property items.

When you are using the Lightweight Chart Property Designer as an independent application, you need to design a property file that contains information on what the measures are and what formatting is set for each measure. The Up and Down, Delete, Load, and Add buttons below the Display Measure List are useful for managing measures.

You have two methods available to add measures to the property file. One is to type a measure and click the Add button to add it into the Display Measure List; the other way is to click the Load button and load all the measures available in the selected chart file. When the Load button is clicked, the File Selector window is brought up, allowing you to select a file to open. Note that the File Type drop-down list on the window provides a list of chart types available in Netcool Reporter, such as LChart, Chart, Easy Chart, and parameterized charts of the three types. Measures can only be loaded from these types of charts. The Delete button is used to delete any unwanted measure from the list, while the Up and Down arrow buttons are used to reorder the sequence of the added measures.

Once measures are created or loaded, set their formatting options one by one.

Additional Options for Line and Time Series Lightweight Charts

When the Chart Type on the Option tab is set to Line or Time Series, the following additional fields are available on the Measure tab:

These options determine the format of markers that can be placed along the line in a Line or Time Series chart.

Additional Options for Combo Lightweight Charts

When the Chart Type on the Option tab is set to Combo, the Type drop-down list is added above the Foreground Color Options field. This list allows you to select different chart types for each measure. Select a measure from the Display Measure List and select a chart type for it.

Additional Options for Pie Lightweight Charts

When the Chart Type on the Option tab is set to Pie, the Content drop-down list is added to the Data Label section on the Measure tab. The Content options are:

This drop-down list controls what content each pie slice represents.

In Pie mode, additional attribute fields appear below the Data Label section. These options are provided to format the data labels to prevent the overlapping of labels in pie charts with multiple thin slices.

These options are: