Eclipse BIRT Report Object Model (ROM)
LayoutModule Element
Display Name: | Layout Module |
Since: | 2.5 |
XML Element: | None |
Extends: | Module |
Extendable: | No |
Abstract: | Yes |
Name Space: | None |
Name Requirement: | Optional |
Allows User Properties: | No |
Has Style: | No |
author, comments, createdBy, description, descriptionID, includeResource, includeScripts, scriptLibs, title, titleID
The layout module element extends the common module element with layout infomations. It also provides a list of custom color definitions.
A base directory to use when computing relative links from this report.
Type: | string |
Since: | reserved |
Required: | No |
Display Name: | Base |
JavaScript Type: | |
Default Value: | None |
Inherited: | No |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
A base directory to use when computing relative links from this report. Most often used for reports created externally to the server and submitted on the fly. Used when computing hyperlinks, library includes, image includes and other relative file references. See the W3C XML Base standard for background: http://www.w3.org/TR/2001/REC-xmlbase-20010627/.
A set of custom color names.
Type: | List of CustomColor Structures |
Since: | reserved |
Required: | No |
Display Name: | Color palette |
JavaScript Type: | |
Default Value: | None |
Inherited: | No |
Runtime Settable: | No |
Property Sheet Visibility: | Hidden |
Property Sheet Group: | Top |
The developer can define a set of custom color names as part of the design. The developer can then reference these names within properties. Defining the colors in the palette helps the developer achieve a consistent look throughout the report, and allows colors to be refined by changing just one place.
Every custom color has three parts: a display name, an internal name and an RGB value. The display name is what the developer sees. If the palette will be used by people in different countries, then the display name can be externalized and translated. The internal name identifies the color within the design and in the XML design file. The internal name cannot be localized. Finally, the RGB value gives the actual color.
Custom Color structure
List of configuration variables.
Type: | List of ConfigVar Structures |
Since: | 1.0 |
Required: | No |
Display Name: | Config variables |
JavaScript Type: | |
Default Value: | None |
Inherited: | No |
Runtime Settable: | Yes |
Property Sheet Visibility: | Hidden |
Property Sheet Group: | Top |
Reports frequently have deployment-specific dependencies. For example, developers often use a test database during development, but target a production database once the report is deployed. Or, an OEM may use a different company name in report titles for each of their customers. BIRT provides configuration variables to support such cases. A configuration variable is a name/value pair.
See the helpGuide
and the
description
properties for a way to provide
information for the users of the report.
External file that provides help information for the report.
Type: | uri |
Since: | reserved |
Required: | No |
Display Name: | Help guide |
JavaScript Type: | |
Default Value: | None |
Inherited: | No |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
The help guide is an external file that provides help information for the report. Help information can include detailed information about parameters, report content or other information. The file can be in any format supported by the browser. The help guide will open in a separate popup window.
Library element
A list of images embedded in this report.
Type: | List of EmbeddedImage Structures |
Since: | 1.0 |
Required: | No |
Display Name: | Images |
JavaScript Type: | |
Default Value: | None |
Inherited: | No |
Runtime Settable: | No |
Property Sheet Visibility: | Hidden |
Property Sheet Group: | Top |
A design often uses images. Most images in a report will be accessed via a URL, or a file deployed externally to the report. However, some reports may want to embed an image directly into the report design. Embedded images are especially helpful if a report design is generated in a custom application and sent to the server for one-time execution.
Images have a name. The name allows an image item to reference the embedded image. Scripts can use the image name to retrieve the image from the images array:
var img = report.design.images["MyImage"]
Image item
Libraries that are included by this module.
Type: | List of IncludedLibrary Structures |
Since: | reserved |
Required: | No |
Display Name: | libraries |
JavaScript Type: | |
Default Value: | None |
Inherited: | No |
Runtime Settable: | No |
Property Sheet Visibility: | Hidden |
Property Sheet Group: | Top |
Includes a list of libraries.
Binds a property from an element to an expression.
Type: | List of PropertyBinding Structures |
Since: | 2.0 |
Required: | No |
Display Name: | Property bindings |
JavaScript Type: | |
Default Value: | None |
Inherited: | No |
Runtime Settable: | No |
Property Sheet Visibility: | Hidden |
Property Sheet Group: | Top |
There is requirement that a property value for an elemenet can be overridden at runtime. This list is used to bind a property of an element to an expression, user can override the value if expression bind to an parameter.
Type: | string |
Since: | 2.3 |
Required: | No |
Display Name: | Subject |
JavaScript Type: | |
Default Value: | None |
Inherited: | No |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
Specify the theme that is to be used by the design or library.
Type: | Theme Reference |
Since: | 2.0 |
Required: | No |
Display Name: | Theme |
JavaScript Type: | |
Default Value: | None |
Inherited: | No |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
When a report/library include another library, it can use one of the theme provided by the included library. When a theme is applied, the report/library is able to reuse all the styles contained in this theme.
Default units to be used for the report design.
Type: | choice (units) |
Since: | 1.0 |
Required: | No |
Display Name: | Units |
JavaScript Type: | |
Default Value: | None |
Inherited: | No |
Runtime Settable: | Yes |
Property Sheet Visibility: | Hidden |
Property Sheet Group: | Top |
Name | Display Name | Value | Description |
in | in | in | |
cm | cm | cm | |
mm | mm | mm | |
pt | points | pt | |
pc | picas | pc | |
em | ems | em | |
ex | exs | ex | |
px | pixels | px | |
% | % | % |