Skip to main content
Pentaho Documentation

Style properties reference

Parent aricle

You can click on any element, and the Style pane will adjust to show all of the available style properties, listed by group.

NoteYou cannot edit any Style or Attributes options for any selected report elements in the workspace while the Data tab has focus. Click the Structure tab to see the Style and Attributes panes for selected elements.

Every report element can be customized according to the following parameters:

Font styles

Font styles control the font and font properties pertaining to the text of the selected element.

Property NameData TypePurpose
familySelectionThe name of the font or font family
font-sizeIntegerThe size of the font, in points (1/72 of an inch)
boldBooleanA flag indicating whether a bold-type face should be used
italicsBooleanA flag indicating whether an italic or oblique type face should be used
underlineBooleanA flag indicating whether the text should be underlined
strikethroughBooleanA flag indicating whether the text should be rendered strikethrough
smoothSelectionA flag indicating whether text-aliasing should be activated
embedBooleanA flag indicating whether the font information should be embedded into the target document

Text styles

Text styles control the font and font properties pertaining to the text of the selected element.

NoteFor elements that control colors, possible values are standard HTML color names (red, blue, green, black, etc.) or hexadecimal color values (#000000, #FFFFFF, #CCFF00, etc.)
Property NameData TypePurpose
h-alignSelectionHorizontally aligns the selected content within this element
v-alignSelectionVertically aligns the selected content within this element
v-align-in-bandSelectionAn extended text-alignment that allows fine control on how inline-text is aligned within a line
text-wrapBooleanA flag indicating whether text will automatically wrap at the end of the line
text-colorSelectionThe text (foreground) color.
bg-colorSelectionThe element's background color.
line-heightIntegerDefines the height of a single text line. Is always greater or equal to the font size
overflow-textStringA text quote that is printed if the given text does not fully fit into the element bound
trimBooleanA flag indicating whether leading and trailing white spaces will be removed
trim-whitespaceSelectionControls how the renderer treats white spaces
bg-extStringAn extended foreground paint property. Expert option
encodingBooleanSpecifies the target text-encoding for the given field, in case the output supports per-field encodings

Text Spacing styles

Text spacing styles control the amount of space between letters and words in a textual element.

Property NameData TypePurpose
characterIntegerThe minimum space between two letters
wordIntegerDefines additional spacing between words
preferred-characterIntegerThe preferred space between two letters
max-characterIntegerThe maximum space between two letters

Padding styles

Padding styles control the space around the selected element.

Property NameData TypePurpose
topDecimalDefines the padding on the top edge of the element
bottomDecimalDefines the padding on the bottom edge of the element
leftDecimalDefines the padding on the left edge of the element
rightDecimalDefines the padding on the right edge of the element

Object styles

Object styles control the appearance of shape elements.

Property NameData TypePurpose
fillBooleanA flag indicating whether the given shape should be filled.
fill-colorSelectionDefines alternative fill-colors. If undefined, the foreground color is used.
draw-outlineBooleanDefines whether the shape-outline should be drawn in the foreground color.
strokeSelectionDefines the stroke (pen type and width) that should be used to render a shape.
anti-aliasBooleanDefines whether drawable content should be rendered with anti-aliasing enabled.
aspect-ratioBooleanA flag indicating whether the scaling should preserve the aspect ratio.
scaleBooleanA flag indicating whether the content printed in the element should be scaled to fit the element's boundaries.

Size and Position styles

Size and Position styles control the size and position of the selected element.

Property NameData TypePurpose
heightDecimalThe element's preferred height. If defined, this overrides all other height definitions including the dynamic-height flag
widthDecimalThe preferred width. If defined, this width overrides all other layout rules
xDecimalThe X-Coordinate where the element should be placed
yDecimalThe Y-Coordinate where the element should be placed
visibleBooleanA flag indicating whether the element will be printed
invisible-consumes-spaceBooleanA flag indicating whether an element set to visible maintains its space
dynamic-heightBooleanA flag indicating whether the field should expand its height based on the content it contains
min-heightDecimalThe element's minimum height
max-heightDecimalThe element's maximum height
min-widthDecimalThe element's minimum width
max-widthDecimalThe element's maximum width
x-overflowBooleanDefines whether content can overflow the element's layout box to the right
y-overflowBooleanDefines whether content can overflow the element's layout box to the bottom
fixed-positionString(Group elements only) Shifts the band to a fixed position on the page
layoutString(Band elements only) The layout strategy for elements in bands. See Report Layout Types for more information on layout options.
box-sizingSelectionSpecifies the border-model to use

Links styles

Links styles control the properties of any HTML links created from any report element.

Property NameData TypePurpose
pdf-bookmarkString(Band elements only) Adds bookmark to PDF outputs
html-anchorStringThe name of an anchor (link-target) embedded in the HTML outputs
urlStringThe destination URL
url-tool-tipStringHyperlink title that is displayed as tooltip
url-window-titleStringThe window where the link should be opened

Excel styles

Excel styles control XLS output options.

Property NameData TypePurpose
sheet-nameStringThe title of the sheet/table generated in table exports
format-overrideStringOverride setting that provides Excel-specific cell formats
formula-overrideStringOverride setting that provides a formula to print in the generated Excel-cell instead of the original content
wrap-textBooleanOverride setting that defines whether Excel cells should have text-wrapping enabled

Sparkline styles

Sparkline styles control the colors of the various sparkline chart types.

Property NameData TypePurpose
low-colorSelectionDefines the color of the lower value on a pie sparkline
medium-colorSelectionDefines the color for midrange values on a pie sparkline
high-colorSelectionDefines the color of the higher value on pie and bar sparklines
last-colorSelectionDefines the color of the last value in a series on a bar sparkline, and the line color on a line sparkline

Page Behavior styles

Page Behavior styles control page display and rendering properties of the selected element when publishing to a page-aware file format.

Property NameData TypePurpose
display-on-first-pageBoolean(Band elements only) If true, only displays this band on the first page
display-on-last-pageBoolean(Band elements only) If true, only displays this band on the last page
repeat-headerBoolean(Header and footer elements only) If true, repeats this header or footer on every printed page
page-break-afterBooleanIf true, a page break will occur after this element
page-break-beforeBooleanIf true, a page break will occur before this element
stickyBooleanIf true, imports page-header/footer and the repeated group-header/footer from the master report into sub-reports
avoid-page-breakBooleanIf true, cancels a predefined (through a formula or function) page break
orphanIntegerDefines the minimum number of elements or lines at end of the page before a page break can occur within the band or paragraph
widowsIntegerDefines the minimum number of elements or lines at the beginning of the page before a page break can occur within the band or paragraph

Border styles

Border styles control the color, texture, and size of the border around the selected element.

NoteFor elements that control colors, possible values are standard HTML color names (red, blue, green, black, etc.) or hexadecimal color values (#000000, #FFFFFF, #CCFF00, etc.)
Property NameData TypePurpose
top-sizeIntegerSpecifies the size (in pixels) of the top border segment
top-styleSelectionSpecifies the line style of the top border segment
top-colorSelectionSpecifies the color of the top border segment
top-left-round-heightIntegerSpecifies the degree of vertical roundness (in pixels) of the top left border corner
top-left-round-widthIntegerSpecifies the degree of horizontal roundness (in pixels) of the top left border corner
top-right-round-heightIntegerSpecifies the degree of vertical roundness (in pixels) of the top right border corner
top-right-round-widthIntegerSpecifies the degree of horizontal roundness (in pixels) of the top right border corner
bottom-sizeIntegerSpecifies the size (in pixels) of the bottom border segment
bottom-styleSelectionSpecifies the line style of the bottom border segment
bottom-colorSelectionSpecifies the color of the bottom border segment
bottom-left-round-heightIntegerSpecifies the degree of vertical roundness (in pixels) of the bottom left border segment
bottom-left-round-widthIntegerSpecifies the degree of horizontal roundness (in pixels) of the bottom left border segment
bottom-right-round-heightIntegerSpecifies the degree of vertical roundness (in pixels) of the bottom right border segment
bottom-right-round-widthIntegerSpecifies the degree of horizontal roundness (in pixels) of the bottom right border segment
left-colorSelectionSpecifies the color of the left border segment
left-sizeIntegerSpecifies the size (in pixels) of the left border segment
left-styleSelectionSpecifies the line style of the left border segment
right-colorSelectionSpecifies the color of the right border segment
right-sizeIntegerSpecifies the size (in pixels) of the right border segment
right-styleSelectionSpecifies the line style of the right border segment
break-colorSelectionSpecifies the color of the border segment that closes an element that is cut short by a page break
break-styleSelectionSpecifies the color of the border segment that closes an element that is cut short by a page break
break-sizeIntegerSpecifies the color of the border segment that closes an element that is cut short by a page break