Difference between revisions of "Format an iReport Template"

(Conditional Display)
 
(18 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__FORCETOC__
 
 
{{TOC right}}
 
{{TOC right}}
{{HowTo's
 
|[[Start and Configure i-Report|Start and Configure i-Report]]
 
|[[Create a Basic i-Report Template|Create a Basic i-Report Template]]
 
|[[Modify an iReport Template|Modify an iReport Template]]
 
|[[Format an iReport Template|Format an iReport Template]]
 
|[[Create i-Report Templates with Subreports|Create i-Report Templates with Subreports]]
 
|[[Summarize i-Report Template Data|Summarize i-Report Template Data]]
 
}}
 
 
 
iReport Designer provides many ways to format the appearance of an iReport template. These include the ability to:
 
iReport Designer provides many ways to format the appearance of an iReport template. These include the ability to:
 
*add formatting elements to the iReport such as lines, rectangles, circles, etc  
 
*add formatting elements to the iReport such as lines, rectangles, circles, etc  
Line 16: Line 6:
 
*perform conditional displays based on data in the report
 
*perform conditional displays based on data in the report
  
==Conditional Display==
+
==Adding Formatting Elements==__NOEDITSECTION__
 +
Additional formatting elements can be added to the iReport template. These include lines, boxes, circles, etc. To add these elements to iReport template:
 +
# Ensure that '''Palette''' pane is available. If not, on the '''Window''' menu, select '''Palette'''.
 +
# Select the desired element and drag it to the iReport template.
 +
 
 +
==Formatting iReport Elements==__NOEDITSECTION__
 +
iReport Designer allows you to apply specific formatting to individual elements on an iReport template. Many of these elements can be edited graphically using [[#Formatting Tools|Formatting Tools]].
 +
# Select the desired field or variable displayed in the iReport template ('''note:''' this is '''NOT''' the field or variable value itself in the '''iReport Designer''', but rather the text element on the report displaying the field value)
 +
#: [[Image:IReport Display Properties.png|center|300px|''Display Properties'']]<div align="center">''Display Properties''</div>
 +
 
 +
===Position and Size Elements===__NOEDITSECTION__
 +
*Left
 +
*Top
 +
*Width
 +
*Height
 +
 
 +
===Colour===__NOEDITSECTION__
 +
*Forecolor
 +
*Backcolor
 +
*Opaque
 +
 
 +
===Text Properties===__NOEDITSECTION__
 +
iReport Designer allows you to set various properties for text elements displayed in the report template. These can be edited either with the text formatting bar (located on the same bar as the Designer, XML, and Preview buttons):
 +
[[Image:IReport Formatting Bar.png|center|300px|''Text Formatting Bar'']]<div align="center">''Text Formatting Bar''</div>
 +
 
 +
or with the '''Text properties''' portion of the '''Properties''' pane
 +
[[Image:IReport Text Properties.png|center|300px|''Text Properties'']]<div align="center">''Text Properties''</div>
 +
Some examples of the properties you can edit are:
 +
*Font Name
 +
*Size
 +
*Bold/Italic
 +
*Horizontal and Vertical Alignment
 +
 
 +
===Number and Date Specific Patterns===__NOEDITSECTION__
 +
* On the '''Properties''' pane select the '''Pattern''' element and open the '''Pattern Editor'''.
 +
*: [[Image:IReport Pattern Properties.png|center|300px|''Pattern Window'']]<div align="center">''Pattern Window''</div>
 +
** Choose an appropriate '''Pattern''' to apply to the field as desired.
 +
 
 +
===Position Type===__NOEDITSECTION__
 +
Because iReport elements can expand beyond their expected or allocated vertical space on the report template, elements can occasionally "collide" or overlap one another in the final report. To manage the potential conflict iReport provides the '''Position Type''' property on all elements.
 +
[[Image:IReport Display Properties.png|center|300px|''Formatting Tools'']]<div align="center">''Formatting Tools''</div>
 +
 
 +
The '''Position Type''' property has three options:
 +
*"Fix Relative to Top": This is the default value for all elements and means that the position will be kept relative to the top margin of the report regardless of what data is displayed before it.
 +
*"Fix Relative to Bottom": This value means that the position will be kept relative to the bottom margin of the report regardless of what data is displayed after it.
 +
*"Float": This value allows the element to "float" and will display the element relative to elements that come before it (i.e. closer to the top or closer to the left margins).
 +
 
 +
Using the '''Float''' Position Type can help eliminate the overlapping that can happen when displaying multiple charts or cross tabs in a single report template.
 +
 
 +
===Stretch with Overflow===__NOEDITSECTION__
 +
Another useful formatting option is '''Stretch with Overflow'''. Setting this property means that the height of the field will adapt to the value, instead of the value being cut if it requires more space than available for the field.
 +
* On the '''Properties''' pane tick the '''Stretch with Overflow''' element.
 +
*: [[Image:iReport_Format_Stretch_with_overflow.png|center|300px|''Stretch with Overflow'']]<div align="center">''Stretch with Overflow''</div>
 +
 
 +
==Formatting Tools==__NOEDITSECTION__
 +
iReport Designer provides a variety of formatting tools for aligning, spacing, and sizing elements on the report template. These can be applied using the '''Formatting Tools''' pane.
 +
# Ensure that '''Formatting Tools''' pane is available. If not, on the '''Window''' menu, select '''Formatting Tools'''.
 +
#: [[Image:IReport Formatting Tools.png|center|300px|''Formatting Tools'']]<div align="center">''Formatting Tools''</div>
 +
# Select the desired element or elements (multiple elements can be selected by using the '''Control-click''' key combination) and apply the desired formatting choice.
 +
 
 +
==Conditional Display==__NOEDITSECTION__
 
Sometimes it is important to change the display of some data extracted from IMSMA for the resulting report. For example, you want to change:
 
Sometimes it is important to change the display of some data extracted from IMSMA for the resulting report. For example, you want to change:
* the value “null” to “no”
+
* the value "null" to "no"
* the value “Male” to “Men”
+
* the value "Male" to "Men"
 
To do this, you use conditional statements in the element on the iReport.
 
To do this, you use conditional statements in the element on the iReport.
  
# Select the desired in the iReport template ('''note:''' this is '''NOT''' the field value, but rather the text element on the report displaying the field value)
+
# Select the desired field or variable displayed in the iReport template ('''note:''' this is '''NOT''' the field or variable value itself in the '''iReport Designer''', but rather the text element on the report displaying the field or variable value).
# On the '''Properties''' pane select the '''Text Expression''' and open the '''Text Expression Editor''''.
+
#: [[Image:IReport Display Properties.png|center|300px|''Display Properties'']]<div align="center">''Display Properties''</div>
#: [[Image:IReport Charts5.png|center|500px|''Text Expression Editor'']]<div align="center">''Text Expression Editor''</div>
+
# On the '''Properties''' pane select the '''Text Field Expression''' and open the '''Text Field Expression Editor'''.
# To change the way a particular field is displayed you can use basic "ïf-then-else" logic as in other [[Summarize i-Report Template Data#Variable Expressions|Variable Expressions]]. This follows the pattern:
+
#: [[Image:IReport Charts5.png|center|500px|''Text Field Expression Editor'']]<div align="center">''Text Field Expression Editor''</div>
  $F{field} == null ? “Something" : $F{field}
+
# To change the way a particular field is displayed you can use basic "if-then-else" logic as in other [[Summarize iReport Template Data#Variable Expressions|Variable Expressions]]. This follows the pattern:
 +
  $F{field} == null ? "Something" : $F{field}
  
 
Or nested:
 
Or nested:
  $F{field} == null ? “Something" : $F{field} == “SomethingElse” ? “Something Else“ : $F{field}
+
  $F{field} == null ? "Something" : $F{field} == "SomethingElse" ? "Something Else" : $F{field}
  
 
{{note| The type of field is important (string, float, double, int, date). Stick with strings if you can.}}
 
{{note| The type of field is important (string, float, double, int, date). Stick with strings if you can.}}
  
 
Example:
 
Example:
  $F{blockWater} == null ? “No value" : $F{blockWater}
+
  $F{blockWater} == null ? "No value" : $F{blockWater}
 
 
==Adding Formatting Elements==
 
* Adding lines
 
 
 
==Formatting Tools==
 
* float vs fix relative
 
 
 
==Working with Bands==
 
 
 
==Formatting Subreports, Charts, and Crosstabs==
 
  
{{NavBox HowTo use iReport}}
+
{{NavBox HowTo Standardizing Data Analysis and Information Reporting}}
 +
[[Category:NAA]]

Latest revision as of 20:29, 20 February 2020

iReport Designer provides many ways to format the appearance of an iReport template. These include the ability to:

  • add formatting elements to the iReport such as lines, rectangles, circles, etc
  • edit the position and size of elements on the iReport template relative to one another
  • change colors, fonts, and other properties
  • perform conditional displays based on data in the report

Contents

Adding Formatting Elements

Additional formatting elements can be added to the iReport template. These include lines, boxes, circles, etc. To add these elements to iReport template:

  1. Ensure that Palette pane is available. If not, on the Window menu, select Palette.
  2. Select the desired element and drag it to the iReport template.

Formatting iReport Elements

iReport Designer allows you to apply specific formatting to individual elements on an iReport template. Many of these elements can be edited graphically using Formatting Tools.

  1. Select the desired field or variable displayed in the iReport template (note: this is NOT the field or variable value itself in the iReport Designer, but rather the text element on the report displaying the field value)
    Display Properties
    Display Properties

Position and Size Elements

  • Left
  • Top
  • Width
  • Height

Colour

  • Forecolor
  • Backcolor
  • Opaque

Text Properties

iReport Designer allows you to set various properties for text elements displayed in the report template. These can be edited either with the text formatting bar (located on the same bar as the Designer, XML, and Preview buttons):

Text Formatting Bar
Text Formatting Bar

or with the Text properties portion of the Properties pane

Text Properties
Text Properties

Some examples of the properties you can edit are:

  • Font Name
  • Size
  • Bold/Italic
  • Horizontal and Vertical Alignment

Number and Date Specific Patterns

  • On the Properties pane select the Pattern element and open the Pattern Editor.
    Pattern Window
    Pattern Window
    • Choose an appropriate Pattern to apply to the field as desired.

Position Type

Because iReport elements can expand beyond their expected or allocated vertical space on the report template, elements can occasionally "collide" or overlap one another in the final report. To manage the potential conflict iReport provides the Position Type property on all elements.

Formatting Tools
Formatting Tools

The Position Type property has three options:

  • "Fix Relative to Top": This is the default value for all elements and means that the position will be kept relative to the top margin of the report regardless of what data is displayed before it.
  • "Fix Relative to Bottom": This value means that the position will be kept relative to the bottom margin of the report regardless of what data is displayed after it.
  • "Float": This value allows the element to "float" and will display the element relative to elements that come before it (i.e. closer to the top or closer to the left margins).

Using the Float Position Type can help eliminate the overlapping that can happen when displaying multiple charts or cross tabs in a single report template.

Stretch with Overflow

Another useful formatting option is Stretch with Overflow. Setting this property means that the height of the field will adapt to the value, instead of the value being cut if it requires more space than available for the field.

  • On the Properties pane tick the Stretch with Overflow element.
    Stretch with Overflow
    Stretch with Overflow

Formatting Tools

iReport Designer provides a variety of formatting tools for aligning, spacing, and sizing elements on the report template. These can be applied using the Formatting Tools pane.

  1. Ensure that Formatting Tools pane is available. If not, on the Window menu, select Formatting Tools.
    Formatting Tools
    Formatting Tools
  2. Select the desired element or elements (multiple elements can be selected by using the Control-click key combination) and apply the desired formatting choice.

Conditional Display

Sometimes it is important to change the display of some data extracted from IMSMA for the resulting report. For example, you want to change:

  • the value "null" to "no"
  • the value "Male" to "Men"

To do this, you use conditional statements in the element on the iReport.

  1. Select the desired field or variable displayed in the iReport template (note: this is NOT the field or variable value itself in the iReport Designer, but rather the text element on the report displaying the field or variable value).
    Display Properties
    Display Properties
  2. On the Properties pane select the Text Field Expression and open the Text Field Expression Editor.
    Text Field Expression Editor
    Text Field Expression Editor
  3. To change the way a particular field is displayed you can use basic "if-then-else" logic as in other Variable Expressions. This follows the pattern:
$F{field} == null ? "Something" : $F{field}

Or nested:

$F{field} == null ? "Something" : $F{field} == "SomethingElse" ? "Something Else" : $F{field}
Note.jpg The type of field is important (string, float, double, int, date). Stick with strings if you can.

Example:

$F{blockWater} == null ? "No value" : $F{blockWater}