Class: QgsLayoutPageCollection¶

A manager for a collection of pages in a layout.

Class Hierarchy¶

Base classes¶

QObject
`QgsLayoutSerializableObject`	An interface for layout objects which can be stored and read from DOM elements.
`QgsLayoutUndoObjectInterface`	Interface for layout objects which support undo/redo commands.

Abstract Methods

`readXml`	Sets the collection's state from a DOM element.
`writeXml`	Stores the collection's state in a DOM element.

Methods

`addPage`	Adds a page to the collection.
`applyPropertiesToAllOtherPages`	Apply the source page properties (size & background color) to all other pages
`beginPageSizeChange`	Should be called before changing any page item sizes, and followed by a call to `endPageSizeChange()`.
`clear`	Removes all pages from the collection.
`deletePage`	Deletes a page from the collection.
`endPageSizeChange`	Should be called after changing any page item sizes, and preceded by a call to `beginPageSizeChange()`.
`extendByNewPage`	Adds a new page to the end of the collection.
`guides`	Returns a reference to the collection's guide collection, which manages page snap guides.
`hasUniformPageSizes`	Returns `True` if the layout has uniform page sizes, e.g. all pages are the same size.
`insertPage`	Inserts a page into a specific position in the collection.
`itemsOnPage`	Returns a list of layout items on the specified page index.
`maximumPageSize`	Returns the maximum size of any page in the collection, by area.
`maximumPageWidth`	Returns the maximum width of pages in the collection.
`page`	Returns a specific page (by pageNumber) from the collection.
`pageAtPoint`	Returns the page at a specified point (in layout coordinates).
`pageCount`	Returns the number of pages in the collection.
`pageIsEmpty`	Returns whether a given page index is empty, ie, it contains no items except for the background paper item.
`pageNumber`	Returns the page number for the specified page, or -1 if the page is not contained in the collection.
`pageNumberForPoint`	Returns the page number corresponding to a point in the layout (in layout units).
`pagePositionToAbsolute`	Converts a position on a page to an absolute position in (maintaining the units from the input position).
`pagePositionToLayoutPosition`	Converts a position on a page to an absolute position in layout coordinates.
`pageShadowWidth`	Returns the size of the page shadow, in layout units.
`pageStyleSymbol`	Returns the symbol to use for drawing pages in the collection.
`pages`	Returns a list of pages in the collection.
`positionOnPage`	Returns the position within a page of a point in the layout (in layout units).
`predictPageNumberForPoint`	Returns the theoretical page number corresponding to a point in the layout (in layout units), assuming that enough pages exist in the layout to cover that point.
`redraw`	Triggers a redraw for all pages.
`reflow`	Forces the page collection to reflow the arrangement of pages, e.g. to account for page size/orientation change.
`resizeToContents`	Resizes the layout to a single page which fits the current contents of the layout.
`setPageStyleSymbol`	Sets the symbol to use for drawing pages in the collection.
`shouldExportPage`	Returns whether the specified page number should be included in exports of the layouts.
`spaceBetweenPages`	Returns the space between pages, in layout units.
`takePage`	Takes a page from the collection, returning ownership of the page to the caller.
`visiblePageNumbers`	Returns a list of the page numbers which are visible within the specified region (in layout coordinates).
`visiblePages`	Returns a list of the pages which are visible within the specified region (in layout coordinates).

Signals

`changed`	Emitted when pages are added or removed from the collection.
`pageAboutToBeRemoved`	Emitted just before a page is removed from the collection.

class qgis.core.QgsLayoutPageCollection[source]¶

Bases: QObject, QgsLayoutSerializableObject

__init__(layout: QgsLayout | None)

Constructor for QgsLayoutItemPage, with the specified parent layout.

Parameters:: layout (Optional[QgsLayout])

addPage(self, page: QgsLayoutItemPage | None)[source]¶

Adds a page to the collection. Ownership of the page is transferred to the collection, and the page will automatically be added to the collection’s layout() (there is no need to manually add the page item to the layout). The page will be added after all pages currently contained in the collection.

Calling addPage() automatically triggers a reflow() of pages.

See also

extendByNewPage()

See also

insertPage()

Parameters:: page (Optional[QgsLayoutItemPage])

applyPropertiesToAllOtherPages(self, sourcePage: int)[source]¶

Apply the source page properties (size & background color) to all other pages

Added in version 3.42.

Parameters:: sourcePage (int)

beginPageSizeChange(self)[source]¶: Should be called before changing any page item sizes, and followed by a call to endPageSizeChange(). If page size changes are wrapped in these calls, then items will maintain their same relative position on pages after the page sizes are updated.

See also

endPageSizeChange()

signal changed[source]¶: Emitted when pages are added or removed from the collection.

clear(self)[source]¶: Removes all pages from the collection.

See also

deletePage()

deletePage(self, pageNumber: int)[source]¶

