Eclipse BIRT Report Object Model (ROM)

HighlightRule Structure

Structure Overview

Represents a highlight rule;each highlight rule consists of an expression, operator, values, and corresponding format style

Details

Display Name:	HighlightRule
Since:	1.0

Property Summary

backgroundColor
bidiTextDirection
borderBottomColor
borderBottomStyle
borderBottomWidth
borderLeftColor
borderLeftStyle
borderLeftWidth
borderRightColor
borderRightStyle
borderRightWidth
borderTopColor
borderTopStyle
borderTopWidth
color
dateTimeFormat
fontFamily
fontSize
fontStyle
fontVariant
fontWeight
isDesignTime
numberAlign
numberFormat
operator: The operator for a simple condition
stringFormat
style
testExpr: An expression used to apply a particular format style
textAlign
textIndent
textLineThrough
textOverline
textTransform
textUnderline
value1: The value for simple conditions with the operators: <, <=, =, <>, >=, >, between, not between, like
value2: The value for simple conditions with the operators: between, not between

Description

A highlight rule gives a set of conditional style properties. The style is applied only if the rule �fires.�

Property Detail

backgroundColor Property

Details

Type:	color
Since:	1.0
Required:	No
Display Name:	Background Color
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
maroon	Maroon	maroon
red	Red	red
orange	Orange	orange
yellow	Yellow	yellow
olive	Olive	olive
purple	Purple	purple
fuchsia	Fuchsia	fuchsia
white	White	white
lime	Lime	lime
green	Green	green
navy	Navy	navy
blue	Blue	blue
aqua	Aqua	aqua
teal	Teal	teal
black	Black	black
silver	Silver	silver
gray	Gray	gray

bidiTextDirection Property

Details

Type:	choice (bidiDirection)
Since:	2.3
Required:	No
Display Name:	Text direction
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
ltr	Left To Right	ltr
rtl	Right To Left	rtl

borderBottomColor Property

Details

Type:	color
Since:	1.0
Required:	No
Display Name:	Color
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
maroon	Maroon	maroon
red	Red	red
orange	Orange	orange
yellow	Yellow	yellow
olive	Olive	olive
purple	Purple	purple
fuchsia	Fuchsia	fuchsia
white	White	white
lime	Lime	lime
green	Green	green
navy	Navy	navy
blue	Blue	blue
aqua	Aqua	aqua
teal	Teal	teal
black	Black	black
silver	Silver	silver
gray	Gray	gray

borderBottomStyle Property

Details

Type:	choice (lineStyle)
Since:	1.0
Required:	No
Display Name:	Style
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
none	No Line Style	none
solid	Solid	solid
dotted	Dotted	dotted
dashed	Dashed	dashed
double	Double	double
groove	Groove	groove
ridge	Ridge	ridge
inset	Inset	inset
outset	Outset	outset

borderBottomWidth Property

Details

Type:	dimension
Since:	1.0
Required:	No
Display Name:	Width
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
thin	Thin	thin
medium	Medium	medium
thick	Thick	thick

borderLeftColor Property

Details

Type:	color
Since:	1.0
Required:	No
Display Name:	Color
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
maroon	Maroon	maroon
red	Red	red
orange	Orange	orange
yellow	Yellow	yellow
olive	Olive	olive
purple	Purple	purple
fuchsia	Fuchsia	fuchsia
white	White	white
lime	Lime	lime
green	Green	green
navy	Navy	navy
blue	Blue	blue
aqua	Aqua	aqua
teal	Teal	teal
black	Black	black
silver	Silver	silver
gray	Gray	gray

borderLeftStyle Property

Details

Type:	choice (lineStyle)
Since:	1.0
Required:	No
Display Name:	Style
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
none	No Line Style	none
solid	Solid	solid
dotted	Dotted	dotted
dashed	Dashed	dashed
double	Double	double
groove	Groove	groove
ridge	Ridge	ridge
inset	Inset	inset
outset	Outset	outset

borderLeftWidth Property

Details

Type:	dimension
Since:	1.0
Required:	No
Display Name:	Width
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
thin	Thin	thin
medium	Medium	medium
thick	Thick	thick

borderRightColor Property

Details

