Class: QgsLayoutItemPage

class qgis.core.QgsLayoutItemPage(layout: QgsLayout)

Bases: QgsLayoutItem

Constructor for QgsLayoutItemPage, with the specified parent layout.

Item representing the paper in a layout.

New in version 3.0.

Parameters

layout

Landscape = 1
class Orientation

Bases: int

Portrait = 0
class UndoCommand

Bases: int

UndoPageSymbol = 3000
accept(self, visitor: QgsStyleEntityVisitorInterface) → bool
Parameters

visitor (QgsStyleEntityVisitorInterface) –

Return type

bool

adjustPointForReferencePosition()
applyDataDefinedSize()
applyItemSizeConstraint()
attemptResize(self, size: QgsLayoutSize, includesFrame: bool = False)
Parameters
boundingRect(self) → QRectF
Return type

QRectF

childEvent()
connectNotify()
contextMenuEvent()
create(layout: QgsLayout)QgsLayoutItemPage

Returns a new page item for the specified layout.

The caller takes responsibility for deleting the returned object.

Parameters

layout (QgsLayout) –

Return type

QgsLayoutItemPage

createCommand(self, text: str, id: int, parent: QUndoCommand = None)QgsAbstractLayoutUndoCommand
Parameters
  • text (str) –

  • id (int) –

  • parent (QUndoCommand = None) –

Return type

QgsAbstractLayoutUndoCommand

customEvent()
decodePageOrientation(string: str) → Tuple[QgsLayoutItemPage.Orientation, bool]

Decodes a string representing a page orientation. If specified, ok will be set to True if string could be successfully interpreted as a page orientation.

Parameters

string (str) –

Return type

Tuple[QgsLayoutItemPage.Orientation, bool]

disconnectNotify()
displayName(self) → str
Return type

str

dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
draw(self, context: QgsLayoutItemRenderContext)
Parameters

context (QgsLayoutItemRenderContext) –

drawBackground(self, context: QgsRenderContext)
Parameters

context (QgsRenderContext) –

drawDebugRect()
drawFrame(self, context: QgsRenderContext)
Parameters

context (QgsRenderContext) –

dropEvent()
exportLayerBehavior(self) → QgsLayoutItem.ExportLayerBehavior
Return type

QgsLayoutItem.ExportLayerBehavior

focusInEvent()
focusOutEvent()
hoverEnterEvent()
hoverLeaveEvent()
hoverMoveEvent()
inputMethodEvent()
inputMethodQuery()
isSignalConnected()
itemChange()
keyPressEvent()
keyReleaseEvent()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
orientation(self) → QgsLayoutItemPage.Orientation

Returns the page orientation.

Note

There is no direct setter for page orientation - use setPageSize() instead.

Return type

QgsLayoutItemPage.Orientation

pageSize(self)QgsLayoutSize

Returns the size of the page.

See also

setPageSize()

Return type

QgsLayoutSize

pageStyleSymbol(self)QgsFillSymbol

Returns the symbol to use for drawing the page background.

New in version 3.10.

Return type

QgsFillSymbol

positionAtReferencePoint()
prepareGeometryChange()
readObjectPropertiesFromElement()
readPropertiesFromElement(self, itemElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool
Parameters
Return type

bool

receivers()
redraw(self)
refreshBackgroundColor()
refreshBlendMode()
refreshFrame()
refreshItemPosition()
refreshItemRotation()
refreshItemSize()
refreshOpacity()
sceneEvent()
sceneEventFilter()
sender()
senderSignalIndex()
setFixedSize()
setMinimumSize()
setPageSize(self, size: QgsLayoutSize)

Sets the size of the page.

See also

pageSize()

setPageSize(self, size: str, orientation: QgsLayoutItemPage.Orientation = QgsLayoutItemPage.Portrait) -> bool Sets the page size to a known page size, e.g. “A4” and orientation. The known page sizes are managed by QgsPageSizeRegistry. Valid page sizes can be retrieved via QgsPageSizeRegistry.entries() The function returns True if size was a valid page size and the page size was changed. If False is returned then size could not be matched to a known page size.

See also

pageSize()

Parameters

size (QgsLayoutSize) –

setPageStyleSymbol(self, symbol: QgsFillSymbol)

Sets the symbol to use for drawing the page background.

Ownership of symbol is transferred to the page.

New in version 3.10.

Parameters

symbol (QgsFillSymbol) –

timerEvent()
topLeftToReferencePoint()
type(self) → int
Return type

int

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

  • document (QDomDocument) –

  • context (QgsReadWriteContext) –

Return type

bool