Deletes a page from the collection. The page will automatically be removed from the collection’s layout().

Page numbers in collections begin at 0 - so a pageNumber of 0 will delete the first page in the collection.

Calling deletePage() automatically triggers a reflow() of pages.

See also

clear()

Parameters:: pageNumber (int)

deletePage(self, page: QgsLayoutItemPage | None)[source]

Deletes a page from the collection. The page will automatically be removed from the collection’s layout().

Calling deletePage() automatically triggers a reflow() of pages.

See also

clear()

Parameters:: page (Optional[QgsLayoutItemPage])

endPageSizeChange(self)[source]¶: Should be called after changing any page item sizes, and preceded by a call to beginPageSizeChange(). If page size changes are wrapped in these calls, then items will maintain their same relative position on pages after the page sizes are updated.

See also

beginPageSizeChange()

extendByNewPage(self) → QgsLayoutItemPage | None[source]¶

Adds a new page to the end of the collection. This page will inherit the same size as the current final page in the collection.

The newly created page will be returned.

See also

addPage()

See also

insertPage()

Return type:: Optional[QgsLayoutItemPage]

guides(self) → QgsLayoutGuideCollection¶

Returns a reference to the collection’s guide collection, which manages page snap guides.

Return type:: QgsLayoutGuideCollection

hasUniformPageSizes(self) → bool[source]¶

Returns True if the layout has uniform page sizes, e.g. all pages are the same size.

This method does not consider differing units as non-uniform sizes, only the actual physical size of the pages.

Return type:: bool

insertPage(self, page: QgsLayoutItemPage | None, beforePage: int)[source]¶

Inserts a page into a specific position in the collection.

Ownership of the page is transferred to the collection, and the page will automatically be added to the collection’s layout() (there is no need to manually add the page item to the layout).

The page will be added after before the page number specified by beforePage. (Page numbers in collections begin at 0 - so a beforePage of 0 will insert the page before all existing pages).

Calling insertPage() automatically triggers a reflow() of pages.

See also

addPage()

Parameters:

page (Optional[QgsLayoutItemPage])
beforePage (int)

itemsOnPage(self, page: int) → List[QgsLayoutItem]¶

Returns a list of layout items on the specified page index.

Parameters:: page (int)
Return type:: List[QgsLayoutItem]

maximumPageSize(self) → QSizeF[source]¶

Returns the maximum size of any page in the collection, by area. The returned value is in layout units.

See also

maximumPageWidth()

Return type:: QSizeF

maximumPageWidth(self) → float[source]¶

Returns the maximum width of pages in the collection. The returned value is in layout units.

See also

maximumPageSize()

Return type:: float

page(self, pageNumber: int) → QgsLayoutItemPage | None[source]¶

Returns a specific page (by pageNumber) from the collection. Internal page numbering starts at 0 - so a pageNumber of 0 corresponds to the first page in the collection. A None is returned if an invalid page number is specified.

See also

pages()

Parameters:: pageNumber (int)
Return type:: Optional[QgsLayoutItemPage]

signal pageAboutToBeRemoved(pageNumber: int)[source]¶

Emitted just before a page is removed from the collection.

Page numbers in collections begin at 0 - so a page number of 0 indicates the first page.

Parameters:: pageNumber (int)

pageAtPoint(self, point: QPointF | QPoint) → QgsLayoutItemPage | None[source]¶

Returns the page at a specified point (in layout coordinates).

If no page exists at point, None will be returned.

Note

Unlike pageNumberForPoint(), this method only returns pages which directly intersect with the specified point.

See also

pageNumberForPoint()

Parameters:: point (Union[QPointF, QPoint])
Return type:: Optional[QgsLayoutItemPage]

pageCount(self) → int[source]¶

Returns the number of pages in the collection.

See also

pages()

Return type:: int

pageIsEmpty(self, page: int) → bool[source]¶

Returns whether a given page index is empty, ie, it contains no items except for the background paper item.

See also

shouldExportPage()

Parameters:: page (int)
Return type:: bool

pageNumber(self, page: QgsLayoutItemPage | None) → int[source]¶

Returns the page number for the specified page, or -1 if the page is not contained in the collection.

Parameters:: page (Optional[QgsLayoutItemPage])
Return type:: int

pageNumberForPoint(self, point: QPointF | QPoint) → int[source]¶

Returns the page number corresponding to a point in the layout (in layout units).

Page numbers in collections begin at 0 - so a page number of 0 indicates the first page.

Note

This is a relaxed check, which will always return a page number. For instance, it does not consider x coordinates and vertical coordinates before the first page or after the last page will still return the nearest page.

See also

predictPageNumberForPoint()

See also

pageAtPoint()

See also

positionOnPage()

Parameters:: point (Union[QPointF, QPoint])
Return type:: int