Type:	color
Since:	1.0
Required:	No
Display Name:	Color
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
maroon	Maroon	maroon
red	Red	red
orange	Orange	orange
yellow	Yellow	yellow
olive	Olive	olive
purple	Purple	purple
fuchsia	Fuchsia	fuchsia
white	White	white
lime	Lime	lime
green	Green	green
navy	Navy	navy
blue	Blue	blue
aqua	Aqua	aqua
teal	Teal	teal
black	Black	black
silver	Silver	silver
gray	Gray	gray

borderRightStyle Property

Details

Type:	choice (lineStyle)
Since:	1.0
Required:	No
Display Name:	Style
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
none	No Line Style	none
solid	Solid	solid
dotted	Dotted	dotted
dashed	Dashed	dashed
double	Double	double
groove	Groove	groove
ridge	Ridge	ridge
inset	Inset	inset
outset	Outset	outset

borderRightWidth Property

Details

Type:	dimension
Since:	1.0
Required:	No
Display Name:	Width
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
thin	Thin	thin
medium	Medium	medium
thick	Thick	thick

borderTopColor Property

Details

Type:	color
Since:	1.0
Required:	No
Display Name:	Color
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
maroon	Maroon	maroon
red	Red	red
orange	Orange	orange
yellow	Yellow	yellow
olive	Olive	olive
purple	Purple	purple
fuchsia	Fuchsia	fuchsia
white	White	white
lime	Lime	lime
green	Green	green
navy	Navy	navy
blue	Blue	blue
aqua	Aqua	aqua
teal	Teal	teal
black	Black	black
silver	Silver	silver
gray	Gray	gray

borderTopStyle Property

Details

Type:	choice (lineStyle)
Since:	1.0
Required:	No
Display Name:	Style
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
none	No Line Style	none
solid	Solid	solid
dotted	Dotted	dotted
dashed	Dashed	dashed
double	Double	double
groove	Groove	groove
ridge	Ridge	ridge
inset	Inset	inset
outset	Outset	outset

borderTopWidth Property

Details

Type:	dimension
Since:	1.0
Required:	No
Display Name:	Width
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
thin	Thin	thin
medium	Medium	medium
thick	Thick	thick

color Property

Details

Type:	color
Since:	1.0
Required:	No
Display Name:	Color
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
maroon	Maroon	maroon
red	Red	red
orange	Orange	orange
yellow	Yellow	yellow
olive	Olive	olive
purple	Purple	purple
fuchsia	Fuchsia	fuchsia
white	White	white
lime	Lime	lime
green	Green	green
navy	Navy	navy
blue	Blue	blue
aqua	Aqua	aqua
teal	Teal	teal
black	Black	black
silver	Silver	silver
gray	Gray	gray

dateTimeFormat Property

Details

Type:	DateTimeFormatValue Structure
Since:	1.0
Required:	No
Display Name:	Date Time Format
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

fontFamily Property

Details

Type:	string
Since:	1.0
Required:	No
Display Name:	Font
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
serif	Serif	serif
sans-serif	Sans Serif	sans-serif
cursive	Cursive	cursive
fantasy	Fantasy	fantasy
monospace	Monospace	monospace

fontSize Property

Details

Type:	dimension
Since:	1.0
Required:	No
Display Name:	Font size
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
xx-small	XX Small	xx-small
x-small	X Small	x-small
small	Small	small
medium	Medium	medium
large	Large	large
x-large	X Large	x-large
xx-large	XX Large	xx-large
larger	Larger	larger
smaller	Smaller	smaller

fontStyle Property

Details

Type:	choice (fontStyle)
Since:	1.0
Required:	No
Display Name:	Font style
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
normal	Normal	normal
italic	Italic	italic
oblique	Oblique	oblique

fontVariant Property

Details

Type:	choice (fontVariant)
Since:	1.0
Required:	No
Display Name:	Font variant
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
normal	Normal	normal
small-caps	Small Caps	small-caps

fontWeight Property

Details

Type:	choice (fontWeight)
Since:	1.0
Required:	No
Display Name:	Font weight
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
normal	Normal	normal
bold	Bold	bold
bolder	Bolder	bolder
lighter	Lighter	lighter
100	100	100
200	200	200
300	300	300
400	400	400
500	500	500
600	600	600
700	700	700
800	800	800
900	900	900

