Class: QgsLayoutFrame

class qgis.core.QgsLayoutFrame

Bases: QgsLayoutItem

Base class for frame items, which form a layout multiframe item.

New in version 3.0.

QgsLayoutFrame(layout: QgsLayout, multiFrame: QgsLayoutMultiFrame) Constructor for QgsLayoutFrame, with the specified parent layout and belonging to a multiFrame.

Methods

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.

childEvent

cleanup

connectNotify

contextMenuEvent

create

Creates a new QgsLayoutFrame belonging to the specified layout.

createExpressionContext

rtype

QgsExpressionContext

customEvent

disconnectNotify

displayName

rtype

str

dragEnterEvent

dragLeaveEvent

dragMoveEvent

draw

param context

drawBackground

param context

drawDebugRect

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

drawFrame

param context

dropEvent

exportLayerBehavior

rtype

QgsLayoutItem.ExportLayerBehavior

extent

Returns the visible portion of the multi frame’s content which is shown in this frame, in layout units.

fixedSize

rtype

QgsLayoutSize

focusInEvent

focusOutEvent

framePath

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

hideBackgroundIfEmpty

Returns whether the background and frame stroke should be hidden if this frame is empty

hidePageIfEmpty

Returns whether the page should be hidden (ie, not included in layout exports) if this frame is empty

hoverEnterEvent

hoverLeaveEvent

hoverMoveEvent

icon

rtype

QIcon

inputMethodEvent

inputMethodQuery

isEmpty

Returns whether the frame is empty.

isSignalConnected

itemChange

keyPressEvent

keyReleaseEvent

minimumSize

rtype

QgsLayoutSize

mouseDoubleClickEvent

mouseMoveEvent

mousePressEvent

mouseReleaseEvent

multiFrame

Returns the parent multiframe for the frame.

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 itemElement

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

setContentSection

Sets the visible part of the multiframe’s content which is visible within this frame (relative to the total multiframe extent in layout units).

setFixedSize

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

setHideBackgroundIfEmpty

Sets whether the background and frame stroke should be hidden if this frame is empty

setHidePageIfEmpty

Sets whether the page should be hidden (ie, not included in layout exports) if this frame is empty

setMinimumSize

Sets the minimum allowed size for the layout item.

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 parentElement

adjustPointForReferencePosition(self, point: Union[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()

childEvent(self, QChildEvent)
cleanup(self)
connectNotify(self, QMetaMethod)
contextMenuEvent(self, QGraphicsSceneContextMenuEvent)
create(layout: QgsLayout)QgsLayoutFrame

Creates a new QgsLayoutFrame belonging to the specified layout.

Parameters

layout (QgsLayout) –

Return type

QgsLayoutFrame

createExpressionContext(self)QgsExpressionContext
Return type

QgsExpressionContext

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

context (QgsRenderContext) –

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

context (QgsRenderContext) –

dropEvent(self, QGraphicsSceneDragDropEvent)
exportLayerBehavior(self)QgsLayoutItem.ExportLayerBehavior
Return type

QgsLayoutItem.ExportLayerBehavior

extent(self)QRectF

Returns the visible portion of the multi frame’s content which is shown in this frame, in layout units.

Return type

QRectF

fixedSize(self)QgsLayoutSize
Return type

QgsLayoutSize

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.

hideBackgroundIfEmpty(self)bool

Returns whether the background and frame stroke should be hidden if this frame is empty

Return type

bool

Returns

True if background and stroke should be hidden if frame is empty

hidePageIfEmpty(self)bool

Returns whether the page should be hidden (ie, not included in layout exports) if this frame is empty

Return type

bool

Returns

True if page should be hidden if frame is empty

hoverEnterEvent(self, QGraphicsSceneHoverEvent)
hoverLeaveEvent(self, QGraphicsSceneHoverEvent)
hoverMoveEvent(self, QGraphicsSceneHoverEvent)
icon(self)QIcon
Return type

QIcon

inputMethodEvent(self, QInputMethodEvent)
inputMethodQuery(self, Qt.InputMethodQuery)Any
isEmpty(self)bool

Returns whether the frame is empty.

Return type

bool

isSignalConnected(self, QMetaMethod)bool
itemChange(self, QGraphicsItem.GraphicsItemChange, Any)Any
keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
minimumSize(self)QgsLayoutSize
Return type

QgsLayoutSize

mouseDoubleClickEvent(self, QGraphicsSceneMouseEvent)
mouseMoveEvent(self, QGraphicsSceneMouseEvent)
mousePressEvent(self, QGraphicsSceneMouseEvent)
mouseReleaseEvent(self, QGraphicsSceneMouseEvent)
multiFrame(self)QgsLayoutMultiFrame

Returns the parent multiframe for the frame.

Return type

QgsLayoutMultiFrame

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

readPropertiesFromElement(self, itemElement: 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.

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.

refreshItemSize(self)

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

See also

setFixedSize()

See also

setMinimumSize()

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
setContentSection(self, section: QRectF)

Sets the visible part of the multiframe’s content which is visible within this frame (relative to the total multiframe extent in layout units).

See also

extent()

Parameters

section (QRectF) –

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

setHideBackgroundIfEmpty(self, hideBackgroundIfEmpty: bool)

Sets whether the background and frame stroke should be hidden if this frame is empty

Parameters

hideBackgroundIfEmpty (bool) – set to True if background and stroke should be hidden if frame is empty

setHidePageIfEmpty(self, hidePageIfEmpty: bool)

Sets whether the page should be hidden (ie, not included in layout exports) if this frame is empty

Parameters

hidePageIfEmpty (bool) – set to True if page should be hidden if frame is empty

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

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

writePropertiesToElement(self, parentElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext)bool
Parameters
  • parentElement (QDomElement) –

  • document (QDomDocument) –

  • context (QgsReadWriteContext) –

Return type

bool