Eclipse BIRT Report Object Model (ROM)

CustomColor Structure

# Structure Overview

Defines a custom color name.

### Details

Display Name: | CustomColor
Since: | reserved

### Property Summary

color
  The RGB value of the color.
displayName
  The user-visible, translatable name of the color
displayNameID
name
  The internal, non-translated name of the color.

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

# Property Detail

## color Property

The RGB value of the color.

### Details

Type: | string
Since: | reserved
Required: | Yes
Display Name: | Color
JavaScript Type: |
Default Value: | None
Runtime Settable: | No

### Description

Defines the color. The color can be defined using any of the following formats:

- CSS absolute: rgb( R, G, B ), with each value in decimal
- CSS relative: rgb( R%, G%, B% )
- HTML-style: #RRGGBB
- Java-style: 0xRRGGBB
- Decimal

## displayName Property

The user-visible, translatable name of the color

### Details

Type: | string
Since: | reserved
Required: | No
Display Name: | Display Name
JavaScript Type: |
Default Value: | None
Runtime Settable: | No

### Description

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.

### See Also

Text Structure

## displayNameID Property

### Details

Type: | resourceKey
Since: | reserved
Required: | No
Display Name: | Display Name Key
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

## name Property

The internal, non-translated name of the color.

### Details

Type: | name
Since: | reserved
Required: | Yes
Display Name: | Name
JavaScript Type: |
Default Value: | None
Runtime Settable: | No

### Description

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.

### See Also

Style element `color` property

Style element `backgroundColor` property