Subgroup: Layout
Class: QgsLayoutPageCollection¶
-
class
qgis.core.
QgsLayoutPageCollection
¶ Bases:
PyQt5.QtCore.QObject
,qgis._core.QgsLayoutSerializableObject
A manager for a collection of pages in a layout.
New in version 3.0: Methods
addPage
Adds a page
to the collection.beginPageSizeChange
Should be called before changing any page item sizes, and followed by a call to endPageSizeChange(). blockSignals
childEvent
children
clear
Removes all pages from the collection. connectNotify
createCommand
customEvent
deleteLater
deletePage
Deletes a page from the collection. disconnect
disconnectNotify
dumpObjectInfo
dumpObjectTree
dynamicPropertyNames
endPageSizeChange
Should be called after changing any page item sizes, and preceded by a call to beginPageSizeChange(). event
eventFilter
extendByNewPage
Adds a new page to the end of the collection. 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] 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. inherits
insertPage
Inserts a page
into a specific position in the collection.installEventFilter
isSignalConnected
isWidgetType
isWindowType
itemsOnPage
Returns a list of layout items on the specified page
index.killTimer
layout
maximumPageSize
Returns the maximum size of any page in the collection, by area. maximumPageWidth
Returns the maximum width of pages in the collection. metaObject
moveToThread
objectName
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 apage
to an absolute position in (maintaining the units from the inputposition
).pagePositionToLayoutPosition
Converts a position
on apage
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. parent
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.property
pyqtConfigure
Each keyword argument is either the name of a Qt property or a Qt signal. readXml
Sets the collection’s state from a DOM element. receivers
redraw
Triggers a redraw for all pages. reflow
Forces the page collection to reflow the arrangement of pages, e.g. removeEventFilter
resizeToContents
Resizes the layout to a single page which fits the current contents of the layout. sender
senderSignalIndex
setObjectName
setPageStyleSymbol
Sets the symbol
to use for drawing pages in the collection.setParent
setProperty
shouldExportPage
Returns whether the specified page
number should be included in exports of the layouts.signalsBlocked
spaceBetweenPages
Returns the space between pages, in layout units. startTimer
stringType
takePage
Takes a page
from the collection, returning ownership of the page to the caller.thread
timerEvent
tr
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).writeXml
Stores the collection’s state in a DOM element. Attributes
changed
Emitted when pages are added or removed from the collection. destroyed
destroyed(self, QObject = None) [signal] objectNameChanged
objectNameChanged(self, str) [signal] pageAboutToBeRemoved
Emitted just before a page is removed from the collection. staticMetaObject
-
addPage
(self, page: QgsLayoutItemPage)¶ Adds a
page
to the collection. Ownership of thepage
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
See also
-
beginPageSizeChange
(self)¶ 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
-
changed
¶ Emitted when pages are added or removed from the collection. [signal]
-
childEvent
()¶
-
clear
(self)¶ Removes all pages from the collection.
See also
-
connectNotify
()¶
-
customEvent
()¶
-
deletePage
(self, pageNumber: int)¶ 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
deletePage(self, page: QgsLayoutItemPage) 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
-
disconnectNotify
()¶
-
endPageSizeChange
(self)¶ 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
-
extendByNewPage
(self) → QgsLayoutItemPage¶ 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
See also
-
guides
(self) → QgsLayoutGuideCollection¶ Returns a reference to the collection’s guide collection, which manages page snap guides.
-
hasUniformPageSizes
(self) → bool¶ 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.
-
insertPage
(self, page: QgsLayoutItemPage, beforePage: int)¶ 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 abeforePage
of 0 will insert the page before all existing pages).Calling insertPage() automatically triggers a reflow() of pages.
See also
-
isSignalConnected
()¶
-
itemsOnPage
(self, page: int) → List[QgsLayoutItem]¶ Returns a list of layout items on the specified
page
index.
-
layout
(self) → QgsLayout¶
-
maximumPageSize
(self) → QSizeF¶ Returns the maximum size of any page in the collection, by area. The returned value is in layout units.
See also
-
maximumPageWidth
(self) → float¶ Returns the maximum width of pages in the collection. The returned value is in layout units.
See also
-
page
(self, pageNumber: int) → QgsLayoutItemPage¶ Returns a specific page (by
pageNumber
) from the collection. Internal page numbering starts at 0 - so apageNumber
of 0 corresponds to the first page in the collection. A None is returned if an invalid page number is specified.See also
-
pageAboutToBeRemoved
¶ 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. [signal]
-
pageAtPoint
(self, point: Union[QPointF, QPoint]) → QgsLayoutItemPage¶ 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
-
pageIsEmpty
(self, page: int) → bool¶ Returns whether a given
page
index is empty, ie, it contains no items except for the background paper item.See also
-
pageNumber
(self, page: QgsLayoutItemPage) → int¶ Returns the page number for the specified
page
, or -1 if the page is not contained in the collection.
-
pageNumberForPoint
(self, point: Union[QPointF, QPoint]) → int¶ 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
predicatePageNumberForPoint()
See also
See also
-
pagePositionToAbsolute
(self, page: int, position: QgsLayoutPoint) → QgsLayoutPoint¶ Converts a
position
on apage
to an absolute position in (maintaining the units from the inputposition
).See also
-
pagePositionToLayoutPosition
(self, page: int, position: QgsLayoutPoint) → QPointF¶ Converts a
position
on apage
to an absolute position in layout coordinates.See also
-
pageShadowWidth
(self) → float¶ Returns the size of the page shadow, in layout units.
-
pageStyleSymbol
(self) → QgsFillSymbol¶ Returns the symbol to use for drawing pages in the collection.
See also
-
pages
(self) → object¶ Returns a list of pages in the collection.
See also
See also
-
positionOnPage
(self, point: Union[QPointF, QPoint]) → QPointF¶ Returns the position within a page of a
point
in the layout (in layout units).See also
-
predictPageNumberForPoint
(self, point: Union[QPointF, QPoint]) → int¶ 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
See also
See also
-
readXml
(self, collectionElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool¶ Sets the collection’s state from a DOM element. collectionElement is the DOM node corresponding to the collection.
See also
-
receivers
()¶
-
redraw
(self)¶ Triggers a redraw for all pages.
-
reflow
(self)¶ Forces the page collection to reflow the arrangement of pages, e.g. to account for page size/orientation change.
-
resizeToContents
(self, margins: QgsMargins, marginUnits: QgsUnitTypes.LayoutUnit)¶ 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.
-
sender
()¶
-
senderSignalIndex
()¶
-
setPageStyleSymbol
(self, symbol: QgsFillSymbol)¶ 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
-
shouldExportPage
(self, page: int) → bool¶ Returns whether the specified
page
number should be included in exports of the layouts.See also
-
spaceBetweenPages
(self) → float¶ Returns the space between pages, in layout units.
-
stringType
(self) → str¶
-
takePage
(self, page: QgsLayoutItemPage) → QgsLayoutItemPage¶ Takes a
page
from the collection, returning ownership of the page to the caller.
-
timerEvent
()¶
-
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
(self, region: QRectF) → List[QgsLayoutItemPage]¶ Returns a list of the pages which are visible within the specified
region
(in layout coordinates).See also
-