Report#

class Report[source]#

This is the main class for reports in the PDFReport It creates some basic frames and prints them to a PDF document

__init__(page_format: PageFormat = None, font_family: str = 'Helvetica', font_size: float = 9.0, text_color: str = '#000000')[source]#

Creates a new Report object. If no page format is passed a default page format will be used

Parameters:

page_format – PageFormat to be used for the report or None

property page_format: PageFormat#

The page format to be used in the report

Getter:

Returns the page format

Setter:

Sets the page format

property header: SerialFrame#

The header frame

Getter:

Returns the header frame (vertical serial frame)

property footer: SerialFrame#

The footer frame

Getter:

Returns the footer frame (vertical serial frame)

property body: SerialFrame#

The body frame

Getter:

Returns the body frame (vertical serial frame)

property count_pages: bool#

Flag if the pages should be counted before the printing That is used if the variable for the number of pages is used

Getter:

Returns True if the pages will be counted

Setter:

Sets the count pages flag

output(rep_file_name: str, show: bool = False, report_data: ReportData = None)[source]#

Creates the pdf file from the report structure

Parameters:

  • rep_file_name – The full filename for the report without extension

  • show – If True the created pdf will be shown (if possible)

  • report_data – Data provider to handle callbacks to get dynamic data

save(rep_file_name: str, show: bool = False)[source]#

Save the report in a json file.

Parameters:

  • rep_file_name – The full filename for the report without extension

  • show – If True the created json file will be shown (if possible)

load(rep_file_name: str)[source]#

Loads a report from a json file.

Parameters:

rep_file_name – The full filename for the report without extension