BackPrevious Page Next PageNext

Label

The Label object is supported in page reports, web reports and library components. It contains the following properties and the availabilities of the properties vary for different report types.

Property Name Available For Description
General
Class Type Query Page Report Indicates the class type of the object. This property is read only.
Instance Name Query Page Report Shows the instance name of the object. This property is read only.
Reference Query Page Report Shows the instance name of the field if the label is related to a field. This property is read only.
Text Format
Auto Fit Page Report, Web Report, Library Component Specifies whether to adjust the width and height of the object according to the contents. Not supported on labels that are inside a crosstab or heat map.

Data type: Boolean

Auto Map Field Name Page Report, Web Report, Library Component Enabled when the label is related to a field. It specifies whether to automatically map the label text to the dynamic display name of the field at runtime. If true, the text specified via the Text property will be ignored. You can customize the display names for fields in query resources and in business views.

Data type: Boolean

Bold Page Report, Web Report, Library Component Specifies whether to make the text bold.

Data type: Boolean

Font Face Page Report, Web Report, Library Component Specifies the font of the text. Choose an option from the drop-down list.

Data type: Enumeration

Font Size Page Report, Web Report, Library Component Specifies the font size of the text. Enter an integer value to change the size.

Data type: Integer
Horizontal Alignment Page Report, Web Report, Library Component Specifies the horizontal justification of the text in the object. Choose an option from the drop-down list. Not supported on labels that are inside a heat map.

Data type: Enumeration

Ignore HTML Tag Query Page Report Specifies whether or not to ignore the HTML tags in the HTML result of the report.
  • true - The text appears in the HTML result the same as that in JReport Designer (HTML tag elements in the text, if any, will not be parsed).
  • false - HTML tag elements in the text will be parsed in the HTML result.

This property is useful for exporting a report to HTML format. You may want to write the label contents in HTML tags in your report, and in the HTML result files, the tags will be transferred as they are translated into HTML.

Data type: Boolean

Italic Page Report, Web Report, Library Component Specifies whether to make the text italic.

Data type: Boolean

Maximum Width Query Page Report Specifies the maximum width of the text displayed. Enter a numeric value to change the width.

This property often works with the Auto Fit property. If Auto Fit = true and Maximum Width is not equal to 0, the text will extend until the width is this value.

Data type: Float

Strikethrough Page Report, Web Report, Library Component Specifies whether to add a strikethrough line to the text.

Data type: Boolean

Text Page Report, Web Report, Library Component Specifies the text in the label. Enter a string to display as the label text.

Data type: String

Underline Page Report, Web Report, Library Component Specifies whether to underline the text.

Data type: Boolean

Vertical Alignment Page Report, Web Report, Library Component Specifies the vertical justification of the text in the object. Choose an option from the drop-down list. Not supported on labels that are inside a heat map.

Data type: Enumeration

Word Wrap Page Report, Web Report, Library Component Specifies whether to wrap the text to the width. Not supported on labels that are inside a heat map.

Data type: Boolean

Geometry (not supported on labels inside a crosstab or heat map)
Height Page Report, Web Report, Library Component Specifies the height of the object. Enter a numeric value to change the height.

Data type: Float
Width Page Report, Web Report, Library Component Specifies the width of the object. Enter a numeric value to change the width.

Data type: Float
X Page Report, Web Report, Library Component Specifies the horizontal coordinate of the top left corner of the object, relative to its parent container. This property is ignored if the Position property is set to static. Enter a numeric value to change the position.

Data type: Float
Y Page Report, Web Report, Library Component Specifies the vertical coordinate of the top left corner of the object, relative to its parent container. This property is ignored if the Position property is set to static. Enter a numeric value to change the position.

Data type: Float
Color
Background Page Report, Web Report, Library Component Specifies the background color of the object. Choose a color from the drop-down list or select Custom to customize a color, or enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.

Data type: String

Foreground Page Report, Web Report, Library Component Specifies the foreground color of the object. Choose a color from the drop-down list or select Custom to customize a color, or enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.

Data type: String

CSS
Class Page Report, Web Report, Library Component Specifies a CSS class to be applied to the object which is a valid class in the CSS file.

Data type: String
ID Page Report, Web Report, Library Component Specifies the identifier of the object, which must be unique in the report. The ID property can be a style sheet selector.