pagePositionToAbsolute(self, page: int, position: QgsLayoutPoint) → QgsLayoutPoint[source]¶

Converts a position on a page to an absolute position in (maintaining the units from the input position).

See also

pagePositionToLayoutPosition()

Parameters:

page (int)
position (QgsLayoutPoint)

Return type:

QgsLayoutPoint

pagePositionToLayoutPosition(self, page: int, position: QgsLayoutPoint) → QPointF[source]¶

Converts a position on a page to an absolute position in layout coordinates.

See also

pagePositionToAbsolute()

Parameters:

page (int)
position (QgsLayoutPoint)

Return type:

QPointF

pageShadowWidth(self) → float[source]¶

Returns the size of the page shadow, in layout units.

Return type:: float

pageStyleSymbol(self) → QgsFillSymbol | None[source]¶

Returns the symbol to use for drawing pages in the collection.

See also

setPageStyleSymbol()

Deprecated since version 3.40: Use QgsLayoutItemPage.pageStyleSymbol() instead.

Return type:: Optional[QgsFillSymbol]

pages(self) → List[QgsLayoutItemPage]¶

Returns a list of pages in the collection.

See also

page()

See also

pageCount()

Return type:: List[QgsLayoutItemPage]

positionOnPage(self, point: QPointF | QPoint) → QPointF[source]¶

Returns the position within a page of a point in the layout (in layout units).

See also

pageNumberForPoint()

Parameters:: point (Union[QPointF, QPoint])
Return type:: QPointF

predictPageNumberForPoint(self, point: QPointF | QPoint) → int[source]¶

Returns the theoretical page number corresponding to a point in the layout (in layout units), assuming that enough pages exist in the layout to cover that point.

If there are insufficient pages currently in the layout, this method will assume that extra “imaginary” pages have been added at the end of the layout until that point is reached. These imaginary pages will inherit the size of the existing final page in the layout.

Page numbers in collections begin at 0 - so a page number of 0 indicates the first page.

See also

pageNumberForPoint()

See also

pageAtPoint()

See also

positionOnPage()

Parameters:: point (Union[QPointF, QPoint])
Return type:: int

abstract readXml(self, collectionElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool[source]¶

Sets the collection’s state from a DOM element. collectionElement is the DOM node corresponding to the collection.

See also

writeXml()

Parameters:

collectionElement (QDomElement)
document (QDomDocument)
context (QgsReadWriteContext)

Return type:

bool

redraw(self)[source]¶: Triggers a redraw for all pages.

reflow(self)[source]¶: Forces the page collection to reflow the arrangement of pages, e.g. to account for page size/orientation change.

resizeToContents(self, margins: QgsMargins, marginUnits: Qgis.LayoutUnit)[source]¶

Resizes the layout to a single page which fits the current contents of the layout.

Calling this method resets the number of pages to 1, with the size set to the minimum size required to fit all existing layout items. Items will also be repositioned so that the new top-left bounds of the layout is at the point (marginLeft, marginTop). An optional margin can be specified.

Parameters:

margins (QgsMargins)
marginUnits (Qgis.LayoutUnit)

setPageStyleSymbol(self, symbol: QgsFillSymbol | None)[source]¶

Sets the symbol to use for drawing pages in the collection.

Ownership is not transferred, and a copy of the symbol is created internally.

See also

pageStyleSymbol()

Parameters:: symbol (Optional[QgsFillSymbol])

shouldExportPage(self, page: int) → bool[source]¶

Returns whether the specified page number should be included in exports of the layouts.

Warning

This will always return True unless the layout is being currently exported – it cannot be used in advance to determine whether a given page will be exported!

See also

pageIsEmpty()

Parameters:: page (int)
Return type:: bool

spaceBetweenPages(self) → float[source]¶

Returns the space between pages, in layout units.

Return type:: float

takePage(self, page: QgsLayoutItemPage | None) → QgsLayoutItemPage | None[source]¶

Takes a page from the collection, returning ownership of the page to the caller.

Parameters:: page (Optional[QgsLayoutItemPage])
Return type:: Optional[QgsLayoutItemPage]

visiblePageNumbers(self, region: QRectF) → List[int]¶

Returns a list of the page numbers which are visible within the specified region (in layout coordinates).

See also

visiblePages()

Parameters:: region (QRectF)
Return type:: List[int]

visiblePages(self, region: QRectF) → List[QgsLayoutItemPage]¶

Returns a list of the pages which are visible within the specified region (in layout coordinates).

See also

visiblePageNumbers()

Parameters:: region (QRectF)
Return type:: List[QgsLayoutItemPage]

abstract writeXml(self, parentElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool[source]¶

Stores the collection’s state in a DOM element. The parentElement should refer to the parent layout’s DOM element.

See also

readXml()

Parameters:

parentElement (QDomElement)
document (QDomDocument)
context (QgsReadWriteContext)

Return type:

bool