Summary fields

A summary is a special kind of formula. A summary generates a count, average, sum, standard deviation or other transformation of a set of data values. A summary applies to a defined group of data.

Inserting a summary field in a report

Summaries can be inserted in the report areas listed in Component placement. Before you can insert a summary field into a report, you need to define it. For details about how to define summaries, see Creating a summary.

To insert a summary field into a report, you can use either of the following two ways:

Using dialog
1. Select the DBField in the report to which you want the summary to be applied.
2. Do one of the following:
  - Click Insert > Summary on the menu bar.
  - Click the Insert Summary button on the Insert toolbar
  - Right-click the DBField and select Summary Function from the shortcut menu.
  The Insert Summary dialog appears. See the dialog.
3. From the Function drop-down list, specify the function of the summary.
4. If the report is grouped, select to which group level the summary will be applied from the Group By drop-down list. If None is select, the summary will be added based on the whole report.
5. Click the Insert button to insert the summary into the destination.
By dragging and dropping
Select the required summary from the Resource View panel, then drag it to the destination. If the given summaries are not what you want, click the <Add Summary...> item to create one as required.

When a summary field has been inserted into a report, you can customize its appearance and behavior by setting properties in the Report Inspector, which can be saved as a CSS style for future use (for details, see Creating a CSS style).

Notes:

Summary fields can only be inserted into the header/footer/detail panel of a banded object or cells in the header/footer/detail panel of a table. However, if you have specified a group by field when creating the summary, it can be inserted into the corresponding group panels.
If you insert a summary into the detail panel of a component, the name of the summary will automatically be inserted as a label into the corresponding header panel. Otherwise the summary and its name label will be placed in the same panel. If you do not want to insert the name label automatically, you can uncheck Insert field name label with field in the Options dialog (File > Options > Component > Insert field name label with field).

Changing the display type of a summary field

The display type of a summary field can be changed, that is to say, you can map the summary field to another value or image to be displayed instead.

To change the display type a summary field:

Right-click the summary and select Display Type from the shortcut menu.
In the Display Type dialog, specify the required display type in the Type box, and set the options for the selected type in the Web Options panel.
Upon finishing, click the OK button to close the dialog.

For details about display types, see Changing the display type of a label.

Applying web actions to a summary field

A summary field can be bound with some web actions. This allows you to customize a summary field to make it respond to some events, and execute corresponding actions, such as sorting and filtering.

To apply web actions to a summary field:

Right-click the summary field and select Display Type from the shortcut menu.
In the Web Behaviors box of the Display Type dialog, choose an event from the Events column, then click in the Actions column and click that appears in the text box.
In the Web Action List dialog, select a web action and define the action as required.
Click in the Display Type dialog to add more web behavior lines and specify the events and actions accordingly. If a web behavior is not required, click to remove it.
Adjust the order of the added web actions by clicking or . Then, when an event that has been bound with more than one action happens, the upper action will be triggered first.
When done , click OK to accept the settings.

For more information about web actions, see Applying web actions to a label.

Binding a link to a summary field

You can make a summary field linked with another report, a location specified by a URL, an e-mail address, or a Blob data type field. The link can either be a simple link or a conditional link. With conditional link, different targets can be loaded based on different conditions.

To bind a link to a summary field:

Right-click the summary field and click Link on the shortcut menu.
In the Insert Link dialog, specify whether it is a conditional link or a simple link, then select the link target and set the options for the link target as required.
When done, click OK.

For details about different link targets, see Binding a link to a label.

Adding conditional formats to a summary field

You can add some conditional formats to a summary field, then when a specified condition is fulfilled, the format bound with the condition will be applied to the field values automatically for distinguishing.

To add conditional formats to a summary field:

Right-click the summary field and select Conditional Formatting from the shortcut menu.
In the Conditional Formatting dialog, click the button to add a condition.
Set the format that will be applied to the field values when the specified condition is fulfilled.
Repeat the above two steps to add more conditions and define the format for each condition.
When done, click OK to save the settings.

For more details about conditional formatting, see Adding conditional formats to a DBField.

See an example: The SampleComponents catalog, included with JReport Designer, contains reports that have examples of how each component type could be used in a report. For the summary field example, open <install_root>\Demo\Reports\SampleComponents\UsingSummaries.cls.