Data type: String
Style Page Report, Web Report, Library Component The property can be used in two ways.
  • Specifies a style to be applied to the object. Choose a style from the drop-down list which is available when a Style Group has been selected at the page report tab or web report or library component level and when there are styles in the Style Group that can be applied to the object, or type in the style name.
  • Specifies a CSS selector to be applied to the object. Enter a valid class name from the CSS file.

Data type: String
Excel (not supported on labels inside a crosstab)
Column Index Page Report, Web Report Specifies the X coordinate of the object relative to its parent container when exported to Excel or CSV, measured in cells. The Columned property at the page report tab or web report level must be set to true for this property to take effect.

Data type: Integer
Row Index Page Report, Web Report Specifies the Y coordinate of the object relative to its parent container when exported to Excel or CSV, measured in cells. The Columned property at the page report tab or web report level must be set to true for this property to take effect.

Data type: Integer
Padding (not supported on labels inside a heat map)
Bottom Padding Page Report, Web Report, Library Component Specifies the space between the text and the bottom border of the object. Enter a numeric value to change the padding.

Data type: Float

Left Padding Page Report, Web Report, Library Component Specifies the space between the text and the left border of the object. Enter a numeric value to change the padding.

Data type: Float

Right Padding Page Report, Web Report, Library Component Specifies the space between the text and the right border of the object. Enter a numeric value to change the padding.

Data type: Float

Top Padding Page Report, Web Report, Library Component Specifies the space between the text and the top border of the object. Enter a numeric value to change the padding.

Data type: Float

Border (not supported on labels inside a heat map)
Border Color Page Report, Web Report, Library Component Specifies the color of the border of the object. Choose a color from the drop-down list or select Custom to customize a color, or enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.

Data type: String

Border Thickness Page Report, Web Report, Library Component Specifies the width of the border. Enter a numeric value to change the thickness.

Data type: Float

Bottom Line Page Report, Web Report, Library Component Specifies the line style of the bottom border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Left Line Page Report, Web Report, Library Component Specifies the line style of the left border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Right Line Page Report, Web Report, Library Component Specifies the line style of the right border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Shadow Page Report, Web Report, Library Component Specifies whether to draw two shadowed borders, beneath and to the right of the object.

Data type: Boolean

Shadow Color Page Report, Web Report, Library Component Specifies the color of the shadow. Choose a color from the drop-down list or select Custom to customize a color, or enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.

Data type: String

Top Line Page Report, Web Report, Library Component Specifies the line style of the top border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Pattern
Pattern Color Page Report, Web Report, Library Component Specifies the color in which to draw a pattern to fill the object. Choose a color from the drop-down list or select Custom to customize a color, or enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.

Data type: String

Pattern Style Page Report, Web Report, Library Component Specifies the style of the pattern. Choose an option from the drop-down list.

Data type: Enumeration

Others
Bind Column Query Page Report, Web Report, Library Component Specifies to bind the label with a field so that end users can use the label's shortcut menu to filter and sort records of the bound field in Page/Web Report Studio and JDashboard. When a label is bound with a field, you can further set the label's Filterable and Sortable properties to true to display the corresponding buttons beside the label for easy filtering and sorting.

This property is not supported on labels that are inside a crosstab.

Data type: String

Detail Report Query Page Report Specifies the detail report that the object is linked to. Click in the value cell to set the detail report. For details, refer to Linking to a Detail Report.

This property is not supported on labels that are inside a crosstab.

Data type: String

Detail Target Frame Page Report This property is supported on labels in the group header/footer panel of a banded object and enabled when Go to Detail is set to true.

Specifies the target window or frame in which to display the detailed information. Choose an option from the drop-down list.

Data type: String
Enable Hyperlink in Excel Page Report, Web Report, Library Component Specifies whether to enable the link defined on the object in the Excel result of the report. Not supported on labels that are inside a crosstab in a web report/library component.

Data type: Boolean

Enable Hyperlink in HTML Page Report, Web Report, Library Component Specifies whether to enable the link defined on the object in the HTML result of the report. Not supported on labels that are inside a crosstab in a web report/library component.

Data type: Boolean

