Eclipse BIRT Report Object Model (ROM)
Property Types
Display Name: | Boolean |
Since: | 1.0 |
XML Name: | boolean |
JavaScript Design Type: | |
JavaScript Runtime Type: |
Provides a simple true/false value. The values are represented by the JavaScript true and false values in scripts and expressions. They are represented as "true" and "false" in the XML file.
Display Name: | Choice |
Since: | 1.0 |
XML Name: | choice |
JavaScript Design Type: | |
JavaScript Runtime Type: |
The choice property type indicates that a property provides a fixed set of choices. Any property of this type must also provide a separate list of the choices. The list of choices is defined as a separate named "choice set."
Display Name: | Color |
Since: | 1.0 |
XML Name: | color |
JavaScript Design Type: | |
JavaScript Runtime Type: |
Represents a color. Colors can use the CSS color names, a CSS-format RGB value (#RRGGBB), or a custom color name defined within the report.
Display Name: | Element as Property Value |
Since: | 1.0 |
XML Name: | contentElement |
JavaScript Design Type: | |
JavaScript Runtime Type: |
Display Name: | DateTime |
Since: | 1.0 |
XML Name: | dateTime |
JavaScript Design Type: | |
JavaScript Runtime Type: |
A date/time value in (what format?) Not used in Release 1.
Display Name: | Dimension |
Since: | 1.0 |
XML Name: | dimension |
JavaScript Design Type: | |
JavaScript Runtime Type: |
A CSS dimension. The units are expressed as a floating point number such as �1.25�. To override that default, specify a suffix as one of �in� (inches), �mm� (millimeters), �cm� (centimeters), �pt� (points), �pc� (picas), �%� (percent), �em� (�em� size for the current font) or �ex� (�ex� size for the current font.)
A dimension is a physical measurement. Dimensions always have a unit. Supported units include the following defined in CSS:
Unit Suffix | Meaning |
cm | Centimeters |
in | Inches |
mm | Millimeters |
pt | Points (1/72 of an inch) |
pc | Pica (1 pica is equal to 12 points) |
px | Pixels. (For print, see the CSS spec. A pixel is about 0.21 mm.) |
em | ems, the height of the element's font |
ex | x-height, the height of the letter 'x' |
% | Percentage. The definition of each property identifies the container property from which the value is computed. |
Display Name: | Element |
Since: | 1.0 |
XML Name: | element |
JavaScript Design Type: | |
JavaScript Runtime Type: |
A reference to another element in the design. BIRT automatically updates the property when the name of the referenced element changes. BIRT will issue an error if the target element does not exist.
Display Name: | Element Reference |
Since: | 1.0 |
XML Name: | elementRef |
JavaScript Design Type: | |
JavaScript Runtime Type: |
Display Name: | Expression |
Since: | 1.0 |
XML Name: | expression |
JavaScript Design Type: | |
JavaScript Runtime Type: |
A BIRT expression using JavaScript and the BIRT extensions.
Display Name: | Extends |
Since: | 1.0 |
XML Name: | extends |
JavaScript Design Type: | |
JavaScript Runtime Type: |
A reference to a parent element of the same type as the derived element. This property type is used in just one place to implement element inheritance.
Display Name: | Float |
Since: | 1.0 |
XML Name: | float |
JavaScript Design Type: | |
JavaScript Runtime Type: |
A floating-point number. Not used in Release 1.
Display Name: | Html |
Since: | 1.0 |
XML Name: | html |
JavaScript Design Type: | |
JavaScript Runtime Type: |
Property that stores html value. Model doesn't do validation to this property type.
Display Name: | Integer |
Since: | 1.0 |
XML Name: | integer |
JavaScript Design Type: | |
JavaScript Runtime Type: |
Display Name: | List |
Since: | 1.0 |
XML Name: | list |
JavaScript Design Type: | |
JavaScript Runtime Type: |
Display Name: | Literal String |
Since: | 1.0 |
XML Name: | literalString |
JavaScript Design Type: | |
JavaScript Runtime Type: |
Display Name: | Member Key |
Since: | 1.0 |
XML Name: | memberKey |
JavaScript Design Type: | |
JavaScript Runtime Type: |
Display Name: | Name |
Since: | 1.0 |
XML Name: | name |
JavaScript Design Type: | |
JavaScript Runtime Type: |
Identifies a property within a structure that provides the name to be used for associative lookup in property lists.
All property lists allow numeric indexes. Some also allow associative lookup using the name of an item in the list. For example, to look up the custom color: �seaGreen�:
var colorDefn = designDefn.palette.seaGreen
or,
var colorDefn = designDefn.palette[ �seaGreen� ]
The first form can be used when the name to be looked up is known when the code is written, and follow the JavaScript identifier naming rules. The second form can be used to look up a value when the value is not known ahead of time, or when the name does not follow JavaScript identifier rules. For example:
var colorDefn = designDefn.palette[ params.colorName ]; var colorDefn = designDefn.palette[ �Sea-Green� ]
The associative lookup is provided when:
Display Name: | Number |
Since: | 1.0 |
XML Name: | number |
JavaScript Design Type: | |
JavaScript Runtime Type: |
An arbitrary-precision decimal number. Is accurate enough to represent the largest currency amounts down to two decimal places.
Display Name: | MessageId |
Since: | 1.0 |
XML Name: | resourceKey |
JavaScript Design Type: | |
JavaScript Runtime Type: |
A string value, which should match a message in the customer's message category. It allows user to localize an exteralizable property
Display Name: | Script |
Since: | 1.0 |
XML Name: | script |
JavaScript Design Type: | |
JavaScript Runtime Type: |
A block of script value that is to be executed at runtime, script are not validated in model at design-time
Display Name: | String |
Since: | 1.0 |
XML Name: | string |
JavaScript Design Type: | |
JavaScript Runtime Type: |
A string value. The string cannot be externalized.
Display Name: | Structure Reference |
Since: | 1.0 |
XML Name: | structRef |
JavaScript Design Type: | |
JavaScript Runtime Type: |
Simply references to another structure, it can be in two states: resolved or unresolved.
Display Name: | Property.struct |
Since: | 1.0 |
XML Name: | structure |
JavaScript Design Type: | |
JavaScript Runtime Type: |
A structure property is one made up of a set of named fields. Structure properties are often lists.
Display Name: | Uri |
Since: | 1.0 |
XML Name: | uri |
JavaScript Design Type: | |
JavaScript Runtime Type: |
A URI of the form "http:", "file:", "iServer:", or "mailto:".
Display Name: | Xml |
Since: | 1.0 |
XML Name: | xml |
JavaScript Design Type: | |
JavaScript Runtime Type: |
Text in XML format. Is often a fragment of XML rather than a complete file. The use of this property tells the design file writer to enclose the value in a CDATA block.