Class: QgsLayoutItemShape

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

Class Hierarchy

Base classes

QgsLayoutItem	Base class for graphical items within a QgsLayout.
QgsLayoutObject	A base class for objects which belong to a layout.
QObject
QgsExpressionContextGenerator	Abstract interface for generating an expression context.
QGraphicsRectItem
QAbstractGraphicsShapeItem
QGraphicsItem
QgsLayoutUndoObjectInterface	Interface for layout objects which support undo/redo commands.

class qgis.core.QgsLayoutItemShape

Bases: QgsLayoutItem

__init__(layout: QgsLayout | None)

Constructor for QgsLayoutItemShape, with the specified parent layout.

Parameters:

layout (Optional[QgsLayout])

Ellipse = 0

Rectangle = 1

class Shape

Bases: int

Triangle = 2

cornerRadius(self) → QgsLayoutMeasurement

Returns the corner radius for rounded rectangle corners.

See also

setCornerRadius()

Return type:

QgsLayoutMeasurement

static create(layout: QgsLayout | None) → QgsLayoutItemShape | None

Returns a new shape item for the specified layout.

The caller takes responsibility for deleting the returned object.

Parameters:

layout (Optional[QgsLayout])

Return type:

Optional[QgsLayoutItemShape]

setCornerRadius(self, radius: QgsLayoutMeasurement)

Sets the corner radius for rounded rectangle corners.

See also

cornerRadius()

Parameters:

radius (QgsLayoutMeasurement)

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

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 (Optional[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 | None

Returns the fill symbol used to draw the shape.

See also

setSymbol()

Return type:

Optional[QgsFillSymbol]