Subgroup: Layout
Class: QgsLayoutSize¶
-
class
qgis.core.
QgsLayoutSize
¶ Bases:
sip.wrapper
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.
See also
New in version 3.0.
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
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
andheight
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. Attributes
-
decodeSize
(string: str) → QgsLayoutSize¶ Decodes a size from a
string
.See also
-
encodeSize
(self) → str¶ Encodes the layout size to a string
See also
-
height
(self) → float¶ Returns the height of the size.
See also
See also
-
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
See also
-
setSize
(self, width: float, height: float)¶ Sets new
width
andheight
for the size.See also
See also
See also
-
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
-
setWidth
(self, width: float)¶ Sets the
width
for the size.See also
See also
-
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
-
width
(self) → float¶ Returns the width of the size.
See also
See also
-