Class: QgsLayoutSize

class qgis.core.QgsLayoutSize(width: float, height: float, units: QgsUnitTypes.LayoutUnit = QgsUnitTypes.LayoutMillimeters)

Bases: sip.wrapper

Constructor for QgsLayoutSize.

Parameters:
  • width – width
  • height – height
  • units – units for width and height

QgsLayoutSize(size: QSizeF, units: QgsUnitTypes.LayoutUnit = QgsUnitTypes.LayoutMillimeters) Constructor for QgsLayoutSize.

QgsLayoutSize(units: QgsUnitTypes.LayoutUnit = QgsUnitTypes.LayoutMillimeters) Constructor for an empty layout size

Parameters:units – units for measurement

QgsLayoutSize(QgsLayoutSize)

This class provides a method of storing sizes, consisting of a width and height, for use in QGIS layouts. Measurement units are stored alongside the size.

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.

New in version 3.0: Enums

Methods

decodeSize Decodes a size from a string.
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.

Signals

Attributes

decodeSize(string: str) → QgsLayoutSize

Decodes a size from a string.

See also

encodeSize()

encodeSize(self) → str

Encodes the layout size to a string

See also

decodeSize()

height(self) → float

Returns the height of the size.

See also

setHeight()

See also

width()

isEmpty(self) → bool

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

Returns:True if size is empty
setHeight(self, height: float)

Sets the height for the size.

See also

height()

See also

setWidth()

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

Sets new width and height for the size.

See also

setWidth()

See also

setHeight()

See also

setUnits()

setUnits(self, units: QgsUnitTypes.LayoutUnit)

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

See also

units()

setWidth(self, width: float)

Sets the width for the size.

See also

width()

See also

setHeight()

toQSizeF(self) → QSizeF

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

Returns:QSizeF with same dimensions as layout size
units(self) → QgsUnitTypes.LayoutUnit

Returns the units for the size.

See also

setUnits()

width(self) → float

Returns the width of the size.

See also

setWidth()

See also

height()