Enable Hyperlink in PDF Page Report, Web Report, Library Component Specifies whether to enable the link defined on the object in the PDF result of the report. Not supported on labels that are inside a crosstab in a web report/library component.

Data type: Boolean

Export to CSV Page Report, Web Report, Library Component Specifies whether to include the object in the CSV result of the report. If it is set to true in page report, only the string value will be included when the object is displayed as a barcode or text field, and only the text will be included when the object is displayed as a checkbox, radio button or button.

Data type: Boolean

Export to Excel Page Report, Web Report, Library Component Specifies whether to include the object in the Excel result of the report. If it is set to true in page report, only the string value will be included when the object is displayed as a text field.

Data type: Boolean

Export to HTML Page Report, Web Report, Library Component Specifies whether to include the object in the HTML result of the report.

Data type: Boolean

Export to PDF Page Report, Web Report, Library Component Specifies whether to include the object in the PDF result of the report. If it is set to true in page report, only the string value will be included when the object is displayed as a text field.

Data type: Boolean
Export to PostScript Page Report, Web Report, Library Component Specifies whether to include the object in the PostScript result of the report. If it is set to true in page report, only the string value will be included when the object is displayed as a text field.

Data type: Boolean

Export to Report Result Page Report, Web Report, Library Component Specifies whether to include the object when previewing the report in Page/Web Report Result and running the report in Page/Web Report Studio, or when the library component is used in JDashboard.

Data type: Boolean

Export to RTF Page Report, Web Report, Library Component Specifies whether to include the object in the RTF result of the report. If it is set to true in page report, only the string value will be included when the object is displayed as a text field, and only the text will be included when the object is displayed as a radio button or button.

Data type: Boolean

Export to Text Page Report, Web Report, Library Component Specifies whether to include the object in the Text result of the report. If it is set to true in page report, only the string value will be included when the object is displayed as a barcode or text field, and only the text will be included when the object is displayed as a checkbox, radio button or button.

Data type: Boolean
Export to XML Page Report, Web Report, Library Component Specifies whether to include the object in the XML result of the report. If it is set to true in page report, only the string value will be included when the object is displayed as a barcode or text field, and only the text will be included when the object is displayed as a checkbox, radio button or button.

Data type: Boolean
Filter Options Query Page Report, Web Report, Library Component When the label has a Bind Column, you can set this property to specify the filter-related options that will be displayed on the Filter submenu when right-clicking the label in Page/Web Report Studio and JDashboard.

Data type: Integer

Filterable Query Page Report, Web Report, Library Component If true, a filter button appears beside the label when viewing the report or library component in Page/Web Report Studio or JDashboard. You can use the button to filter the records based on values of the field specified via the Bind Column property.

Data type: Boolean
Go to Detail Query Page Report This property is available only when the object is in the group header/footer panel of a banded object.

Specifies whether to show the detailed information when you click the object in Page Report Studio. For details about its usage, refer to Obtaining Detailed Information from a Banded Object.

Data type: Boolean

Invisible Page Report, Web Report, Library Component Specifies whether to show the object in the design area and in the results. All formulas and calculations will still be performed if the property is set to true.

Data type: Boolean

Link Page Report, Web Report, Library Component Specifies to link the object to another report, a website, an e-mail address or a Blob data type field. Click in the value cell to set the link target. For details, see Binding a Link to a Label.

Data type: String

Logic Column Page Report, Web Report, Library Component This property is supported when the object is in a table.

Specifies whether to show the object in the next visible table cell in the same row when the column which holds the object is hidden. Choose an option from the drop-down list.

Data type: Enumeration

Notes:

  • The next visible table cell should be completely empty, that is, the cell should not hold any content including blank space.
  • When the property for several objects in the same row is set to next visible column, and the columns holding these objects are all hidden, then only the object in the rightmost column will be shown in the next visible cell.
Position Page Report, Web Report, Library Component Specifies the position of the object. Choose an option from the drop-down list. Not supported on labels that are inside a crosstab or heat map.

Data type: Enumeration
Record Location Page Report, Web Report, Library Component Specifies the calculation point for the properties which use formulas. Choose an option from the drop-down list.
  • Default - The values of the properties are calculated in the default location where they are located.
  • Page Header - The values of the properties are calculated in the page header.
  • Page Footer - The values of the properties are calculated in the page footer.

