Class: QgsLayoutItemShape

class qgis.core.QgsLayoutItemShape

Bases: QgsLayoutItem

Layout item for basic filled shapes (e.g. rectangles, ellipses).

New in version 3.0.

QgsLayoutItemShape(layout: QgsLayout) Constructor for QgsLayoutItemShape, with the specified parent layout.

Methods

accept

param visitor:

adjustPointForReferencePosition

Adjusts the specified point at which a reference position of the item sits and returns the top left corner of the item, if reference point were placed at the specified position.

applyDataDefinedSize

Applies any present data defined size overrides to the specified layout size.

applyItemSizeConstraint

Applies any item-specific size constraint handling to a given targetSize in layout units.

boundingRect

rtype:

QRectF

childEvent

clipPath

rtype:

QgsGeometry

connectNotify

contextMenuEvent

cornerRadius

Returns the corner radius for rounded rectangle corners.

create

Returns a new shape item for the specified layout.

customEvent

disconnectNotify

displayName

rtype:

str

dragEnterEvent

dragLeaveEvent

dragMoveEvent

draw

param context:

drawBackground

Draws the background for the item.

drawDebugRect

Draws a debugging rectangle of the item's current bounds within the specified painter.

drawFrame

Draws the frame around the item.

drawRefreshingOverlay

Draws a "refreshing" overlay icon on the item.

dropEvent

estimatedFrameBleed

rtype:

float

focusInEvent

focusOutEvent

framePath

Returns the path to use when drawing the item's frame or background.

hoverEnterEvent

hoverLeaveEvent

hoverMoveEvent

icon

rtype:

QIcon

inputMethodEvent

inputMethodQuery

isSignalConnected

itemChange

itemFlags

rtype:

QgsLayoutItem.Flags

keyPressEvent

keyReleaseEvent

mouseDoubleClickEvent

mouseMoveEvent

mousePressEvent

mouseReleaseEvent

positionAtReferencePoint

Returns the current position (in layout units) of a reference point for the item.

prepareGeometryChange

readObjectPropertiesFromElement

Sets object properties from a DOM element

readPropertiesFromElement

param element:

receivers

refreshBackgroundColor

Refresh item's background color, considering data defined colors.

refreshBlendMode

Refresh item's blend mode, considering data defined blend mode.

refreshFrame

Refresh item's frame, considering data defined colors and frame size.

refreshItemPosition

Refreshes an item's position by rechecking it against any possible overrides such as data defined positioning.

refreshItemRotation

Refreshes an item's rotation by rechecking it against any possible overrides such as data defined rotation.

refreshItemSize

Refreshes an item's size by rechecking it against any possible item fixed or minimum sizes.

refreshOpacity

Refresh item's opacity, considering data defined opacity.

sceneEvent

sceneEventFilter

sender

senderSignalIndex

setCornerRadius

Sets the corner radius for rounded rectangle corners.

setFixedSize

Sets a fixed size for the layout item, which prevents it from being freely resized.

setMinimumSize

Sets the minimum allowed size for the layout item.

setShapeType

Sets the type of shape (e.g. rectangle, ellipse, etc).

setSymbol

Sets the fill symbol used to draw the shape.

shapeType

Returns the type of shape (e.g. rectangle, ellipse, etc).

symbol

Returns the fill symbol used to draw the shape.

timerEvent

topLeftToReferencePoint

Returns the position for the reference point of the item, if the top-left of the item was placed at the specified point.

type

rtype:

int

updateMicroFocus

wheelEvent

writeObjectPropertiesToElement

Stores object properties within an XML DOM element.

writePropertiesToElement

param element:

Attributes

Ellipse

Rectangle

Triangle

Ellipse = 0
Rectangle = 1
class Shape

Bases: int

Triangle = 2
accept(self, visitor: QgsStyleEntityVisitorInterface) → bool
Parameters:

visitor (QgsStyleEntityVisitorInterface) –

Return type:

bool

adjustPointForReferencePosition(self, point: QPointF | QPoint, size: QSizeF, reference: QgsLayoutItem.ReferencePoint) → QPointF

