Hitachi Vantara Pentaho Community Wiki
Skip to end of metadata
Go to start of metadata

Returns the date from a specified field based on the current record.

Detailed Attributes ( version 0.8.7.x)

Attributes

Description

alignment

Sets the horizontal justification of the text based on a defined width.

Type: String
Default Value: left
Values: left | center | right

color

Sets the font color by using RGB-triplet (#ffffff for white; #ff0000 for red, etc) or from list of the predefined colors below.

Type: String
Default Value: black
Predefined Values: black | blue| cyan | darkGray | gray | green | lightGray | magenta | orange | pink | red | white | yellow

dynamic

A dynamic element increases the height of the element to fit the content of that element. Computing that dynamic height is expensive, so use it with care.

excel-format

When outputting to Excel, use another date/number format. The format is excel-specific and defined in the Excel-Help. If it is invalid, the resulting excel file might be unreadable. . If no format is specified here, the Java format string is used (as defined by the 'format' attribute).

Type: String

excel-wrap-text

When outputting to Excel, sets the text to word wrap.

Type: Boolean
Default Value: true

fieldname

The fieldname defines the name of the column of the tablemodel or the name of the function/expression/report property from where to read the data. The field must contain java.util.Date objects.

format

Defines the formatting of the date field based on the Date Formatting Table.

MMM dd, yyyy = Dec. 25, 2005
mm/dd/yy = 12/25/05
mm/dd/yy h:m = 12/25/05 8:00 am

font-embedded

Specifies the font to embed into the PDF file.

Type: Boolean
Default Value: false

font-encoding

Specifies the encoding to be used for the PDF.

Type: String

fontname

Sets the font name.

Type: String

fontsize

Sets the font size.

Type: Integer

fontstyle

Sets font style. This is a shortcut for defining fsbold and fsitalic.

Type: String
Values: plain | bold | italic | bolditalic

fsbold

Sets font to italics.

Type: Boolean
Default Value: false

fsitalic

Sets font to italics.

Type: Boolean
Default Value: false

fsstrikethr

Sets font to strikethrough.

Type: Boolean
Default Value: false

fsunderline

Sets font to underline.

Type: Boolean
Default Value: false

height

Determines the minimum height. Value is a whole number where each increment is equivalent to 1/72 of an inch or percentage.

Type: Integer
The height is requred. If the height is smaller than the font size, no content is printed.

href

Sets a hyperlink for the section.

Type: String

line-height

The height of a single text line in text elements. If the line-height is set and is greater than the font size, extra padding will be added between the lines making text more readable.

Type: Integer

name

Used to reference the element later. Functions pick up elements by their name.

Type: String

nullstring

If the value read from the given field is null or is no instance of 'java.util.Date', replace with a predefined value.

reserve-literal

Determines the text printed when the text does not fit completely into an element.

Type: String
Default value: "..."

styleClass

 

trim-text-content

Defines, whether leading and trailing whitespaces of the generated lines get removed. Important for a clean layout.

Type: Boolean
Default Value: true

vertical-alignment

Sets the vertical position of the text.

Default Value: top
Values: top | middle | bottom

visible

Sets whether the object will be printed.

Type: Boolean
Default Value: true

width

Set the horizontal width of the object. This attribute is required. If no width is given, nothing gets printed.

x

Defines the horizontal starting position an object defined by a value or percentage.

y

Defines the vertical starting position of an object defined by a value or percentage.

Additional Detailed Attributes ( version 0.8.9.x)

Attributes

Description

avoid-pagebreaks


background-color

Sets the background color by using RGB-triplet (#ffffff for white; #ff0000 for red, etc) or from list of the predefined colors below.

Type: String
Default Value: black
Predefined Values: black | blue| cyan | darkGray | gray | green | lightGray | magenta | orange | pink | red | white | yellow

border-width

Defines the width of the pen used to draw the border line.

Type: Integer
Default: 1

border-style

Sets the border line style when borders are enabled.

Type: String
Values: dashed | solid | dotted | dot-dash | dot-dot-dash

border-color

Sets the border color by using RGB-triplet (#ffffff for white; #ff0000 for red, etc) or from list of the predefined colors below.

Type: String
Default Value: black
Predefined Values: black | blue| cyan | darkGray | gray | green | lightGray | magenta | orange | pink | red | white | yellow

border-top-width

Defines the width of the pen used to draw the top border line.

Type: Integer
Default: 1

border-left-width

Defines the width of the pen used to draw the left border line.

Type: Integer
Default: 1

border-bottom-width

Defines the width of the pen used to draw the bottom border line.

Type: Integer
Default: 1

border-right-width

Defines the width of the pen used to draw the right border line.

Type: Integer
Default: 1

border-top-style

Sets the top border line style when borders are enabled.

Type: String
Values: dashed | solid | dotted | dot-dash | dot-dot-dash

border-left-style

Sets the left border line style when borders are enabled.

Type: String
Values: dashed | solid | dotted | dot-dash | dot-dot-dash

border-bottom-style

Sets the bottom border line style when borders are enabled.

Type: String
Values: dashed | solid | dotted | dot-dash | dot-dot-dash

border-right-style

Sets the right border line style when borders are enabled.

Type: String
Values: dashed | solid | dotted | dot-dash | dot-dot-dash

border-top-color

Sets the top border color by using RGB-triplet (#ffffff for white; #ff0000 for red, etc) or from list of the predefined colors below.

Type: String
Default Value: black
Predefined Values: black | blue| cyan | darkGray | gray | green | lightGray | magenta | orange | pink | red | white | yellow

border-left-color

Sets the left border color by using RGB-triplet (#ffffff for white; #ff0000 for red, etc) or from list of the predefined colors below.

Type: String
Default Value: black
Predefined Values: black | blue| cyan | darkGray | gray | green | lightGray | magenta | orange | pink | red | white | yellow

border-bottom-color

Sets the bottom border color by using RGB-triplet (#ffffff for white; #ff0000 for red, etc) or from list of the predefined colors below.

Type: String
Default Value: black
Predefined Values: black | blue| cyan | darkGray | gray | green | lightGray | magenta | orange | pink | red | white | yellow

border-right-color

Sets the right border color by using RGB-triplet (#ffffff for white; #ff0000 for red, etc) or from list of the predefined colors below.

Type: String
Default Value: black
Predefined Values: black | blue| cyan | darkGray | gray | green | lightGray | magenta | orange | pink | red | white | yellow

border-radius-x

Sets the horizontal radius for all four corner defining the shape of the corner, a quarter ellipse. 

Type: Integer
Default: 0

border-radius-y

Sets the vertical radius for all four corner defining the shape of the corner, a quarter ellipse. 

Type: Integer
Default: 0

border-top-left-radius-x

Sets the horizontal radius for the top left corner defining the shape of the corner, a quarter ellipse. 

Type: Integer
Default: 0

border-top-left-radius-y

Sets the vertical radius for the top left corner defining the shape of the corner, a quarter ellipse.

Type: Integer
Default: 0

border-top-right-radius-x

Sets the horizontal radius for the top right corner defining the shape of the corner, a quarter ellipse. 

Type: Integer
Default: 0

border-top-right-radius-y

Set the vertical radius for the top right corner defining the shape of the corner, a quarter ellipse.

Type: Integer
Default: 0

border-bottom-left-radius-x

Set the horizontal radius for the bottom left corner defining the shape of the corner, a quarter ellipse. 
 

Type: Integer
Default: 0

border-bottom-left-radius-y

Set the vertical radius for the bottom left corner defining the shape of the corner, a quarter ellipse.

Type: Integer
Default: 0

border-bottom-right-radius-x

Set the horizontal radius for the bottom left corner defining the shape of the corner, a quarter ellipse. 

Type: Integer
Default: 0

border-bottom-right-radius-y

Set the vertical radius for the bottom right corner defining the shape of the corner, a quarter ellipse.

Type: Integer
Default: 0

fontsmooth

 

formula

 

maximum-letter-spacing

 

minimum-letter-spacing

 

optimum-letter-spacing

 

orphans

 

overflow-x

 

overflow-y

 

padding

Sets the white space between all the margins and borders (top, left, bottom, right) and the content.

Type: Integer
Default: 0

padding-top

Sets the white space between the top margin and top border and the content.

Type: Integer
Default: 0

padding-left

Sets the white space between the left margin and left border and the content.

Type: Integer
Default: 0

padding-bottom

Sets the white space between the bottom margin and bottom border and the content.

Type: Integer
Default: 0

padding-right

Sets the white space between the right margin and right border and the content.

Type: Integer
Default: 0

style-expression

 

text-alignment

Sets the horizontal justification of the text based on a defined width.

Type: String
Default Value: left
Values: left | center | right

vertical-text-alignment

Sets the vertical text alignment. 

Type: String
Default Value: top
Values:  top | middle | bottom | baseline | central | sub | super | text-bottom | text-top | use-script

whitespace-collapse

 

widows

 

wrap

 

Date Formatting Table

Symbol

Meaning

Type

Example

G

Era

Text

"GG" -> "AD"

y

Year

Number

"yy" -> "03"
"yyyy" -> "2003"

M

Month

Text or Number

"M" -> "7"
"M" -> "12"
"MM" -> "07"
"MMM" -> "Jul"
"MMMM" -> "December"

d

Day in month

Number

"d" -> "3"
"dd" -> "03"

h

Hour (1-12, AM/PM)

Number

"h" -> "3"
"hh" -> "03"

H

Hour (0-23)

Number

"H" -> "15"
"HH" -> "15"

k

Hour (1-24)

Number

"k" -> "3"
"kk" -> "03"

K

Hour (0-11 AM/PM)

Number

"K" -> "15"
"KK" -> "15"

m

Minute

Number

"m" -> "7"
"m" -> "15"
"mm" -> "15"

s

Second

Number

"s" -> "15"
"ss" -> "15"

S

Millisecond (0-999)

Number

"SSS" -> "007"

E

Day in week

Text

"EEE" -> "Tue"
"EEEE" -> "Tuesday"

D

Day in year (1-365 or 1-364)

Number

"D" -> "65"
"DDD" -> "065"

F

Day of week in month (1-5)

Number

"F" -> "1"

w

Week in year (1-53)

Number

"w" -> "7"

W

Week in month (1-5)

Number

"W" -> "3"

a

AM/PM

Text

"a" -> "AM"
"aa" -> "AM"

z

Time zone

Text

"z" -> "EST"
"zzz" -> "EST"
"zzzz" -> "Eastern Standard Time"

X

Time zone offset

Text

"XXX" -> "-08:00"

'

Escape for text

Delimiter

"'hour' h" -> "hour 9"

''

Single quote

Literal

"ss''SSS" -> "45'876"

  • No labels