Subgroup: Layout
Class: QgsLayoutMultiFrame¶
-
class
qgis.core.
QgsLayoutMultiFrame
(layout: QgsLayout)¶ Bases:
qgis._core.QgsLayoutObject
,qgis._core.QgsLayoutUndoObjectInterface
Construct a new multiframe item, attached to the specified
layout
.Abstract base class for layout items with the ability to distribute the content to several frames (QgsLayoutFrame items).
New in version 3.0: Methods
addFrame
Adds a frame
to the multiframe.beginCommand
Starts new undo command for this item. cancelCommand
Cancels the current item command and discards it. childEvent
connectNotify
createCommand
createNewFrame
Creates a new frame and adds it to the multi frame and layout. customEvent
deleteFrames
Removes and deletes all child frames. disconnectNotify
displayName
Returns the multiframe display name. endCommand
Completes the current item command and push it onto the layout’s undo stack. finalizeRestoreFromXml
Called after all pending items have been restored from XML. findNearbyPageBreak
Finds the optimal position to break a frame at. fixedFrameSize
Returns the fixed size for a frame, if desired. frame
Returns the child frame at a specified index
from the multiframe.frameCount
Returns the number of frames associated with this multiframe. frameIndex
Returns the index of a frame
within the multiframe.frames
Returns a list of all child frames for this multiframe. icon
Returns the item’s icon. isSignalConnected
minFrameSize
Returns the minimum size for a frames, if desired. readObjectPropertiesFromElement
readPropertiesFromElement
Sets multiframe state from a DOM element. readXml
Sets the item state from a DOM element. recalculateFrameRects
Forces a recalculation of all the associated frame’s scene rectangles. recalculateFrameSizes
Recalculates the portion of the multiframe item which is shown in each of its component frames. receivers
refresh
Refreshes the multiframe, causing a recalculation of any property overrides. refreshDataDefinedProperty
Refreshes a data defined property
for the multi frame by reevaluating the property’s value and redrawing the item with this new value.removeFrame
Removes a frame by index
from the multiframe.render
Renders a portion of the multiframe’s content into a render context
.resizeMode
Returns the resize mode for the multiframe. sender
senderSignalIndex
setResizeMode
Sets the resize mode
for the multiframe, and recalculates frame sizes to match.timerEvent
totalSize
Returns the total size of the multiframe’s content, in layout units. type
Returns unique multiframe type id. update
Forces a redraw of all child frames. uuid
Returns the multiframe identification string. writeObjectPropertiesToElement
writePropertiesToElement
Stores multiframe state within an XML DOM element. writeXml
Stores the multiframe state in a DOM element. Signals
contentsChanged
Emitted when the contents of the multi frame have changed and the frames must be redrawn. Attributes
-
ExtendToNextPage
= 1¶
-
RepeatOnEveryPage
= 2¶
-
RepeatUntilFinished
= 3¶
-
class
ResizeMode
¶ Bases:
int
-
class
UndoCommand
¶ Bases:
int
-
UndoHtmlBreakDistance
= 0¶
-
UndoHtmlSource
= 1¶
-
UndoHtmlStylesheet
= 2¶
-
UndoNone
= -1¶
-
UndoTableBackgroundColor
= 10¶
-
UndoTableCellStyle
= 3¶
-
UndoTableContentFontColor
= 7¶
-
UndoTableGridColor
= 9¶
-
UndoTableGridStrokeWidth
= 8¶
-
UndoTableHeaderFontColor
= 6¶
-
UndoTableMargin
= 5¶
-
UndoTableMaximumFeatures
= 4¶
-
UseExistingFrames
= 0¶
-
addFrame
(self, frame: QgsLayoutFrame, recalcFrameSizes: bool = True)¶ Adds a
frame
to the multiframe.If
recalcFrameSizes
is set to true, then a recalculation of all existing frame sizes will be forced.See also
-
beginCommand
(self, commandText: str, command: QgsLayoutMultiFrame.UndoCommand = QgsLayoutMultiFrame.UndoNone)¶ Starts new undo command for this item. The
commandText
should be a capitalized, imperative tense description (e.g. “Add Map Item”). If specified, multiple consecutive commands for this item with the samecommand
will be collapsed into a single undo command in the layout history.See also
See also
-
cancelCommand
(self)¶ Cancels the current item command and discards it.
See also
See also
-
childEvent
()¶
-
connectNotify
()¶
-
contentsChanged
¶ Emitted when the contents of the multi frame have changed and the frames must be redrawn. [signal]
-
createCommand
(self, text: str, id: int, parent: QUndoCommand = None) → QgsAbstractLayoutUndoCommand¶
-
createNewFrame
(self, currentFrame: QgsLayoutFrame, pos: Union[QPointF, QPoint], size: QSizeF) → QgsLayoutFrame¶ Creates a new frame and adds it to the multi frame and layout.
Parameters: - currentFrame – an existing QgsLayoutFrame from which to copy the size and general frame properties (e.g., frame style, background, rendering settings).
- pos – position of top-left corner of the new frame, in layout units
- size – size of the new frame, in layout units
-
customEvent
()¶
-
deleteFrames
(self)¶ Removes and deletes all child frames.
See also
-
disconnectNotify
()¶
-
displayName
(self) → str¶ Returns the multiframe display name.
-
endCommand
(self)¶ Completes the current item command and push it onto the layout’s undo stack.
See also
See also
-
finalizeRestoreFromXml
(self)¶ Called after all pending items have been restored from XML. Multiframes can use this method to run steps which must take place after all items have been restored to the layout, such as connecting to signals emitted by other items, which may not have existed in the layout at the time readXml() was called. E.g. a scalebar can use this to connect to its linked map item after restoration from XML.
See also
-
findNearbyPageBreak
(self, yPos: float) → float¶ Finds the optimal position to break a frame at.
Parameters: yPos – maximum vertical position for break, in layout units. Returns: the optimal breakable position which occurs in the multi frame close to and before the specified yPos
-
fixedFrameSize
(self, frameIndex: int = -1) → QSizeF¶ Returns the fixed size for a frame, if desired. If the fixed frame size changes, the sizes of all frames can be recalculated by calling recalculateFrameRects().
Parameters: frameIndex – frame number Returns: fixed size for frame. If the size has a width or height of 0, then the frame size is not fixed in that direction and frames can have variable width or height accordingly. See also
See also
-
frame
(self, index: int) → QgsLayoutFrame¶ Returns the child frame at a specified
index
from the multiframe.See also
-
frameCount
(self) → int¶ Returns the number of frames associated with this multiframe.
See also
-
frameIndex
(self, frame: QgsLayoutFrame) → int¶ Returns the index of a
frame
within the multiframe.Returns: index for frame if found, -1 if frame not found in multiframe See also
-
frames
(self) → object¶ Returns a list of all child frames for this multiframe.
See also
-
icon
(self) → QIcon¶ Returns the item’s icon.
-
isSignalConnected
()¶
-
minFrameSize
(self, frameIndex: int = -1) → QSizeF¶ Returns the minimum size for a frames, if desired. If the minimum size changes, the sizes of all frames can be recalculated by calling recalculateFrameRects().
Parameters: frameIndex – frame number Returns: minimum size for frame. If the size has a width or height of 0, then the frame size has no minimum in that direction. See also
See also
-
readObjectPropertiesFromElement
()¶
-
readPropertiesFromElement
(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool¶ Sets multiframe state from a DOM element.
Parameters: - element – is the DOM element for the multiframe
- document – DOM document
- context – read write context
See also
Note that item subclasses should not rely on all other items being present in the layout at the time this method is called. Instead, any connections and links to other items must be made in the finalizeRestoreFromXml() method. E.g. when restoring a scalebar, the connection to the linked map’s signals should be implemented in finalizeRestoreFromXml(), not readPropertiesFromElement().
See also
-
readXml
(self, itemElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext, includeFrames: bool = False) → bool¶ Sets the item state from a DOM element.
Parameters: - itemElement – is the DOM node corresponding to item (e.g. ‘LayoutItem’ element)
- document – DOM document
- context – read write context
- includeFrames – set to true to read state information about child frames from DOM
See also
-
recalculateFrameRects
(self)¶ Forces a recalculation of all the associated frame’s scene rectangles. This method is useful for multiframes which implement a minFrameSize() or fixedFrameSize() method.
See also
See also
See also
-
recalculateFrameSizes
(self)¶ Recalculates the portion of the multiframe item which is shown in each of its component frames. If the resize mode is set to anything but UseExistingFrames then this may cause new frames to be added or frames to be removed, in order to fit the current size of the multiframe’s content.
See also
-
receivers
()¶
-
refresh
(self)¶ Refreshes the multiframe, causing a recalculation of any property overrides.
-
refreshDataDefinedProperty
(self, property: QgsLayoutObject.DataDefinedProperty = QgsLayoutObject.AllProperties)¶ Refreshes a data defined
property
for the multi frame by reevaluating the property’s value and redrawing the item with this new value. Ifproperty
is set to QgsLayoutObject.AllProperties then all data defined properties for the item will be refreshed.
-
removeFrame
(self, index: int, removeEmptyPages: bool = False)¶ Removes a frame by
index
from the multiframe. This method automatically removes the frame from the layout too.If
removeEmptyPages
is set to true, then pages which are empty after the frame is removed will also be removed from the layout.See also
See also
-
render
(self, context: QgsLayoutItemRenderContext, renderExtent: QRectF, frameIndex: int)¶ Renders a portion of the multiframe’s content into a render
context
.Parameters: - context – destination render painter
- renderExtent – visible extent of content to render into the painter.
- frameIndex – frame number for content
-
resizeMode
(self) → QgsLayoutMultiFrame.ResizeMode¶ Returns the resize mode for the multiframe.
See also
-
sender
()¶
-
senderSignalIndex
()¶
-
setResizeMode
(self, mode: QgsLayoutMultiFrame.ResizeMode)¶ Sets the resize
mode
for the multiframe, and recalculates frame sizes to match.See also
-
timerEvent
()¶
-
totalSize
(self) → QSizeF¶ Returns the total size of the multiframe’s content, in layout units.
-
type
(self) → int¶ Returns unique multiframe type id.
-
update
(self)¶ Forces a redraw of all child frames.
-
uuid
(self) → str¶ Returns the multiframe identification string. This is a unique random string set for the multiframe upon creation.
Note
There is no corresponding setter for the uuid - it’s created automatically.
-
writeObjectPropertiesToElement
()¶
-
writePropertiesToElement
(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool¶ Stores multiframe state within an XML DOM element.
Parameters: - element – is the DOM element to store the multiframe’s properties in
- document – DOM document
- context – read write context
See also
See also
-
writeXml
(self, parentElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext, includeFrames: bool = False) → bool¶ Stores the multiframe state in a DOM element.
Parameters: - parentElement – parent DOM element (e.g. ‘Layout’ element)
- document – DOM document
- context – read write context
- includeFrames – set to true to write state information about child frames into DOM
See also
-