TableFrame#

class TableFrame[source]#

Bases: SimpleFrame

Class for a table in a report. It is a simple frame with no sub-frames in it. The table has a list of columns and data rows.

__init__(parent: ContainerFrame, frame_id: str = '')[source]#

Creates a new TableFrame

Parameters:

parent – Parent frame to which this frame will be added
frame_id – frame id (optional)

property margin_bottom_subtotal: float#

Margin below a subtotal row

Getter:: Returns the margin
Setter:: Sets the margin

property repeat_header_row: bool#

Flag if the header row will be repeated after a page break

Getter:: Returns the flag
Setter:: Sets the flag

property suppress_header_row: bool#

Flag if the header row will not be repeated at all

Getter:: Returns the flag
Setter:: Sets the flag

property min_header_row_height: float#

Minimal height of the header row

Getter:: Returns the min header height
Setter:: Sets the min header height

property min_detail_row_height: float#

Minimal height of a row

Getter:: Returns the min height
Setter:: Sets the min height

property max_header_row_height: float#

Maximal height of the header row

Getter:: Returns the max header height
Setter:: Sets the max header height

property max_detail_row_height: float#

Maximal height of a row

Getter:: Returns the max height
Setter:: Sets the max height

property header_text_style: TextStyle#

Text style for the header row

Getter:: Returns the text style
Setter:: Sets the text style

property detail_row_text_style: TextStyle#

Text style for a row

Getter:: Returns the text style
Setter:: Sets the text style

property sub_total_row_text_style: TextStyle#

Text style for a sub-total row

Getter:: Returns the text style
Setter:: Sets the text style

property total_row_text_style: TextStyle#

Text style for a total row

Getter:: Returns the text style
Setter:: Sets the text style

property alternating_row_text_style: TextStyle#

Text style for the alternating rows

Getter:: Returns the text style
Setter:: Sets the text style

property border: Border#

Border of the table

Getter:: Returns the border
Setter:: Sets the border

property inner_pen_header_bottom: Pen#

Pen for a line below the header row

Getter:: Returns the pen
Setter:: Sets the pen

property inner_pen_total_top: Pen#

Pen for a line above the total row

Getter:: Returns the pen
Setter:: Sets the pen

property inner_pen_row: Pen#

Pen for a line between rows

Getter:: Returns the pen
Setter:: Sets the pen

property inter_row_space: float#

Space between rows in millimeters

Getter:: Returns the space
Setter:: Sets the space

property column_lines: bool#

Flag if there are vertical lines between the cells

Getter:: Returns the flag
Setter:: Sets the flag

property frame_id: str#

The frame id

Getter:: Returns the frame id
Setter:: Sets the frame id

property h_align: HAlign#

Horizontal alignment of the frame

Getter:: Returns the horizontal alignment of the frame
Setter:: Sets the horizontal alignment of the frame

property keep_together: bool#

Flag if the frame shall be kept together on one page

Getter:: Returns the flag
Setter:: Sets the flag

property margin_bottom: float#

Bottom margin in the frame

Getter:: Returns the bottom margin
Setter:: Sets the bottom margin

property margin_left: float#

Left margin in the frame

Getter:: Returns the left margin
Setter:: Sets the left margin

property margin_right: float#

Right margin in the frame

Getter:: Returns the right margin
Setter:: Sets the right margin

property margin_top: float#

Top margin in the frame

Getter:: Returns the top margin
Setter:: Sets the top margin

property max_height: float#

Maximal height for the frame

Getter:: Returns the maximal height
Setter:: Sets the maximal height

property max_width: float#

Maximal width for the frame

Getter:: Returns the maximal width
Setter:: Sets the maximal width

property parent_frame#

The parent frame

Getter:: Returns the parent frame
Setter:: Sets the parent frame

set_margin(margin: float)#

Sets the margin on all four sides to the given value

Parameters:: margin – Margin in mm

property use_full_height: bool#

Flag if the frame shall use the full possible height for the frame

Getter:: Returns the flag
Setter:: Sets the flag

property use_full_width: bool#

Flag if the frame shall use the full possible width for the frame

Getter:: Returns the flag
Setter:: Sets the flag

property v_align: VAlign#

Vertical alignment of the frame

Getter:: Returns the vertical alignment of the frame
Setter:: Sets the vertical alignment of the frame