LineFrame#

class LineFrame[source]#

Bases: SimpleFrame

Class for a frame the prints a line. It is a simple frame with no sub-frames in it. A line will be printed with a given width or height.

__init__(parent: ContainerFrame, direction: Direction = Direction.HORIZONTAL, extent: float = 0.0, color: str = '#000000', length: float = 0.0, h_align: HAlign = HAlign.LEFT, v_align: VAlign = VAlign.TOP, frame_id: str = '')[source]#

Parameters:

parent – Parent frame to which this frame will be added
direction – Direction of the line vertical or horizontal
extent – Extent of the pen - default 0.1mm
color – Color of the line - default black
length – Length of the line
h_align – Horizontal alignment of the line
v_align – Vertical alignment of the line
frame_id – frame id (optional)

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 v_align: VAlign#

Vertical alignment of the frame

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

property pen: Pen#

Pen for the line

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

property length: float#

Length of the line

Getter:: Returns the length
Setter:: Sets the length

property direction: Direction#

Direction of the line

Getter:: Returns the direction
Setter:: Sets the direction

property frame_id: str#

The frame id

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

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