Eclipse BIRT Report Object Model (ROM)

LayoutModule Element

# Element Overview

Report design information common to report designs and libraries with layout. This is most of the report except for the body.

### Details

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

### Property Summary

base
  A base directory to use when computing relative links from this report.
colorPalette
  A set of custom color names.
configVars
  List of configuration variables.
helpGuide
  External file that provides help information for the report.
images
  A list of images embedded in this report.
libraries
  Libraries that are included by this module.
propertyBindings
  Binds a property from an element to an expression.
subject
theme
  Specify the theme that is to be used by the design or library.
units
  Default units to be used for the report design.

### Inherited Properties

author, comments, createdBy, description, descriptionID, includeResource, includeScripts, scriptLibs, title, titleID

### Description

The layout module element extends the common module element with layout infomations. It also provides a list of custom color definitions.

# Property Detail

## base Property

A base directory to use when computing relative links from this report.

### Details

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

### Description

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/.

### See Also

## colorPalette Property

A set of custom color names.

### Details

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

### Description

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.

### See Also

Custom Color structure

## configVars Property

List of configuration variables.

### Details

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

### Description

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 Also

See the `helpGuide` and the `description` properties for a way to provide information for the users of the report.

## helpGuide Property

External file that provides help information for the report.

### Details

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

### Description

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.

### See Also

Library element

## images Property

A list of images embedded in this report.

### Details

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

### Description

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"]

### See Also

Image item

## libraries Property

Libraries that are included by this module.

### Details

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

### Description

Includes a list of libraries.

## propertyBindings Property

Binds a property from an element to an expression.

### Details

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

### Description

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.

## subject Property

### Details

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

## theme Property

Specify the theme that is to be used by the design or library.

### Details

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

### Description

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.

## units Property

Default units to be used for the report design.

### Details

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

### Choices

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 |
% | % | % |