Eclipse BIRT Report Object Model (ROM)
ColumnHint Structure
Structure Overview
Provides a number of
report-related data attributes about a result set column.
Details
| Display Name: |
Column Hint |
| Since: |
1.0 |
Property Summary
- ACLExpression
- action
- alias
- Provides an "alias" name to the column for use within the report.
- analysis
- Determines how the column is used when exporting the data to an OLAP cube.
- analysisColumn
- columnName
- The name of the result set column for which hints are defined.
- compressed
- description
- descriptionID
- displayLength
- displayName
- The optional localizable display name for the column.
- displayNameID
- export
- Determines how the column will be used when exporting data.
- format
- The format string used to format the column data when displaying the value in the search result UI.
- heading
- headingID
- helpText
- The optional localizable descriptive text that explains the column to the end user.
- helpTextID
- horizontalAlign
- indexColumn
- onColumnLayout
- parentLevel
- Specifies the parent of the column when exporting the data to an OLAP cube.
- searching
- Indicates how the column will be used when searching.
- textFormat
- valueFormat
- wordWrap
Description
A column hint defines report-related data attributes
about a retrieved column or a computed column.
Property Detail
Details
| Type: |
expression |
| Context: |
|
| Expression Type: |
None |
| Since: |
2.5.2 |
| Required: |
No |
| Display Name: |
ACL Expression |
| JavaScript Type: |
|
| Default Value: |
None |
| Runtime Settable: |
No |
Details
| Type: |
Action Structure |
| Since: |
2.5.2 |
| Required: |
No |
| Display Name: |
Action |
| JavaScript Type: |
|
| Default Value: |
None |
| Runtime Settable: |
No |
Provides an "alias" name to the column for use within the report.
Details
| Type: |
string |
| Since: |
1.0 |
| Required: |
No |
| Display Name: |
Alias |
| JavaScript Type: |
|
| Default Value: |
None |
| Runtime Settable: |
No |
Description
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.
Details
| Type: |
choice (analysisType) |
| Since: |
2.5.1 |
| Required: |
No |
| Display Name: |
Analysis |
| JavaScript Type: |
|
| Default Value: |
None |
| Runtime Settable: |
No |
Choices
| 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. |
Description
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.
Details
| Type: |
string |
| Since: |
2.6 |
| Required: |
No |
| Display Name: |
Analysis Column |
| JavaScript Type: |
|
| Default Value: |
None |
| Runtime Settable: |
No |
The name of the result set column for which hints are defined.
Details
| Type: |
string |
| Since: |
1.0 |
| Required: |
Yes |
| Display Name: |
Column Name |
| JavaScript Type: |
|
| Default Value: |
None |
| Runtime Settable: |
No |
Description
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.
Details
| Type: |
boolean |
| Since: |
2.6.1 |
| Required: |
No |
| Display Name: |
Compressed |
| JavaScript Type: |
|
| Default Value: |
None |
| Runtime Settable: |
No |
Details
| Type: |
string |
| Since: |
2.5.2 |
| Required: |
No |
| Display Name: |
Description |
| JavaScript Type: |
|
| Default Value: |
None |
| Runtime Settable: |
No |
Details
| Type: |
resourceKey |
| Since: |
2.5.2 |
| Required: |
No |
| Display Name: |
Description Resource Key |
| JavaScript Type: |
|
| Default Value: |
None |
| Runtime Settable: |
Yes |
Details
| Type: |
integer |
| Since: |
2.5.2 |
| Required: |
No |
| Display Name: |
Display Length |
| JavaScript Type: |
|
| Default Value: |
None |
| Runtime Settable: |
No |
The optional localizable display name for the column.
Details
| Type: |
string |
| Since: |
1.0 |
| Required: |
No |
| Display Name: |
Display Name |
| JavaScript Type: |
|
| Default Value: |
None |
| Runtime Settable: |
No |
Description
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.
Details
| 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.
Details
| Type: |
choice (exportType) |
| Since: |
reserved |
| Required: |
No |
| Display Name: |
Export |
| JavaScript Type: |
|
| Default Value: |
if-realized |
| Runtime Settable: |
No |
Choices
| 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. |
Description
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.
Details
| Type: |
string |
| Since: |
reserved |
| Required: |
No |
| Display Name: |
Format |
| JavaScript Type: |
|
| Default Value: |
None |
| Runtime Settable: |
No |
Description
An optional BIRT format string used to format the column
data when displaying the value in the viewing UI, especially within the search
results.
See Also
Details
| Type: |
string |
| Since: |
2.5.2 |
| Required: |
No |
| Display Name: |
Heading |
| JavaScript Type: |
|
| Default Value: |
None |
| Runtime Settable: |
No |
Details
| Type: |
resourceKey |
| Since: |
2.5.2 |
| Required: |
No |
| Display Name: |
Heading Resource Key |
| JavaScript Type: |
|
| Default Value: |
None |
| Runtime Settable: |
Yes |
The optional localizable descriptive text that explains the column to the end user.
Details
| Type: |
string |
| Since: |
1.0 |
| Required: |
No |
| Display Name: |
Help Text |
| JavaScript Type: |
|
| Default Value: |
None |
| Runtime Settable: |
No |
Description
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.
Details
| Type: |
resourceKey |
| Since: |
1.0 |
| Required: |
No |
| Display Name: |
Help Text Resource Key |
| JavaScript Type: |
|
| Default Value: |
None |
| Runtime Settable: |
Yes |
Details
| Type: |
choice (textAlign) |
| Since: |
2.5.2 |
| Required: |
No |
| Display Name: |
Horizontal Alignment |
| JavaScript Type: |
|
| Default Value: |
None |
| Runtime Settable: |
No |
Choices
| Name | Display Name |
Value | Description |
| left |
Left |
left |
|
| center |
Center |
center |
|
| right |
Right |
right |
|
| justify |
Justify |
justify |
|
Details
| Type: |
boolean |
| Since: |
2.6.1 |
| Required: |
No |
| Display Name: |
Index Column |
| JavaScript Type: |
|
| Default Value: |
None |
| Runtime Settable: |
No |
Details
| 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.
Details
| Type: |
string |
| Since: |
reserved |
| Required: |
No |
| Display Name: |
Parent Level |
| JavaScript Type: |
|
| Default Value: |
None |
| Runtime Settable: |
No |
Description
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.
Details
| Type: |
choice (searchType) |
| Since: |
reserved |
| Required: |
No |
| Display Name: |
Searching |
| JavaScript Type: |
|
| Default Value: |
any |
| Runtime Settable: |
Yes |
Choices
| 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. |
Description
Indicates how the column will be used when searching.
Details
| Type: |
choice (stringFormat) |
| Since: |
2.5.2 |
| Required: |
No |
| Display Name: |
Text Format |
| JavaScript Type: |
|
| Default Value: |
None |
| Runtime Settable: |
No |
Choices
| Name | Display Name |
Value | Description |
| Unformatted |
Unformatted |
Unformatted |
|
| > |
Uppercase |
> |
|
| < |
Lowercase |
< |
|
| Zip Code |
Zip Code |
Zip Code |
|
| Zip Code + 4 |
Zip Code + 4 |
Zip Code + 4 |
|
| Phone Number |
Phone Number |
Phone Number |
|
| Social Security Number |
Social Security Number |
Social Security Number |
|
| Custom |
Custom |
Custom |
|
Details
| Type: |
FormatValue Structure |
| Since: |
2.6 |
| Required: |
No |
| Display Name: |
Value Format |
| JavaScript Type: |
|
| Default Value: |
None |
| Runtime Settable: |
No |
Details
| Type: |
boolean |
| Since: |
2.5.2 |
| Required: |
No |
| Display Name: |
Word Wrap |
| JavaScript Type: |
|
| Default Value: |
None |
| Runtime Settable: |
No |