Timesheet PDF

This document describes the style settings format for the PDF Export styling file.

Key	Description	Data type
`page`	Page settings Properties to set the basic page settings See Page settings	object
`page_logo`	Page logo Styling for logo image in the page header. See Page logo	object
`page_header`	Page headers See Page headers	object
`page_footer`	Page footers See Page footers	object
`page_heading`	Page heading The main page title heading See Page heading	object
`cover`	Cover page Styling for the cover page of the PDF report export See Cover page	object

Cover page

Styling for the cover page of the PDF report export

Key: cover

Example:

cover:
  header: {}
  footer: {}
  hero: {}

Key	Description	Data type
`header`	Cover page header Styling for the cover page header See Cover page header	object
`footer`	Cover page footer Styling for the cover page footer See Cover page footer	object
`hero`	Cover page hero Styling for the hero banner at the bottom at the cover page See Cover page hero	object

Styling for the cover page footer of the PDF report export

Key: cover_footer

Example:

footer:
  offset: 20
  size: 10
  color: 064e80

Key	Description	Data type
`offset`	Offset position from page bottom A number >= 0 and an optional unit Example: `30`	number or string See Units
…	See Font properties

Styling for the cover page header of the PDF report export

Key: cover_header

Example:

header:
  logo_height: 25
  border: {}

Key	Description	Data type
`spacing`	Minimum spacing between logo and page header text A number >= 0 and an optional unit Example: `20`	number or string See Units
`offset`	Offset position from page top A number >= 0 and an optional unit Example: `6.5`	number or string See Units
`logo_height`	Height of the logo in the page header A number >= 0 and an optional unit Example: `25`	number or string See Units
`border`	Cover page header Styling for the cover page header See Cover page header border	object
…	See Font properties

Styling for the cover page header border of the PDF report export

Key: cover_header_border

Example:

border:
  color: d3dee3
  height: 1
  offset: 6

Key	Description	Data type
`spacing`	Minimum spacing between logo and page header text A number >= 0 and an optional unit Example: `20`	number or string See Units
`offset`	Offset position from page top A number >= 0 and an optional unit Example: `6`	number or string See Units
`height`	Line height of the border A number >= 0 and an optional unit Example: `25`	number or string See Units
`color`	Line color of the border A color in RRGGBB format Example: `F0F0F0`	string
…	See Font properties

Cover page hero

Styling for the hero banner at the bottom at the cover page

Key: cover_hero

Example:

header:
  padding_right: 150
  padding_top: 120
  title: {}
  heading: {}
  subheading: {}

Key	Description	Data type
`padding_right`	Padding right Padding only on the right side of the hero banner Examples: `10mm`, `10`	number or string See Units
`padding_top`	Padding top Padding only on the top side of the hero banner Examples: `10mm`, `10`	number or string See Units
`title`	The first block in the hero See The first block in the hero	object
`heading`	The main block in the hero See The main block in the hero	object
`dates`	The dates block in the hero See The dates block in the hero	object
`subheading`	The last block in the hero See The last block in the hero	object

Font properties

Properties to set the font style

Key: font

Example:

font: OpenSans
size: 10
character_spacing: 0
styles: []
color: '000000'
leading: 2

Key	Description	Data type
`font`		string
`size`	A number >= 0 and an optional unit Examples: `10mm`, `10`	number or string See Units
`character_spacing`	A number >= 0 and an optional unit Examples: `10mm`, `10`	number or string See Units
`leading`	A number >= 0 and an optional unit Examples: `10mm`, `10`	number or string See Units
`color`	Color A color in RRGGBB format Example: `F0F0F0`	string
`styles`	Example: `[bold]` Valid values: `bold`, `italic`, `underline`, `strikethrough`, `superscript`, `subscript`	array of string

Margin properties

Properties to set margins

Key: margin

Example:

margin: 10mm
margin_top: 15mm

Key	Description	Data type
`margin`	Margin One value for margin on all sides Examples: `10mm`, `10`	number or string See Units
`margin_left`	Margin left Margin only on the left side Examples: `10mm`, `10`	number or string See Units
`margin_right`	Margin right Margin only on the right side Examples: `10mm`, `10`	number or string See Units
`margin_top`	Margin top Margin only on the top side Examples: `10mm`, `10`	number or string See Units
`margin_bottom`	Margin bottom Margin only on the bottom side Examples: `10mm`, `10`	number or string See Units