isDesignTime Property

Details

Type:	boolean
Since:	2.2
Required:	No
Display Name:	Is Design Time
JavaScript Type:
Default Value:	true
Runtime Settable:	Yes

numberAlign Property

Details

Type:	choice (textAlign)
Since:	1.0
Required:	No
Display Name:	Number Alignment
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
left	Left	left
center	Center	center
right	Right	right
justify	Justify	justify

numberFormat Property

Details

Type:	NumberFormatValue Structure
Since:	1.0
Required:	No
Display Name:	Number Format
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

operator Property

The operator for a simple condition

Details

Type:	choice (mapOperator)
Since:	1.0
Required:	No
Display Name:	Operator
JavaScript Type:
Default Value:	eq
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
eq	Equal to	eq
ne	Not Equal to	ne
lt	Less than	lt
le	Less than or Equal	le
ge	Greater than or Equal	ge
gt	Greater than	gt
between	Between	between
not-between	Not Between	not-between
is-null	Is Null	is-null
is-not-null	Is Not Null	is-not-null
is-true	Is True	is-true
is-false	Is False	is-false
like	Like	like
match	Match	match
top-n	Top n	top-n
bottom-n	Bottom n	bottom-n
top-percent	Top percent	top-percent
bottom-percent	Bottom percent	bottom-percent
not-like	Not Like	not-like
not-match	Not Match	not-match
not-in	Not In	not-in
in	In	in

stringFormat Property

Details

Type:	StringFormatValue Structure
Since:	1.0
Required:	No
Display Name:	String Format
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

style Property

Details

Type:	Style Reference
Since:	1.0
Required:	No
Display Name:	Style
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

testExpr Property

An expression used to apply a particular format style

Details

Type:	expression
Context:
Expression Type:	any
Since:	1.0
Required:	No
Display Name:	TestExpression
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

textAlign Property

Details

Type:	choice (textAlign)
Since:	1.0
Required:	No
Display Name:	Text alignment
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
left	Left	left
center	Center	center
right	Right	right
justify	Justify	justify

textIndent Property

Details

Type:	dimension
Since:	1.0
Required:	No
Display Name:	Text indent
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

textLineThrough Property

Details

Type:	choice (textLineThrough)
Since:	1.0
Required:	No
Display Name:	Line-through
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
none	No Line Through Text	none
line-through	Line-through	line-through

textOverline Property

Details

Type:	choice (textOverline)
Since:	1.0
Required:	No
Display Name:	Overline
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
none	No Line Over Text	none
overline	Overline	overline

textTransform Property

Details

Type:	choice (transform)
Since:	1.0
Required:	No
Display Name:	Text transform
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
capitalize	Capitalize	capitalize
uppercase	Upper Case	uppercase
lowercase	Lower Case	lowercase
none	No Transformation	none

textUnderline Property

Details

Type:	choice (textUnderline)
Since:	1.0
Required:	No
Display Name:	Underline
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Choices

Name	Display Name	Value	Description
none	No Underline	none
underline	Underline	underline

value1 Property

The value for simple conditions with the operators: <, <=, =, <>, >=, >, between, not between, like

Details

Type:	list
Since:	1.0
Required:	No
Display Name:	Value 1
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

value2 Property

The value for simple conditions with the operators: between, not between

Details

Type:	expression
Context:
Expression Type:	any
Since:	1.0
Required:	No
Display Name:	Value 2
JavaScript Type:
Default Value:	None
Runtime Settable:	Yes

Structure Overview

Details

Property Summary

Description

Property Detail

Details

Choices

Details

Choices

Details

Choices

Details

Choices

Details

Choices

Details

Choices

Details

Choices

Details

Choices

Details

Choices

Details

Choices

Details

Choices

Details

Choices

Details

Choices

Details

Choices

Details

Choices

Details

Details

Choices

Details

Choices

Details

Choices

Details

Choices

Details

Choices

Details

Details

Choices

Details

Details

Choices

See Also

Details

Details

Details

See Also

Details

Choices

Details

Details

Choices

Details

Choices

Details

Choices

Details

Choices

Details

See Also

Details

See Also