Class: QgsLayoutGuide¶
-
class
qgis.core.
QgsLayoutGuide
(orientation: Qt.Orientation, position: QgsLayoutMeasurement, page: QgsLayoutItemPage)¶ Bases:
PyQt5.QtCore.QObject
Constructor for a new guide with the specified
orientation
and initialposition
.A layout must be set by calling setLayout() before the guide can be used. Adding the guide to a QgsLayoutGuideCollection will automatically set the corresponding layout for you.
Contains the configuration for a single snap guide used by a layout.
New in version 3.0: Enums
Methods
Returns the guide’s line item.
Returns the layout the guide belongs to.
Returns the guide’s position in absolute layout units.
Returns the guide’s orientation.
Returns the page the guide is contained within.
Returns the guide’s position within the page.
Sets the
layout
the guide belongs to.Sets the guide’s
position
in absolute layout units.Sets the
page
the guide is contained within.Sets the guide’s
position
within the page.Updates the position of the guide’s line item.
Signals
Emitted when the guide’s position is changed.
Attributes
-
childEvent
()¶
-
connectNotify
()¶
-
customEvent
()¶
-
disconnectNotify
()¶
-
isSignalConnected
()¶
-
item
(self) → QGraphicsLineItem¶ Returns the guide’s line item.
-
layout
(self) → QgsLayout¶ Returns the layout the guide belongs to.
See also
-
layoutPosition
(self) → float¶ Returns the guide’s position in absolute layout units.
See also
-
orientation
(self) → Qt.Orientation¶ Returns the guide’s orientation.
-
position
(self) → QgsLayoutMeasurement¶ Returns the guide’s position within the page.
The position indicates either the horizontal or vertical position of the guide, depending on the guide’s orientation().
See also
-
positionChanged
¶ Emitted when the guide’s position is changed. [signal]
-
receivers
()¶
-
sender
()¶
-
senderSignalIndex
()¶
-
setLayout
(self, layout: QgsLayout)¶ Sets the
layout
the guide belongs to.Note
Adding the guide to a QgsLayoutGuideCollection will automatically set the corresponding layout for you.
See also
-
setLayoutPosition
(self, position: float)¶ Sets the guide’s
position
in absolute layout units.See also
-
setPage
(self, page: QgsLayoutItemPage)¶ Sets the
page
the guide is contained within.See also
-
setPosition
(self, position: QgsLayoutMeasurement)¶ Sets the guide’s
position
within the page.The
position
argument indicates either the horizontal or vertical position of the guide, depending on the guide’s orientation().See also
-
timerEvent
()¶
-
update
(self)¶ Updates the position of the guide’s line item.
-