Class: QgsLayoutItemPolygon¶
-
class
qgis.core.
QgsLayoutItemPolygon
(layout: QgsLayout)¶ Bases:
QgsLayoutNodesItem
Constructor for
QgsLayoutItemPolygon
for the specifiedlayout
.QgsLayoutItemPolygon(polygon: QPolygonF, layout:
QgsLayout
) Constructor forQgsLayoutItemPolygon
for the specifiedpolygon
andlayout
.Layout item for node based polygon shapes.
New in version 3.0.
- Parameters
layout –
-
accept
(self, visitor: QgsStyleEntityVisitorInterface) → bool¶ - Parameters
visitor (QgsStyleEntityVisitorInterface) –
- Return type
bool
-
adjustPointForReferencePosition
(self, point: Union[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.
-
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
See also
-
childEvent
(self, QChildEvent)¶
-
computeDistance
(self, pt1: Union[QPointF, QPoint], pt2: Union[QPointF, QPoint]) → float¶ Compute an euclidean distance between 2 nodes.
-
connectNotify
(self, QMetaMethod)¶
-
contextMenuEvent
(self, QGraphicsSceneContextMenuEvent)¶
-
create
(layout: QgsLayout) → QgsLayoutItemPolygon¶ Returns a new polygon item for the specified
layout
.The caller takes responsibility for deleting the returned object.
- Parameters
layout (QgsLayout) –
- Return type
-
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)¶
-
drawBackground
(self, context: QgsRenderContext)¶ Draws the background for the item.
-
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.
-
dropEvent
(self, QGraphicsSceneDragDropEvent)¶
-
focusInEvent
(self, QFocusEvent)¶
-
focusOutEvent
(self, QFocusEvent)¶
-
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)¶
-
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¶
-
receivers
(self, PYQT_SIGNAL) → int¶
-
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 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 toFalse
, 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
-
refreshItemRotation
(self, origin: Union[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 to update() must be made.
-
rescaleToFitBoundingBox
(self)¶ Rescale the current shape according to the item’s bounding box. Useful when the shape is resized thanks to the rubber band.
-
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
-
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
-
setSymbol
(self, symbol: QgsFillSymbol)¶ Sets the
symbol
used to draw the shape. Ownership ofsymbol
is not transferred.See also
- Parameters
symbol (QgsFillSymbol) –
-
symbol
(self) → QgsFillSymbol¶ Returns the fill symbol used to draw the shape.
See also
- Return type
-
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
-
updateBoundingRect
(self)¶ Called when the bounding rect of the item should recalculated. Subclasses should update currentRectangle in their implementations.
-
updateMicroFocus
(self)¶
-
updateSceneRect
(self)¶ Update the current scene rectangle for this item.
-
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¶