Styling
Version 0.3 is under development. Do not use in a production.
Documentation is under development.
pdfmake makes it possible to style any paragraph or its part:
var docDefinition = {
content: [
// if you don't need styles, you can use a simple string to define a paragraph
'This is a standard paragraph, using default style',
// using a { text: '...' } object lets you set styling properties
{ text: 'This paragraph will have a bigger font', fontSize: 15 },
// if you set the value of text to an array instead of a string, you'll be able
// to style any part individually
{
text: [
'This paragraph is defined as an array of elements to make it possible to ',
{ text: 'restyle part of it and make it bigger ', fontSize: 15 },
'than the rest.'
]
}
]
};
Style dictionaries
It’s also possible to define a dictionary of reusable styles:
var docDefinition = {
content: [
{ text: 'This is a header', style: 'header' },
'No styling here, this is a standard paragraph',
{ text: 'Another text', style: 'anotherStyle' },
{ text: 'Multiple styles applied', style: [ 'header', 'anotherStyle' ] }
],
styles: {
header: {
fontSize: 22,
bold: true
},
anotherStyle: {
italics: true,
alignment: 'right'
}
}
};
To have a deeper understanding of styling in pdfmake, style inheritance and local-style-overrides check STYLES1, STYLES2 and STYLES3 examples in playground.
Default style
And it is also possible to define a default style:
var docDefinition = {
content: [
'Text styled by default style'
],
defaultStyle: {
fontSize: 15,
bold: true
}
};
Style properties
font: string
: name of the fontfontSize: number
: size of the font in ptfontFeatures: string[]
: array of advanced typographic features supported in TTF fonts (supported features depend on font file)lineHeight: number
: the line height (default: 1)bold: boolean
: whether to use bold text (default: false)italics: boolean
: whether to use italic text (default: false)alignment: string
: (‘left’ or ‘center’ or ‘right’ or ‘justify’) the alignment of the textcharacterSpacing: number
: size of the letter spacing in ptcolor: string
: the color of the text (color name e.g., ‘blue’ or hexadecimal color e.g., ‘#ff5500’)background: string
the background color of the textmarkerColor: string
: the color of the bullets in a buletted listdecoration: string | string[]
: the text decoration to apply (‘underline’ or ‘lineThrough’ or ‘overline’)decorationStyle: string
: the style of the text decoration (‘dashed’ or ‘dotted’ or ‘double’ or ‘wavy’)decorationColor: string
: the color of the text decoration, see color