Class: QgsLayoutSize

Provides a method of storing sizes, consisting of a width and height, for use in QGIS layouts.

Measurement units are stored alongside the size.

See also

QgsLayoutMeasurementConverter

Note

This class does not inherit from QSizeF since QSizeF includes methods which should not apply to sizes with units. For instance, the + and - operators would mislead users of this class to believe that addition of two QgsLayoutSize with different unit types would automatically convert units. Instead, all unit conversion must be handled by a QgsLayoutMeasurementConverter so that conversion between paper and screen units can be correctly performed.

Methods

encodeSize	Encodes the layout size to a string
height	Returns the height of the size.
isEmpty	Tests whether the size is empty, ie both its width and height are zero.
setHeight	Sets the height for the size.
setSize	Sets new width and height for the size.
setUnits	Sets the units for the size.
setWidth	Sets the width for the size.
toQSizeF	Converts the layout size to a QSizeF.
units	Returns the units for the size.
width	Returns the width of the size.

Static Methods

decodeSize

Decodes a size from a string.

class qgis.core.QgsLayoutSize

Bases: object

__init__(width: float, height: float, units: Qgis.LayoutUnit = Qgis.LayoutUnit.Millimeters)

Constructor for QgsLayoutSize.

Parameters:

• width (float) – width

• height (float) – height

• units (Qgis.LayoutUnit = Qgis.LayoutUnit.Millimeters) – units for width and height

__init__(size: QSizeF, units: Qgis.LayoutUnit = Qgis.LayoutUnit.Millimeters)

Constructor for QgsLayoutSize.

Parameters:

• size (QSizeF)

• units (Qgis.LayoutUnit = Qgis.LayoutUnit.Millimeters)

__init__(units: Qgis.LayoutUnit = Qgis.LayoutUnit.Millimeters)

Constructor for an empty layout size

Parameters:

units (Qgis.LayoutUnit = Qgis.LayoutUnit.Millimeters) – units for measurement

__init__(a0: QgsLayoutSize)

Parameters:

a0 (QgsLayoutSize)

static decodeSize(string: str | None) → QgsLayoutSize

Decodes a size from a string.

See also

encodeSize()

Parameters:

string (Optional[str])

Return type:

QgsLayoutSize

encodeSize(self) → str

Encodes the layout size to a string

See also

decodeSize()

Return type:

str

height(self) → float

Returns the height of the size.

See also

setHeight()

See also

width()

Return type:

float

isEmpty(self) → bool

Tests whether the size is empty, ie both its width and height are zero.

Return type:

bool

Returns:

True if size is empty

setHeight(self, height: float)

Sets the height for the size.

See also

height()

See also

setWidth()

Parameters:

height (float)

setSize(self, width: float, height: float)

Sets new width and height for the size.

See also

setWidth()

See also

setHeight()

See also

setUnits()

Parameters:

• width (float)

• height (float)

setUnits(self, units: Qgis.LayoutUnit)

Sets the units for the size. Does not alter the stored width or height, ie. no conversion is done.

See also

units()

Parameters:

units (Qgis.LayoutUnit)

setWidth(self, width: float)

Sets the width for the size.

See also

width()

See also

setHeight()

Parameters:

width (float)

toQSizeF(self) → QSizeF

Converts the layout size to a QSizeF. The unit information is discarded during this operation.

Return type:

QSizeF

Returns:

QSizeF with same dimensions as layout size

units(self) → Qgis.LayoutUnit

Returns the units for the size.

See also

setUnits()

Return type:

Qgis.LayoutUnit

width(self) → float

Returns the width of the size.

See also

setWidth()

See also

height()

Return type:

float