Adjusts the specified point at which a reference position of the item sits and returns the top left corner of the item, if reference point were placed at the specified position.

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 by setFixedSize() or setMinimumSize(). Item size constraints are applied after fixed, minimum and data defined size constraints.

See also

setFixedSize()

See also

setMinimumSize()

boundingRect(self) → QRectF
Return type:

QRectF

childEvent(self, QChildEvent)
clipPath(self) → QgsGeometry
Return type:

QgsGeometry

connectNotify(self, QMetaMethod)
contextMenuEvent(self, QGraphicsSceneContextMenuEvent)
cornerRadius(self) → QgsLayoutMeasurement

Returns the corner radius for rounded rectangle corners.

See also

setCornerRadius()

Return type:

QgsLayoutMeasurement

create(layout: QgsLayout) → QgsLayoutItemShape

Returns a new shape item for the specified layout.

The caller takes responsibility for deleting the returned object.

Parameters:

layout (QgsLayout) –

Return type:

QgsLayoutItemShape

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

framePath()

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

framePath()

drawRefreshingOverlay(self, painter: QPainter, itemStyle: QStyleOptionGraphicsItem)

Draws a “refreshing” overlay icon on the item.

New in version 3.32.

dropEvent(self, QGraphicsSceneDragDropEvent)
estimatedFrameBleed(self) → float
Return type:

float

focusInEvent(self, QFocusEvent)
focusOutEvent(self, QFocusEvent)
framePath(self) → QPainterPath

Returns the path to use when drawing the item’s frame or background.

See also

drawFrame()

See also

drawBackground()

New in version 3.16.

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
itemFlags(self) → QgsLayoutItem.Flags
Return type:

QgsLayoutItem.Flags

keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
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

writeObjectPropertiesToElement()

readPropertiesFromElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool
Parameters:
Return type:

bool

receivers(self, PYQT_SIGNAL) → int
refreshBackgroundColor(self, updateItem: bool = True)

Refresh item’s background color, considering data defined colors. If updateItem is set to False, the item will not be automatically updated after the frame color is set and a later call to update() 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 to False, the item will not be automatically updated after the frame is set and a later call to update() must be made.

refreshItemPosition(self)

Refreshes an item’s position by rechecking it against any possible overrides such as data defined positioning.

See also

refreshItemSize()

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

refreshItemSize()

See also

refreshItemPosition()

refreshItemSize(self)

Refreshes an item’s size by rechecking it against any possible item fixed or minimum sizes.

See also

setFixedSize()

See also

setMinimumSize()

See also

refreshItemPosition()

refreshOpacity(self, updateItem: bool = True)

Refresh item’s opacity, considering data defined opacity. If updateItem is set to False the item will not be automatically updated after the opacity is set and a later call to update() must be made.

sceneEvent(self, QEvent) → bool
sceneEventFilter(self, QGraphicsItem, QEvent) → bool
sender(self) → QObject
senderSignalIndex(self) → int
setCornerRadius(self, radius: QgsLayoutMeasurement)

Sets the corner radius for rounded rectangle corners.

See also

cornerRadius()

Parameters:

radius (QgsLayoutMeasurement) –

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

setMinimumSize()

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

setFixedSize()

setShapeType(self, type: QgsLayoutItemShape.Shape)

Sets the type of shape (e.g. rectangle, ellipse, etc).

See also

shapeType()

Parameters:

type (QgsLayoutItemShape.Shape) –

setSymbol(self, symbol: QgsFillSymbol)

Sets the fill symbol used to draw the shape. Ownership is not transferred and a clone of the symbol is made.

See also

symbol()

Parameters:

symbol (QgsFillSymbol) –

shapeType(self) → QgsLayoutItemShape.Shape

Returns the type of shape (e.g. rectangle, ellipse, etc).

See also

setShapeType()

Return type:

QgsLayoutItemShape.Shape

symbol(self) → QgsFillSymbol

Returns the fill symbol used to draw the shape.

See also

setSymbol()

Return type:

QgsFillSymbol

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)
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

readObjectPropertiesFromElement()

writePropertiesToElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool
Parameters:
Return type:

bool