Class: QgsProjectDisplaySettings¶
- class qgis.core.QgsProjectDisplaySettings¶
Bases:
PyQt5.QtCore.QObject
Contains settings and properties relating to how a
QgsProject
should display values such as map coordinates and bearings.New in version 3.12.
QgsProjectDisplaySettings(parent: QObject = None) Constructor for
QgsProjectDisplaySettings
with the specifiedparent
object.Methods
Returns the project bearing's format, which controls how bearings associated with the project are displayed.
Returns default coordinate axis order to use when displaying coordinates for the project.
Returns the coordinate display CRS used derived from the coordinate type.
Returns the coordinate custom CRS used when the project coordinate type is set to Qgis.CoordinateDisplayType.CustomCrs.
Returns default coordinate type for the project.
Returns the project's geographic coordinate format, which controls how geographic coordinates associated with the project are displayed.
Reads the settings's state from a DOM element.
Resets the settings to a default state.
Sets the project bearing
format
, which controls how bearings associated with the project are displayed.Sets the default coordinate axis
order
to use when displaying coordinates for the project.Sets the coordinate custom CRS used when the project coordinate type is set to Qgis.CoordinateDisplayType.CustomCrs.
Sets the default coordinate
type
for the project.Sets the project geographic coordinate
format
, which controls how geographic coordinates associated with the project are displayed.Returns a DOM element representing the settings.
Signals
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
- bearingFormat(self) QgsBearingNumericFormat ¶
Returns the project bearing’s format, which controls how bearings associated with the project are displayed.
See also
See also
- Return type:
- bearingFormatChanged¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- childEvent(self, QChildEvent)¶
- connectNotify(self, QMetaMethod)¶
- coordinateAxisOrder(self) Qgis.CoordinateOrder ¶
Returns default coordinate axis order to use when displaying coordinates for the project.
See also
See also
New in version 3.28.
- Return type:
- coordinateAxisOrderChanged¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- coordinateCrs(self) QgsCoordinateReferenceSystem ¶
Returns the coordinate display CRS used derived from the coordinate type.
See also
Note
if not parented to a project object, an invalid CRS will be returned.
New in version 3.28.
- Return type:
- coordinateCrsChanged¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- coordinateCustomCrs(self) QgsCoordinateReferenceSystem ¶
Returns the coordinate custom CRS used when the project coordinate type is set to Qgis.CoordinateDisplayType.CustomCrs.
See also
New in version 3.28.
- Return type:
- coordinateCustomCrsChanged¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- coordinateType(self) Qgis.CoordinateDisplayType ¶
Returns default coordinate type for the project.
See also
New in version 3.28.
- Return type:
- coordinateTypeChanged¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- customEvent(self, QEvent)¶
- disconnectNotify(self, QMetaMethod)¶
- geographicCoordinateFormat(self) QgsGeographicCoordinateNumericFormat ¶
Returns the project’s geographic coordinate format, which controls how geographic coordinates associated with the project are displayed.
See also
See also
- Return type:
- geographicCoordinateFormatChanged¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- isSignalConnected(self, QMetaMethod) bool ¶
- readXml(self, element: QDomElement, context: QgsReadWriteContext) bool ¶
Reads the settings’s state from a DOM element.
See also
- Parameters:
element (QDomElement) –
context (QgsReadWriteContext) –
- Return type:
bool
- receivers(self, PYQT_SIGNAL) int ¶
- reset(self)¶
Resets the settings to a default state.
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setBearingFormat(self, format: QgsBearingNumericFormat)¶
Sets the project bearing
format
, which controls how bearings associated with the project are displayed.Ownership of
format
is transferred to the settings.See also
See also
- Parameters:
format (QgsBearingNumericFormat) –
- setCoordinateAxisOrder(self, order: Qgis.CoordinateOrder)¶
Sets the default coordinate axis
order
to use when displaying coordinates for the project.See also
See also
New in version 3.28.
- Parameters:
order (Qgis.CoordinateOrder) –
- setCoordinateCustomCrs(self, crs: QgsCoordinateReferenceSystem)¶
Sets the coordinate custom CRS used when the project coordinate type is set to Qgis.CoordinateDisplayType.CustomCrs.
See also
New in version 3.28.
- Parameters:
crs (QgsCoordinateReferenceSystem) –
- setCoordinateType(self, type: Qgis.CoordinateDisplayType)¶
Sets the default coordinate
type
for the project.See also
New in version 3.28.
- Parameters:
type (Qgis.CoordinateDisplayType) –
- setGeographicCoordinateFormat(self, format: QgsGeographicCoordinateNumericFormat)¶
Sets the project geographic coordinate
format
, which controls how geographic coordinates associated with the project are displayed.Ownership of
format
is transferred to the settings.See also
See also
New in version 3.26.
- Parameters:
format (QgsGeographicCoordinateNumericFormat) –
- timerEvent(self, QTimerEvent)¶
- writeXml(self, doc: QDomDocument, context: QgsReadWriteContext) QDomElement ¶
Returns a DOM element representing the settings.
See also
- Parameters:
doc (QDomDocument) –
context (QgsReadWriteContext) –
- Return type:
QDomElement