Page footers

Key: page_footer

Example:

page_footer:
  offset: -30
  size: 8

Key	Description	Data type
`offset`	Offset position from page bottom A positive or negative number and an optional unit Example: `-30`	number or string See Units
`spacing`	Minimum spacing between different page footers A number >= 0 and an optional unit Example: `8`	number or string See Units
…	See Font properties

Page headers

Key: page_header

Example:

page_header:
  align: left
  offset: 20
  size: 8

Key	Description	Data type
`align`	Alignment How the element should be aligned Example: `center` Valid values: `left`, `center`, `right`	string
`offset`	Offset position from page top A positive or negative number and an optional unit Example: `-30`	number or string See Units
…	See Font properties

Page heading

The main page title heading

Key: page_heading

Example:

page_heading:
  size: 14
  styles:
    - bold
  margin_bottom: 10

Key	Description	Data type
…	See Font properties
…	See Margin properties

Page logo

Styling for logo image in the page header.

Key: page_logo

Example:

page_logo:
  height: 20
  align: right

Key	Description	Data type
`height`	Height of the image A number >= 0 and an optional unit Examples: `10mm`, `10`	number or string See Units
`align`	Alignment How the element should be aligned Example: `center` Valid values: `left`, `center`, `right`	string
`offset`	Offset position from page top A positive or negative number and an optional unit Example: `-30`	number or string See Units

Page settings

Properties to set the basic page settings

Key: page

Example:

page:
  page_size: EXECUTIVE
  margin_top: 60
  margin_bottom: 60
  margin_left: 36
  margin_right: 36
  page_break_threshold: 200
  link_color: 175A8E

Key	Description	Data type
`link_color`	Link color Set the color of clickable links Example: `F0F0F0`	string
`page_layout`	Page layout The layout of a page Example: `portrait` Valid values: `portrait`, `landscape`	string
`page_size`	Page size The size of a page Example: `EXECUTIVE` Valid values: `EXECUTIVE`, `TABLOID`, `LETTER`, `LEGAL`, `FOLIO`, `A0`, `A1`, `A2`, `A3`, `A4`, `A5`, `A6`, `A7`, `A8`, `A9`, `A10`, `B0`, `B1`, `B2`, `B3`, `B4`, `B5`, `B6`, `B7`, `B8`, `B9`, `B10`, `C0`, `C1`, `C2`, `C3`, `C4`, `C5`, `C6`, `C7`, `C8`, `C9`, `C10`, `RA0`, `RA1`, `RA2`, `RA3`, `RA4`, `SRA0`, `SRA1`, `SRA2`, `SRA3`, `SRA4`, `4A0`, `2A0`	string
`page_break_threshold`	Page break threshold If there is a new section, start a new page if space less than the threshold is available Examples: `10mm`, `10`	number or string See Units
…	Default font settings See Font properties
…	Page margins See Margin properties

The dates block in the hero

Key: dates

Example:

heading:
  spacing: 10
  max_height: 20
  size: 32
  color: 414d5f
  styles:
    - bold

Key	Description	Data type
`max_height`	Maximum height of the block A number >= 0 and an optional unit Example: `30`	number or string See Units
`spacing`	Minimum spacing between dates and subheading A number >= 0 and an optional unit Example: `10`	number or string See Units
…	See Font properties

The first block in the hero

Key: title

Example:

title:
  max_height: 30
  spacing: 10
  font: SpaceMono
  size: 10
  color: 414d5f

Key	Description	Data type
`spacing`	Minimum spacing between title and heading A number >= 0 and an optional unit Example: `10`	number or string See Units
`max_height`	Maximum height of the block A number >= 0 and an optional unit Example: `30`	number or string See Units
…	See Font properties

The last block in the hero

Key: subheading

Example:

subheading:
  max_height: 30
  size: 10
  color: 414d5f
  styles:
    - italic

Key	Description	Data type
`max_height`	Maximum height of the block A number >= 0 and an optional unit Example: `30`	number or string See Units
…	See Font properties

The main block in the hero

Key: heading

Example:

heading:
  spacing: 10
  size: 32
  color: 414d5f
  styles:
    - bold

Key	Description	Data type
`spacing`	Minimum spacing between heading and subheading A number >= 0 and an optional unit Example: `10`	number or string See Units
…	See Font properties