Data type: Enumeration
Sortable Query Page Report, Web Report, Library Component If true, a sort button appears beside the label when viewing the report or library component in Page/Web Report Studio or JDashboard. You can use the button to arrange the records of a specific field in ascending or descending order. The field is specified via the Bind Column property.

This property is not supported on labels that are inside a crosstab.

Data type: Boolean
Suppress Page Report, Web Report, Library Component Specifies whether to show the object in the design area and in the results. All formulas and calculations will be skipped if the property is set to true.

Data type: Boolean

Note: When both the Invisible and Suppress properties of an object are set to true, Suppress has the higher priority.
Suppress Aggregate Query Page Report This property is supported on labels (excluding summary labels) that are inside a crosstab only. It specifies whether to hide the Total row or column.

Data type: Boolean
Suppress When No Records Page Report, Web Report, Library Component Specifies whether to display the object in the results when no record is returned to its parent data component.

Data type: Boolean
Transfer Style Page Report, Web Report, Library Component Specifies whether the style group of the primary report will be applied to the linked report if the object is linked to a report.

Data type: Boolean

TOC
Anchor Display Value Query Page Report Specifies a string or formula to display for the TOC entry for this object in the TOC Browser. By default it is the value of the specified object. The TOC Anchor property must be set to true for this property to take effect.

Data type: String

TOC Anchor Query Page Report Specifies whether to include the object in the TOC Browser for the report.

Data type: Boolean

Accessibility
Abbr Page Report, Web Report, Library Component This property is supported on labels that are inside a crosstab.

It is mapped to the HTML attribute abbr. This attribute specifies an abbreviated form of the content of the object. The abbreviated text may be rendered by user agents when appropriate in place of the object's content.

Data type: String
Axis Page Report, Web Report, Library Component This property is supported on labels that are inside a crosstab.

It is mapped to the HTML attribute axis. This attribute is used to place a cell into conceptual categories that can be considered to form axes in an n-dimensional space. The value of this attribute is a comma-separated list of category names.

Data type: String
External AccessKey Query Page Report It is mapped to the HTML attribute accesskey. This attribute specifies an access key to the object.

Data type: String
External CSS Class Selector Query Page Report Specifies a class selector to be applied to the object when exported as HTML. Enter a valid class name from the CSS file.

Data type: String

External Dir Query Page Report It is mapped to the HTML attribute dir. This attribute specifies the base direction of directionally neutral text in the object's content and attribute values. It also specifies the directionality of tables. Possible values:
  • LTR - Left-to-right text or table.
  • RTL - Right-to-left text or table.

Data type: String
External ID Query Page Report It is mapped to the HTML attribute id. This attribute specifies a name to the object, which must be unique in the report.

Data type: String
External Style Query Page Report It is mapped to the HTML attribute style. This attribute specifies style information for the object.

Data type: String
External TabIndex Query Page Report It is mapped to the HTML attribute tabindex. This attribute specifies the position of the object in the tabbing order for the current report. Enter an integer equal to or greater than 0 and less than 65535.

Data type: Integer
External Title Query Page Report It is mapped to the HTML attribute title. This attribute offers advisory information about the object.

Data type: String
Headers Page Report, Web Report, Library Component This property is supported on labels that are inside a crosstab only.

It is mapped to the HTML attribute headers. This attribute specifies the list of header cells that provide header information for the current data cell. The value of this attribute is a space-separated list of cell names; those cells must be named by setting their id attribute.

Data type: String
HrefLang Query Page Report It is mapped to the HTML attribute hreflang. This attribute specifies the base language of the resource designated by a link and may only be used when a link is specified.

Data type: String
Language Query Page Report It is mapped to the HTML attribute lang. This attribute specifies the base language of the object's attribute values and text content.

Data type: String
LongDesc Query Page Report It is mapped to the HTML attribute longdesc. This attribute specifies a link to a long description of the object.

Data type: String
Scope Page Report, Web Report, Library Component This property is supported on labels that are inside a crosstab only.

It is mapped to the HTML attribute scope. This attribute specifies the set of data cells for which the current header cell provides header information. Available values are:

  • Row - The current cell provides header information for the rest of the row that contains it.
  • Column - The current cell provides header information for the rest of the column that contains it.
  • none - The scope attribute will not be generated in the HTML result

