PositionFrame#

class PositionFrame[source]#

Bases: ContainerFrame

This class represents a frame that has a fix position on a page If the position and size of this frame is free on the current page it will be printed on the current page. If there is already some output on that spot, the frame will be printed on the next page. This can be overwritten by defining the overlay parameter to true.

__init__(parent: ContainerFrame, offset_left: float = 0.0, offset_top: float = 0.0, overlay: bool = False, frame_id: str = '')[source]#

Creates a new PositionFrame

Parameters:

parent – Parent frame to which this frame will be added
offset_left – Left position
offset_top – Top position
overlay – Flag if the frame may overlay other frames
frame_id – frame id (optional)

property offset_top: float#

Offset from the top of the paper

Getter:: Returns the top offset in mm
Setter:: Sets the top offset

property offset_left: float#

Offset from the left of the paper

Getter:: Returns the left offset in mm
Setter:: Sets the left offset

property overlay: bool#

Flag if the frame may overlay other frames

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

to_dict(data: dict, frame: dict)[source]#: Fills the attribute-values to a dictionary if the attribute has no default value. :param data: global dict for the whole report :param frame: dict for the frame

from_dict(frame: dict)[source]#: Fills the attributes based on the given dict :param frame: