Eclipse BIRT Report Object Model (ROM)
ColumnHint Structure
| Display Name: | Column Hint |
| Since: | 1.0 |
A column hint defines report-related data attributes about a retrieved column or a computed column.
Provides an "alias" name to the column for use within the report.
| Type: | string |
| Since: | 1.0 |
| Required: | No |
| Display Name: | Alias |
| JavaScript Type: | |
| Default Value: | None |
| Runtime Settable: | No |
Provides an "alias" name to the column for use within the report. Useful if the column names are awkward. Optional.
Determines how the column is used when exporting the data to an OLAP cube.
| Type: | choice (analysisType) |
| Since: | 2.5.1 |
| Required: | No |
| Display Name: | Analysis |
| JavaScript Type: | |
| Default Value: | None |
| Runtime Settable: | No |
| Name | Display Name | Value | Description |
| dimension | Dimension | dimension | The column is a dimension. Use the Parent Dimension property to define the dimension hierarchy. |
| attribute | Attribute | attribute | The column provides additional information about a level. Use the Parent level property to define the level for which this column is a detail. |
| measure | Measure | measure | The column is numeric measure. |
Determines how the column is used when exporting the data to an OLAP cube. OLAP cubes require that the columns be structured into dimension hierarchies. Such hierarchies are formed though a sequence of dimensions. The intersection of hierarchies has one or more numeric measures. Columns that are neither dimensions nor measures can be detail attributes associated with a dimension. Whether any given column is actually available for use with analysis depends on the Export property above.
The name of the result set column for which hints are defined.
| Type: | string |
| Since: | 1.0 |
| Required: | Yes |
| Display Name: | Column Name |
| JavaScript Type: | |
| Default Value: | None |
| Runtime Settable: | No |
This property keys the column hint to a column within the result set. The name is defined either by the data provider, a result set column definition, or a computed column definition.
The optional localizable display name for the column.
| Type: | string |
| Since: | 1.0 |
| Required: | No |
| Display Name: | Display Name |
| JavaScript Type: | |
| Default Value: | None |
| Runtime Settable: | No |
The name displayed to the end-user for the column. The display name can be localized. If the display name is omitted, the column name itself is displayed instead.
| Type: | resourceKey |
| Since: | 1.0 |
| Required: | No |
| Display Name: | Display Name Resource Key |
| JavaScript Type: | |
| Default Value: | None |
| Runtime Settable: | Yes |
Determines how the column will be used when exporting data.
| Type: | choice (exportType) |
| Since: | reserved |
| Required: | No |
| Display Name: | Export |
| JavaScript Type: | |
| Default Value: | if-realized |
| Runtime Settable: | No |
| Name | Display Name | Value | Description |
| none | No Export Type | none | The column cannot be exported. |
| if-realized | If Realized | if-realized | The column can be exported only if it is referenced somewhere in the report. |
| always | Always | always | The column can always be exported. This setting acts like a column reference, and forces the column to be realized even if the column is not otherwise used within the report. |
Determines how the column will be used when exporting data.
The format string used to format the column data when displaying the value in the search result UI.
| Type: | string |
| Since: | reserved |
| Required: | No |
| Display Name: | Format |
| JavaScript Type: | |
| Default Value: | None |
| Runtime Settable: | No |
An optional BIRT format string used to format the column data when displaying the value in the viewing UI, especially within the search results.
Style format properties
The optional localizable descriptive text that explains the column to the end user.
| Type: | string |
| Since: | 1.0 |
| Required: | No |
| Display Name: | Help Text |
| JavaScript Type: | |
| Default Value: | None |
| Runtime Settable: | No |
Additional pop-up help text associated with the column. This descriptive text can explain the purpose of the column to the end user. The help text can be localized.
| Type: | resourceKey |
| Since: | 1.0 |
| Required: | No |
| Display Name: | Help Text Resource Key |
| JavaScript Type: | |
| Default Value: | None |
| Runtime Settable: | Yes |
| Type: | boolean |
| Since: | 2.5.1 |
| Required: | No |
| Display Name: | On Column Layout |
| JavaScript Type: | |
| Default Value: | None |
| Runtime Settable: | No |
Specifies the parent of the column when exporting the data to an OLAP cube.
| Type: | string |
| Since: | reserved |
| Required: | No |
| Display Name: | Parent Level |
| JavaScript Type: | |
| Default Value: | None |
| Runtime Settable: | No |
Used when a column’s Analysis property is set to Dimension or Detail. For Dimensions, this property establishes the dimension hierarchy. Lower (more detailed) dimensions identify their parent (more general) dimensions. For details, this property identifies the dimension for which this column is a detail attribute.
Indicates how the column will be used when searching.
| Type: | choice (searchType) |
| Since: | reserved |
| Required: | No |
| Display Name: | Searching |
| JavaScript Type: | |
| Default Value: | any |
| Runtime Settable: | Yes |
| Name | Display Name | Value | Description |
| any | Any | any | The column is always searchable, whether it is indexed or not. |
| indexed | Indexed | indexed | The column is searchable if it is indexed. |
| none | No Search Type | none | The column is not searchable. |
Indicates how the column will be used when searching.