Subgroup: Layout

Class: QgsLayoutItemShape¶

class qgis.core.QgsLayoutItemShape¶

Bases: qgis._core.QgsLayoutItem

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

New in version 3.0: Methods

`acceptDrops`
`acceptHoverEvents`
`acceptTouchEvents`
`acceptedMouseButtons`
`adjustPointForReferencePosition`
`advance`
`applyDataDefinedSize`
`applyItemSizeConstraint`
`attemptMove`	Attempts to move the item to a specified `point`.
`attemptMoveBy`	Attempts to shift the item’s position by a specified `deltaX` and `deltaY`, in layout units.
`attemptResize`	Attempts to resize the item to a specified target `size`.
`attemptSetSceneRect`	Attempts to update the item’s position and size to match the passed `rect` in layout coordinates.
`backgroundColor`	Returns the background color for this item.
`beginCommand`	Starts new undo command for this item.
`blendMode`	Returns the item’s composition blending mode.
`blockSignals`
`boundingRect`
`boundingRegion`
`boundingRegionGranularity`
`brush`
`cacheMode`
`cancelCommand`	Cancels the current item command and discards it.
`childEvent`
`childItems`
`children`
`childrenBoundingRect`
`cleanup`	Called just before a batch of items are deleted, allowing them to run cleanup tasks.
`clearFocus`
`clipPath`
`collidesWithItem`
`collidesWithPath`
`collidingItems`
`commonAncestorItem`
`connectNotify`
`contains`
`containsAdvancedEffects`	Returns true if the item contains contents with blend modes or transparency effects which can only be reproduced by rastering the item.
`contextMenuEvent`
`cornerRadius`	Returns the corner radius for rounded rectangle corners.
`create`	Returns a new shape item for the specified `layout`.
`createCommand`
`createExpressionContext`
`cursor`
`customEvent`
`customProperties`	Return list of keys stored in custom properties for the object.
`customProperty`	Read a custom property from the object.
`data`
`dataDefinedProperties`	Returns a reference to the object’s property collection, used for data defined overrides.
`deleteLater`
`deviceTransform`
`disconnect`
`disconnectNotify`
`displayName`
`dragEnterEvent`
`dragLeaveEvent`
`dragMoveEvent`
`draw`
`drawBackground`
`drawDebugRect`
`drawFrame`
`dropEvent`
`dumpObjectInfo`
`dumpObjectTree`
`dynamicPropertyNames`
`effectiveOpacity`
`endCommand`	Completes the current item command and push it onto the layout’s undo stack.
`ensureVisible`	ensureVisible(self, float, float, float, float, xMargin: int = 50, yMargin: int = 50)
`estimatedFrameBleed`
`event`
`eventFilter`
`excludeFromExports`	Returns whether the item should be excluded from layout exports and prints.
`filtersChildEvents`
`finalizeRestoreFromXml`	Called after all pending items have been restored from XML.
`findChild`	findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject
`findChildren`	findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]
`fixedSize`	Returns the fixed size of the item, if applicable, or an empty size if item can be freely resized.
`flags`
`focusInEvent`
`focusItem`
`focusOutEvent`
`focusProxy`
`frameEnabled`	Returns true if the item includes a frame.
`frameJoinStyle`	Returns the join style used for drawing the item’s frame.
`frameStrokeColor`	Returns the frame’s stroke color.
`frameStrokeWidth`	Returns the frame’s stroke width.
`grabKeyboard`
`grabMouse`
`graphicsEffect`
`group`
`hasBackground`	Returns true if the item has a background.
`hasCursor`
`hasFocus`
`hide`
`hoverEnterEvent`
`hoverLeaveEvent`
`hoverMoveEvent`
`icon`
`id`	Returns the item’s ID name.
`inherits`
`inputMethodEvent`
`inputMethodHints`
`inputMethodQuery`
`installEventFilter`
`installSceneEventFilter`
`invalidateCache`	Forces a deferred update of any cached image the item uses.
`isActive`
`isAncestorOf`
`isBlockedByModalPanel`
`isClipped`
`isEnabled`
`isGroupMember`	Returns true if the item is part of a QgsLayoutItemGroup group.
`isLocked`	Returns true if the item is locked, and cannot be interacted with using the mouse.
`isObscured`	isObscured(self, float, float, float, float) -> bool
`isObscuredBy`
`isPanel`
`isSelected`
`isSignalConnected`
`isUnderMouse`
`isVisible`
`isVisibleTo`
`isWidget`
`isWidgetType`
`isWindow`
`isWindowType`
`itemChange`
`itemOpacity`	Returns the item’s opacity.
`itemRotation`	Returns the current rotation for the item, in degrees clockwise.
`itemTransform`
`keyPressEvent`
`keyReleaseEvent`
`killTimer`
`layout`	Returns the layout the object is attached to.
`mapFromItem`	mapFromItem(self, QGraphicsItem, QRectF) -> QPolygonF
`mapFromParent`	mapFromParent(self, QRectF) -> QPolygonF
`mapFromScene`	mapFromScene(self, QRectF) -> QPolygonF
`mapRectFromItem`	mapRectFromItem(self, QGraphicsItem, float, float, float, float) -> QRectF
`mapRectFromParent`	mapRectFromParent(self, float, float, float, float) -> QRectF
`mapRectFromScene`	mapRectFromScene(self, float, float, float, float) -> QRectF
`mapRectToItem`	mapRectToItem(self, QGraphicsItem, float, float, float, float) -> QRectF
`mapRectToParent`	mapRectToParent(self, float, float, float, float) -> QRectF
`mapRectToScene`	mapRectToScene(self, float, float, float, float) -> QRectF
`mapToItem`	mapToItem(self, QGraphicsItem, QRectF) -> QPolygonF
`mapToParent`	mapToParent(self, QRectF) -> QPolygonF
`mapToScene`	mapToScene(self, QRectF) -> QPolygonF
`metaObject`
`minimumSize`	Returns the minimum allowed size of the item, if applicable, or an empty size if item can be freely resized.
`mouseDoubleClickEvent`
`mouseMoveEvent`
`mousePressEvent`
`mouseReleaseEvent`
`moveBy`
`moveContent`	Moves the content of the item, by a specified `dx` and `dy` in layout units.
`moveToThread`
`numberExportLayers`	Returns the number of layers that this item requires for exporting during layered exports (e.g.
`objectName`
`opacity`
`opaqueArea`
`page`	Returns the page the item is currently on, with the first page returning 0.
`pagePos`	Returns the item’s position (in layout units) relative to the top left corner of its current page.
`pagePositionWithUnits`	Returns the item’s position (in item units) relative to the top left corner of its current page.
`paint`	Handles preparing a paint surface for the layout item and painting the item’s content.
`panel`
`panelModality`
`parent`
`parentGroup`	Returns the item’s parent group, if the item is part of a QgsLayoutItemGroup group.
`parentItem`
`parentObject`
`parentWidget`
`pen`
`pos`
`positionAtReferencePoint`
`positionWithUnits`	Returns the item’s current position, including units.
`prepareGeometryChange`
`property`
`propertyDefinitions`	Returns the layout object property definitions.
`pyqtConfigure`	Each keyword argument is either the name of a Qt property or a Qt signal.
`readObjectPropertiesFromElement`
`readPropertiesFromElement`
`readXml`	Sets the item state from a DOM element.
`receivers`
`rect`
`rectWithFrame`	Returns the item’s rectangular bounds, including any bleed caused by the item’s frame.
`redraw`	Triggers a redraw (update) of the item.
`referencePoint`	Returns the reference point for positioning of the layout item.
`refresh`	Refreshes the item, causing a recalculation of any property overrides and recalculation of its position and size.
`refreshBackgroundColor`
`refreshBlendMode`
`refreshDataDefinedProperty`	Refreshes a data defined `property` for the item by reevaluating the property’s value and redrawing the item with this new value.
`refreshFrame`
`refreshItemPosition`
`refreshItemRotation`
`refreshItemSize`
`refreshOpacity`
`removeCustomProperty`	Remove a custom property from the object.
`removeEventFilter`
`removeSceneEventFilter`
`requiresRasterization`	Returns true if the item is drawn in such a way that forces the whole layout to be rasterized when exporting to vector formats.
`resetTransform`
`rotateItem`	Rotates the item by a specified `angle` in degrees clockwise around a specified reference point.
`rotation`
`scale`
`scene`
`sceneBoundingRect`
`sceneEvent`
`sceneEventFilter`
`scenePos`
`sceneTransform`
`scroll`
`sender`
`senderSignalIndex`
`setAcceptDrops`
`setAcceptHoverEvents`
`setAcceptTouchEvents`
`setAcceptedMouseButtons`
`setActive`
`setBackgroundColor`	Sets the background `color` for this item.
`setBackgroundEnabled`	Sets whether this item has a background drawn under it or not.
`setBlendMode`	Sets the item’s composition blending `mode`.
`setBoundingRegionGranularity`
`setBrush`
`setCacheMode`
`setCornerRadius`	Sets the corner `radius` for rounded rectangle corners.
`setCursor`
`setCustomProperty`	Set a custom property for the object.
`setData`
`setDataDefinedProperties`	Sets the objects’s property collection, used for data defined overrides.
`setEnabled`
`setExcludeFromExports`	Sets whether the item should be excluded from layout exports and prints.
`setFiltersChildEvents`
`setFixedSize`
`setFlag`
`setFlags`
`setFocus`
`setFocusProxy`
`setFrameEnabled`	Sets whether this item has a frame drawn around it or not.
`setFrameJoinStyle`	Sets the join `style` used when drawing the item’s frame.
`setFrameStrokeColor`	Sets the frame stroke `color`.
`setFrameStrokeWidth`	Sets the frame stroke `width`.
`setGraphicsEffect`
`setGroup`
`setId`	Set the item’s `id` name.
`setInputMethodHints`
`setItemOpacity`	Sets the item’s `opacity`.
`setItemRotation`	Sets the layout item’s `rotation`, in degrees clockwise.
`setLocked`	Sets whether the item is `locked`, preventing mouse interactions with the item.
`setMinimumSize`
`setMoveContentPreviewOffset`	Sets temporary offset for the item, by a specified `dx` and `dy` in layout units.
`setObjectName`
`setOpacity`
`setPanelModality`
`setParent`
`setParentGroup`	Sets the item’s parent `group`.
`setParentItem`
`setPen`
`setPos`	setPos(self, float, float)
`setProperty`
`setRect`	setRect(self, float, float, float, float)
`setReferencePoint`	Sets the reference `point` for positioning of the layout item.
`setRotation`
`setScale`
`setSelected`	Sets whether the item should be selected.
`setShapeType`	Sets the `type` of shape (e.g.
`setSymbol`	Sets the fill `symbol` used to draw the shape.
`setToolTip`
`setTransform`
`setTransformOriginPoint`	setTransformOriginPoint(self, float, float)
`setTransformations`
`setVisibility`	Sets whether the item is `visible`.
`setVisible`
`setX`
`setY`
`setZValue`
`shape`
`shapeType`	Returns the type of shape (e.g.
`shouldDrawItem`	Returns whether the item should be drawn in the current context.
`show`
`signalsBlocked`
`sizeWithUnits`	Returns the item’s current size, including units.
`stackBefore`
`startTimer`
`symbol`	Returns the fill symbol used to draw the shape.
`templateUuid`	Returns the item’s original identification string.
`thread`
`timerEvent`
`toGraphicsObject`
`toolTip`
`topLeftToReferencePoint`
`topLevelItem`
`topLevelWidget`
`tr`
`transform`
`transformOriginPoint`
`transformations`
`type`
`ungrabKeyboard`
`ungrabMouse`
`unsetCursor`
`update`	update(self, float, float, float, float)
`updateMicroFocus`
`uuid`	Returns the item identification string.
`wheelEvent`
`window`
`writeObjectPropertiesToElement`
`writePropertiesToElement`
`writeXml`	Stores the item state in a DOM element.
`x`
`y`
`zValue`
`zoomContent`	Zooms content of item.

Attributes

`AllProperties`
`BackgroundColor`
`BlendMode`
`DeviceCoordinateCache`
`Ellipse`
`EvaluatedValue`
`ExcludeFromExports`
`FrameColor`
`ItemAcceptsInputMethod`
`ItemChildAddedChange`
`ItemChildRemovedChange`
`ItemClipsChildrenToShape`
`ItemClipsToShape`
`ItemContainsChildrenInShape`
`ItemCoordinateCache`
`ItemCursorChange`
`ItemCursorHasChanged`
`ItemDoesntPropagateOpacityToChildren`
`ItemEnabledChange`
`ItemEnabledHasChanged`
`ItemFlagsChange`
`ItemFlagsHaveChanged`
`ItemHasNoContents`
`ItemHeight`
`ItemIgnoresParentOpacity`
`ItemIgnoresTransformations`
`ItemIsFocusable`
`ItemIsMovable`
`ItemIsPanel`
`ItemIsSelectable`
`ItemMatrixChange`
`ItemNegativeZStacksBehindParent`
`ItemOpacityChange`
`ItemOpacityHasChanged`
`ItemParentChange`
`ItemParentHasChanged`
`ItemPositionChange`
`ItemPositionHasChanged`
`ItemRotation`
`ItemRotationChange`
`ItemRotationHasChanged`
`ItemScaleChange`
`ItemScaleHasChanged`
`ItemSceneChange`
`ItemSceneHasChanged`
`ItemScenePositionHasChanged`
`ItemSelectedChange`
`ItemSelectedHasChanged`
`ItemSendsGeometryChanges`
`ItemSendsScenePositionChanges`
`ItemStacksBehindParent`
`ItemToolTipChange`
`ItemToolTipHasChanged`
`ItemTransformChange`
`ItemTransformHasChanged`
`ItemTransformOriginPointChange`
`ItemTransformOriginPointHasChanged`
`ItemUsesExtendedStyleOption`
`ItemVisibleChange`
`ItemVisibleHasChanged`
`ItemWidth`
`ItemZValueChange`
`ItemZValueHasChanged`
`LegendColumnCount`
`LegendTitle`
`LowerLeft`
`LowerMiddle`
`LowerRight`
`MapAtlasMargin`
`MapLayers`
`MapRotation`
`MapScale`
`MapStylePreset`
`MapXMax`
`MapXMin`
`MapYMax`
`MapYMin`
`Middle`
`MiddleLeft`
`MiddleRight`
`NoCache`
`NoProperty`
`NonModal`
`NumPages`
`Opacity`
`OriginalValue`
`PageNumber`
`PanelModal`
`PaperHeight`
`PaperOrientation`
`PaperWidth`
`PictureSource`
`PictureSvgBackgroundColor`
`PictureSvgStrokeColor`
`PictureSvgStrokeWidth`
`PositionX`
`PositionY`
`PresetPaperSize`
`Rectangle`
`ScalebarFillColor`
`ScalebarFillColor2`
`ScalebarLineColor`
`ScalebarLineWidth`
`SceneModal`
`SourceUrl`
`TestProperty`
`Transparency`
`Triangle`
`Type`
`UndoArrowHeadFillColor`
`UndoArrowHeadStrokeColor`
`UndoArrowHeadWidth`
`UndoArrowStrokeWidth`
`UndoAtlasMargin`
`UndoBackgroundColor`
`UndoCustomCommand`
`UndoGridFramePenColor`
`UndoIncrementalMove`
`UndoIncrementalResize`
`UndoLabelFont`
`UndoLabelFontColor`
`UndoLabelMargin`
`UndoLabelText`
`UndoLegendBoxSpace`
`UndoLegendColumnCount`
`UndoLegendColumnSpace`
`UndoLegendFontColor`
`UndoLegendGroupFont`
`UndoLegendGroupSpace`
`UndoLegendIconSymbolSpace`
`UndoLegendItemFont`
`UndoLegendLayerFont`
`UndoLegendLayerSpace`
`UndoLegendLineSpacing`
`UndoLegendRasterStrokeColor`
`UndoLegendRasterStrokeWidth`
`UndoLegendSymbolHeight`
`UndoLegendSymbolSpace`
`UndoLegendSymbolWidth`
`UndoLegendText`
`UndoLegendTitleFont`
`UndoLegendTitleSpaceBottom`
`UndoLegendWmsLegendHeight`
`UndoLegendWmsLegendWidth`
`UndoMapAnnotationDistance`
`UndoMapGridAnnotationFontColor`
`UndoMapGridFrameFill1Color`
`UndoMapGridFrameFill2Color`
`UndoMapGridLineSymbol`
`UndoMapGridMarkerSymbol`
`UndoMapRotation`
`UndoNodeMove`
`UndoNone`
`UndoOpacity`
`UndoOverviewStyle`
`UndoPictureFillColor`
`UndoPictureNorthOffset`
`UndoPictureRotation`
`UndoPictureStrokeColor`
`UndoPictureStrokeWidth`
`UndoRotation`
`UndoScaleBarBoxContentSpace`
`UndoScaleBarFillColor`
`UndoScaleBarFillColor2`
`UndoScaleBarFontColor`
`UndoScaleBarHeight`
`UndoScaleBarLabelBarSize`
`UndoScaleBarLineWidth`
`UndoScaleBarMapUnitsSegment`
`UndoScaleBarSegmentSize`
`UndoScaleBarSegments`
`UndoScaleBarSegmentsLeft`
`UndoScaleBarStrokeColor`
`UndoScaleBarUnitText`
`UndoSetId`
`UndoShapeCornerRadius`
`UndoShapeStyle`
`UndoStrokeColor`
`UndoStrokeWidth`
`UndoZoomContent`
`UpperLeft`
`UpperMiddle`
`UpperRight`
`UserType`
`changed`	Emitted when the object’s properties change.
`destroyed`	destroyed(self, QObject = None) [signal]
`frameChanged`	Emitted if the item’s frame style changes.
`lockChanged`	Emitted if the item’s lock status changes.
`objectNameChanged`	objectNameChanged(self, str) [signal]
`rotationChanged`	Emitted on item rotation change.
`sizePositionChanged`	Emitted when the item’s size or position changes.
`staticMetaObject`

Ellipse = 0¶

Rectangle = 1¶

class Shape¶: Bases: int

Triangle = 2¶

adjustPointForReferencePosition()¶

applyDataDefinedSize()¶

applyItemSizeConstraint()¶

boundingRect(self) → QRectF¶

childEvent()¶

connectNotify()¶

contextMenuEvent()¶

cornerRadius(self) → QgsLayoutMeasurement¶: Returns the corner radius for rounded rectangle corners.

See also

setCornerRadius()

create(layout: QgsLayout) → QgsLayoutItemShape¶

Returns a new shape item for the specified layout.

The caller takes responsibility for deleting the returned object.

customEvent()¶

disconnectNotify()¶

displayName(self) → str¶

dragEnterEvent()¶

dragLeaveEvent()¶

dragMoveEvent()¶

draw(self, context: QgsRenderContext, itemStyle: QStyleOptionGraphicsItem = None)¶

drawBackground()¶

drawDebugRect()¶

drawFrame()¶

dropEvent()¶

estimatedFrameBleed(self) → float¶

focusInEvent()¶

focusOutEvent()¶

hoverEnterEvent()¶

hoverLeaveEvent()¶

hoverMoveEvent()¶

icon(self) → QIcon¶

inputMethodEvent()¶

inputMethodQuery()¶

isSignalConnected()¶

itemChange()¶

keyPressEvent()¶

keyReleaseEvent()¶

mouseDoubleClickEvent()¶

mouseMoveEvent()¶

mousePressEvent()¶

mouseReleaseEvent()¶

positionAtReferencePoint()¶

prepareGeometryChange()¶

readObjectPropertiesFromElement()¶

readPropertiesFromElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool¶

receivers()¶

refreshBackgroundColor()¶

refreshBlendMode()¶

refreshFrame()¶

refreshItemPosition()¶

refreshItemRotation()¶

refreshItemSize()¶

refreshOpacity()¶

sceneEvent()¶

sceneEventFilter()¶

sender()¶

senderSignalIndex()¶

setCornerRadius(self, radius: QgsLayoutMeasurement)¶: Sets the corner radius for rounded rectangle corners.

See also

cornerRadius()

setFixedSize()¶

setMinimumSize()¶

setShapeType(self, type: QgsLayoutItemShape.Shape)¶: Sets the type of shape (e.g. rectangle, ellipse, etc).

See also

shapeType()

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

shapeType(self) → QgsLayoutItemShape.Shape¶: Returns the type of shape (e.g. rectangle, ellipse, etc).

See also

setShapeType()

symbol(self) → QgsFillSymbol¶: Returns the fill symbol used to draw the shape.

See also

setSymbol()

timerEvent()¶

topLeftToReferencePoint()¶

type(self) → int¶

updateMicroFocus()¶

wheelEvent()¶

writeObjectPropertiesToElement()¶

writePropertiesToElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool¶