Eclipse BIRT Report Object Model (ROM)
CustomColor Structure
Display Name: | CustomColor |
Since: | reserved |
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.
The RGB value of the color.
Type: | string |
Since: | reserved |
Required: | Yes |
Display Name: | Color |
JavaScript Type: | |
Default Value: | None |
Runtime Settable: | No |
Defines the color. The color can be defined using any of the following formats:
The user-visible, translatable name of the color
Type: | string |
Since: | reserved |
Required: | No |
Display Name: | Display Name |
JavaScript Type: | |
Default Value: | None |
Runtime Settable: | No |
A custom color can contain a localizable display name. This is most useful for colors defined in a library and that will be used within the web report designer.
If the design does not provide a display name, then the color name appears in the UI.
Text Structure
Type: | resourceKey |
Since: | reserved |
Required: | No |
Display Name: | Display Name Key |
JavaScript Type: | |
Default Value: | None |
Runtime Settable: | Yes |
The internal, non-translated name of the color.
Type: | name |
Since: | reserved |
Required: | Yes |
Display Name: | Name |
JavaScript Type: | |
Default Value: | None |
Runtime Settable: | No |
Each color requires an internal name. This is the name used in a color property when referencing the custom color. Color names must be unique, and must be unique with respect to the 17 standard CSS color names.
Style element color
property
Style element backgroundColor
property