Class: QgsLayoutItemLabel¶
- class qgis.core.QgsLayoutItemLabel¶
Bases:
QgsLayoutItem
A layout item subclass for text labels.
New in version 3.0.
QgsLayoutItemLabel(layout:
QgsLayout
) Constructor forQgsLayoutItemLabel
, with the specified parentlayout
.Methods
Adjusts the specified
point
at which areference
position of the item sits and returns the top left corner of the item, if reference point were placed at the specified position.Resizes the item so that the label's text fits to the item.
Applies any present data defined size overrides to the specified layout
size
.Applies any item-specific size constraint handling to a given
targetSize
in layout units.- rtype:
QRectF
Converts the label's
text()
to a static string, by evaluating any expressions included in the text and replacing them with their current values.Returns a new label item for the specified
layout
.Returns the text as it appears on the label (with evaluated expressions and other dynamic content).
- rtype:
str
- param context:
Draws the background for the item.
Draws a debugging rectangle of the item's current bounds within the specified painter.
Draws the frame around the item.
Returns the label's current font.
Returns the label font color.
Returns the path to use when drawing the item's frame or background.
Returns the horizontal alignment of the label.
- rtype:
QIcon
Returns the horizontal margin between the edge of the frame and the label contents, in layout units.
Returns the vertical margin between the edge of the frame and the label contents, in layout units.
Returns the label's current mode.
Returns the current position (in layout units) of a
reference
point for the item.Sets object properties from a DOM element
- param element:
Refresh item's background color, considering data defined colors.
Refresh item's blend mode, considering data defined blend mode.
Refresh item's frame, considering data defined colors and frame size.
Refreshes an item's position by rechecking it against any possible overrides such as data defined positioning.
Refreshes an item's rotation by rechecking it against any possible overrides such as data defined rotation.
Refreshes an item's size by rechecking it against any possible item fixed or minimum sizes.
Refresh item's opacity, considering data defined opacity.
Sets a fixed
size
for the layout item, which prevents it from being freely resized.Sets the label's current
font
.Sets the label font
color
.- param drawFrame:
- param strokeWidth:
Sets the horizontal
alignment
of the label.Sets the
margin
between the edge of the frame and the label contents.Sets the horizontal
margin
between the edge of the frame and the label contents, in layout units.Sets the vertical
margin
between the edge of the frame and the label contents, in layout units.Sets the minimum allowed
size
for the layout item.Sets the label's current
mode
, allowing the label to switch between font based and HTML based rendering.Sets the label's preset
text
.Sets for the vertical
alignment
of the label.Returns the required item size (in layout units) for the label's text to fill the item.
Returns the label's preset text.
Returns the position for the reference point of the item, if the top-left of the item was placed at the specified
point
.- rtype:
int
Returns for the vertical alignment of the label.
Stores object properties within an XML DOM element.
- param element:
Attributes
- class Mode¶
Bases:
int
- ModeFont = 0¶
- ModeHtml = 1¶
- adjustPointForReferencePosition(self, point: QPointF | QPoint, size: QSizeF, reference: QgsLayoutItem.ReferencePoint) QPointF ¶
Adjusts the specified
point
at which areference
position of the item sits and returns the top left corner of the item, if reference point were placed at the specified position.
- adjustSizeToText(self)¶
Resizes the item so that the label’s text fits to the item. Keeps the top left point stationary.
See also
- applyDataDefinedSize(self, size: QgsLayoutSize) QgsLayoutSize ¶
Applies any present data defined size overrides to the specified layout
size
.
- applyItemSizeConstraint(self, targetSize: QSizeF) QSizeF ¶
Applies any item-specific size constraint handling to a given
targetSize
in layout units. Subclasses can override this method if they need to apply advanced logic regarding item sizes, which cannot be covered bysetFixedSize()
orsetMinimumSize()
. Item size constraints are applied after fixed, minimum and data defined size constraints.See also
See also
- boundingRect(self) QRectF ¶
- Return type:
QRectF
- childEvent(self, QChildEvent)¶
- connectNotify(self, QMetaMethod)¶
- contextMenuEvent(self, QGraphicsSceneContextMenuEvent)¶
- convertToStaticText(self)¶
Converts the label’s
text()
to a static string, by evaluating any expressions included in the text and replacing them with their current values.New in version 3.20.
- create(layout: QgsLayout) QgsLayoutItemLabel ¶
Returns a new label item for the specified
layout
.The caller takes responsibility for deleting the returned object.
- Parameters:
layout (QgsLayout) –
- Return type:
- currentText(self) str ¶
Returns the text as it appears on the label (with evaluated expressions and other dynamic content).
See also
- Return type:
str
- customEvent(self, QEvent)¶
- disconnectNotify(self, QMetaMethod)¶
- displayName(self) str ¶
- Return type:
str
- dragEnterEvent(self, QGraphicsSceneDragDropEvent)¶
- dragLeaveEvent(self, QGraphicsSceneDragDropEvent)¶
- dragMoveEvent(self, QGraphicsSceneDragDropEvent)¶
- draw(self, context: QgsLayoutItemRenderContext)¶
- Parameters:
context (QgsLayoutItemRenderContext) –
- drawBackground(self, context: QgsRenderContext)¶
Draws the background for the item.
See also
- drawDebugRect(self, painter: QPainter)¶
Draws a debugging rectangle of the item’s current bounds within the specified painter.
- Parameters:
painter – destination QPainter
- drawFrame(self, context: QgsRenderContext)¶
Draws the frame around the item.
See also
- dropEvent(self, QGraphicsSceneDragDropEvent)¶
- focusInEvent(self, QFocusEvent)¶
- focusOutEvent(self, QFocusEvent)¶
- fontColor(self) QColor ¶
Returns the label font color.
See also
- Return type:
QColor
- framePath(self) QPainterPath ¶
Returns the path to use when drawing the item’s frame or background.
See also
See also
New in version 3.16.
- hAlign(self) Qt.AlignmentFlag ¶
Returns the horizontal alignment of the label.
See also
See also
- Return type:
Qt.AlignmentFlag
- hoverEnterEvent(self, QGraphicsSceneHoverEvent)¶
- hoverLeaveEvent(self, QGraphicsSceneHoverEvent)¶
- hoverMoveEvent(self, QGraphicsSceneHoverEvent)¶
- icon(self) QIcon ¶
- Return type:
QIcon
- inputMethodEvent(self, QInputMethodEvent)¶
- inputMethodQuery(self, Qt.InputMethodQuery) Any ¶
- isSignalConnected(self, QMetaMethod) bool ¶
- itemChange(self, QGraphicsItem.GraphicsItemChange, Any) Any ¶
- keyPressEvent(self, QKeyEvent)¶
- keyReleaseEvent(self, QKeyEvent)¶
- marginX(self) float ¶
Returns the horizontal margin between the edge of the frame and the label contents, in layout units.
See also
See also
- Return type:
float
- marginY(self) float ¶
Returns the vertical margin between the edge of the frame and the label contents, in layout units.
See also
See also
- Return type:
float
- mode(self) QgsLayoutItemLabel.Mode ¶
Returns the label’s current mode.
See also
- Return type:
- mouseDoubleClickEvent(self, QGraphicsSceneMouseEvent)¶
- mouseMoveEvent(self, QGraphicsSceneMouseEvent)¶
- mousePressEvent(self, QGraphicsSceneMouseEvent)¶
- mouseReleaseEvent(self, QGraphicsSceneMouseEvent)¶
- positionAtReferencePoint(self, reference: QgsLayoutItem.ReferencePoint) QPointF ¶
Returns the current position (in layout units) of a
reference
point for the item.
- prepareGeometryChange(self)¶
- readObjectPropertiesFromElement(self, parentElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) bool ¶
Sets object properties from a DOM element
- Parameters:
parentElement – is the parent DOM element for the object
document – DOM document
context – read write context
- Returns:
True
if read was successful
See also
- readPropertiesFromElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) bool ¶
- Parameters:
element (QDomElement) –
document (QDomDocument) –
context (QgsReadWriteContext) –
- Return type:
bool
- receivers(self, PYQT_SIGNAL) int ¶
- refresh(self)¶
- refreshBackgroundColor(self, updateItem: bool = True)¶
Refresh item’s background color, considering data defined colors. If
updateItem
is set toFalse
, the item will not be automatically updated after the frame color is set and a later call toupdate()
must be made.
- refreshBlendMode(self)¶
Refresh item’s blend mode, considering data defined blend mode.
- refreshFrame(self, updateItem: bool = True)¶
Refresh item’s frame, considering data defined colors and frame size. If
updateItem
is set toFalse
, the item will not be automatically updated after the frame is set and a later call toupdate()
must be made.
- refreshItemPosition(self)¶
Refreshes an item’s position by rechecking it against any possible overrides such as data defined positioning.
See also
- refreshItemRotation(self, origin: QPointF | QPoint = None)¶
Refreshes an item’s rotation by rechecking it against any possible overrides such as data defined rotation.
The optional
origin
point specifies the origin (in item coordinates) around which the rotation should be applied.See also
See also
- refreshItemSize(self)¶
Refreshes an item’s size by rechecking it against any possible item fixed or minimum sizes.
See also
See also
See also
- refreshOpacity(self, updateItem: bool = True)¶
Refresh item’s opacity, considering data defined opacity. If
updateItem
is set toFalse
the item will not be automatically updated after the opacity is set and a later call toupdate()
must be made.
- sceneEvent(self, QEvent) bool ¶
- sceneEventFilter(self, QGraphicsItem, QEvent) bool ¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setFixedSize(self, size: QgsLayoutSize)¶
Sets a fixed
size
for the layout item, which prevents it from being freely resized. Set an empty size if item can be freely resized.See also
fixedSize()
See also
- setFont(self, font: QFont)¶
Sets the label’s current
font
.See also
- Parameters:
font (QFont) –
- setFontColor(self, color: QColor | Qt.GlobalColor | QGradient)¶
Sets the label font
color
.See also
- Parameters:
color (Union[QColor) –
- setFrameEnabled(self, drawFrame: bool)¶
- Parameters:
drawFrame (bool) –
- setFrameStrokeWidth(self, strokeWidth: QgsLayoutMeasurement)¶
- Parameters:
strokeWidth (QgsLayoutMeasurement) –
- setHAlign(self, alignment: Qt.AlignmentFlag)¶
Sets the horizontal
alignment
of the label.See also
See also
- Parameters:
alignment (Qt.AlignmentFlag) –
- setMargin(self, margin: float)¶
Sets the
margin
between the edge of the frame and the label contents. This method sets both the horizontal and vertical margins to the same value. The margins can be individually controlled using thesetMarginX()
andsetMarginY()
methods.Margins are set using the current layout units.
See also
See also
- Parameters:
margin (float) –
- setMarginX(self, margin: float)¶
Sets the horizontal
margin
between the edge of the frame and the label contents, in layout units.See also
See also
- Parameters:
margin (float) –
- setMarginY(self, margin: float)¶
Sets the vertical
margin
between the edge of the frame and the label contents, in layout units.See also
See also
- Parameters:
margin (float) –
- setMinimumSize(self, size: QgsLayoutSize)¶
Sets the minimum allowed
size
for the layout item. Set an empty size if item can be freely resized.See also
minimumSize()
See also
- setMode(self, mode: QgsLayoutItemLabel.Mode)¶
Sets the label’s current
mode
, allowing the label to switch between font based and HTML based rendering.See also
- Parameters:
mode (QgsLayoutItemLabel.Mode) –
- setVAlign(self, alignment: Qt.AlignmentFlag)¶
Sets for the vertical
alignment
of the label.See also
See also
- Parameters:
alignment (Qt.AlignmentFlag) –
- sizeForText(self) QSizeF ¶
Returns the required item size (in layout units) for the label’s text to fill the item.
See also
- Return type:
QSizeF
- text(self) str ¶
Returns the label’s preset text.
See also
See also
- Return type:
str
- timerEvent(self, QTimerEvent)¶
- topLeftToReferencePoint(self, point: QgsLayoutPoint) QgsLayoutPoint ¶
Returns the position for the reference point of the item, if the top-left of the item was placed at the specified
point
.
- type(self) int ¶
- Return type:
int
- updateMicroFocus(self)¶
- vAlign(self) Qt.AlignmentFlag ¶
Returns for the vertical alignment of the label.
See also
See also
- Return type:
Qt.AlignmentFlag
- wheelEvent(self, QGraphicsSceneWheelEvent)¶
- writeObjectPropertiesToElement(self, parentElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) bool ¶
Stores object properties within an XML DOM element.
- Parameters:
parentElement – is the parent DOM element to store the object’s properties in
document – DOM document
context – read write context
- Returns:
True
if write was successful
See also
- writePropertiesToElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) bool ¶
- Parameters:
element (QDomElement) –
document (QDomDocument) –
context (QgsReadWriteContext) –
- Return type:
bool