Data type: String

Note: For labels in web reports and library component, only these properties can be rendered in Web Report Studio and JDashboard:

Auto Fit , Maximum Width, Word Wrap

Here is a label:
Label product sales by region

We want to show it as:
Label product
sales by region

We can set the following:

Auto Fit=true enables the contents to grow horizontally but stop when the width becomes 1. Word Wrap=true enables the remaining contents to wrap downward if no space is left horizontally.

Style, ID, Class

The following is an example of using the Style, ID, Class property values as style sheet selectors in a CSS style file:

NewCSSFile.css:

@charset "GBK";
TextField {Background: #ff0000}
/*Style=LabelX*/
TextField[Style="LabelX"]{Background: #0000FF}
/*ID=W*/
TextField#W{Background: #FFFF00}
/*class=C*/
TextField.C{Background: #00FFFF}

Bind Column

By default, the Sort and Filter shortcut menu items are only available on fields (including DBField, formula and summary) in banded objects or tables. JReport provides you with the option to enable the two menu items on labels in the banded objects or tables by binding them with fields.

  1. Select a label in a banded object or table.
  2. In the Report Inspector, locate the Bind Column property. All the fields used in the banded object or table are listed in the property's value drop-down list. Select one to bind with the label.
  3. If you want to display the sort and filter buttons beside the label at server runtime which provide another easy way for sorting and filtering, go on set the Sortable and Filterable properties of the label to true.
  4. Save the report and publish it to JReport Server.
  5. Run the report and you can then right-click the label or the proper button beside the label to sort or filter the records of the bound field.

    Label Bind with Column

When a label in a page report is bound with a field, you can further specify the options that will be displayed on its Filter submenu at runtime with its Filter Options property.

Filter Options

When you run a page report that is created using query resources in Page Report Studio, if you right-click a filterable label (a label with a Bind Column) in a banded object or table, or a field (including DBField, formula and summary) in the report, you will find the Filter submenu. This submenu can list items such as Remove Filter, Top N, Bottom N, and More. With these menu items you can easily filter the records. While if you do not want to show some of the four items for a field or filterable label, you can set the filter options in JReport Designer as follows.

  1. Select the field or label and locate its Filter Options property in the Report Inspector.
  2. Click Choose button in the value cell to bring out the Filter Options dialog.

    Filter Options dialog

  3. Check the items you want to show on the Filter submenu of the field in Page Report Studio, and then click OK.
  4. The properties value will be generated, equal to sum of values of those selected items. The items and corresponding values when checked are as follows:

    Remove Filter: 1
    Top N: 2
    Bottom N: 4
    More: 8
    Default: 16

  5. After saving the page report and publishing it to JReport Server, you will see the effect.

Note: In the Filter Options dialog, only when Default is deselected will the remaining four checkboxes be enabled. If you check Default, they will be disabled, but their values will still affect the Filter Options property value. If Default is checked (Filter Options >= 16), which items will be displayed on the Filter submenu in Page Report Studio will be determined by settings in the Page Report Studio profile on JReport Server (Profile > Customize Profile > Page Report Studio > Properties > Default > Filter Menu).

Record Location

This property is to specify the calculation point for the properties of the object. Here is an example:

A report specifies to display Continued on Next Page for every page that has another following it. If this label is inserted in the Page Header/Page Footer, then every page including the last page will contain the message. There is a way to write formulas that can resolve the problem:

Continue1:
global boolean j=true;
j=false;

Continue2:
pagenumber;
j=true;

Continue3:
pagenumber;
return j;

Insert Continue1 into the Report Header, Continue2 into the Report Footer. To track the calculation, you can insert Continue3 into the Page Footer. If you do not want to see these formulas in view mode, you can suppress them.

Insert label Continued on Next Page in the Page Header, and use Continue3 to control its property Invisible.

Set the property Record Location of the above label to be Page Footer, so that Continue3 returns value which is calculated in the Page Footer instead of in the Page Header.

PageNumber is included in the formula to force it to execute as a page level formula in the order the formula is encountered rather than at the end of a group or report. For more information, see Formula Levels.

BackPrevious Page Next PageNext