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.

Added in version 3.12.

QgsProjectDisplaySettings(parent: Optional[QObject] = None) Constructor for QgsProjectDisplaySettings with the specified parent object.

Methods

bearingFormat

Returns the project bearing's format, which controls how bearings associated with the project are displayed.

childEvent

connectNotify

coordinateAxisOrder

Returns default coordinate axis order to use when displaying coordinates for the project.

coordinateCrs

Returns the coordinate display CRS used derived from the coordinate type.

coordinateCustomCrs

Returns the coordinate custom CRS used when the project coordinate type is set to Qgis.CoordinateDisplayType.CustomCrs.

coordinateType

Returns default coordinate type for the project.

customEvent

disconnectNotify

geographicCoordinateFormat

Returns the project's geographic coordinate format, which controls how geographic coordinates associated with the project are displayed.

isSignalConnected

readXml

Reads the settings's state from a DOM element.

receivers

reset

Resets the settings to a default state.

sender

senderSignalIndex

setBearingFormat

Sets the project bearing format, which controls how bearings associated with the project are displayed.

setCoordinateAxisOrder

Sets the default coordinate axis order to use when displaying coordinates for the project.

setCoordinateCustomCrs

Sets the coordinate custom CRS used when the project coordinate type is set to Qgis.CoordinateDisplayType.CustomCrs.

setCoordinateType

Sets the default coordinate type for the project.

setGeographicCoordinateFormat

Sets the project geographic coordinate format, which controls how geographic coordinates associated with the project are displayed.

timerEvent

writeXml

Returns a DOM element representing the settings.

Signals

bearingFormatChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

coordinateAxisOrderChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

coordinateCrsChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

coordinateCustomCrsChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

coordinateTypeChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

geographicCoordinateFormatChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

bearingFormat(self) QgsBearingNumericFormat | None

Returns the project bearing’s format, which controls how bearings associated with the project are displayed.

Return type:

Optional[QgsBearingNumericFormat]

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, a0: QChildEvent | None)
connectNotify(self, signal: QMetaMethod)
coordinateAxisOrder(self) Qgis.CoordinateOrder

Returns default coordinate axis order to use when displaying coordinates for the project.

Added in version 3.28.

Return type:

Qgis.CoordinateOrder

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

coordinateType()

Note

if not parented to a project object, an invalid CRS will be returned.

Added in version 3.28.

Return type:

QgsCoordinateReferenceSystem

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.

Added in version 3.28.

Return type:

QgsCoordinateReferenceSystem

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.

Added in version 3.28.

Return type:

Qgis.CoordinateDisplayType

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, a0: QEvent | None)
disconnectNotify(self, signal: QMetaMethod)
geographicCoordinateFormat(self) QgsGeographicCoordinateNumericFormat | None

Returns the project’s geographic coordinate format, which controls how geographic coordinates associated with the project are displayed.

Return type:

Optional[QgsGeographicCoordinateNumericFormat]

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, signal: QMetaMethod) bool
readXml(self, element: QDomElement, context: QgsReadWriteContext) bool

Reads the settings’s state from a DOM element.

See also

writeXml()

Parameters:
Return type:

bool

receivers(self, signal: PYQT_SIGNAL) int
reset(self)

Resets the settings to a default state.

sender(self) QObject | None
senderSignalIndex(self) int
setBearingFormat(self, format: QgsBearingNumericFormat | None)

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

bearingFormat()

Parameters:

format (Optional[QgsBearingNumericFormat])

setCoordinateAxisOrder(self, order: Qgis.CoordinateOrder)

Sets the default coordinate axis order to use when displaying coordinates for the project.

Added 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.

Added in version 3.28.

Parameters:

crs (QgsCoordinateReferenceSystem)

setCoordinateType(self, type: Qgis.CoordinateDisplayType)

Sets the default coordinate type for the project.

See also

coordinateType()

Added in version 3.28.

Parameters:

type (Qgis.CoordinateDisplayType)

setGeographicCoordinateFormat(self, format: QgsGeographicCoordinateNumericFormat | None)

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.

Added in version 3.26.

Parameters:

format (Optional[QgsGeographicCoordinateNumericFormat])

timerEvent(self, a0: QTimerEvent | None)
writeXml(self, doc: QDomDocument, context: QgsReadWriteContext) QDomElement

Returns a DOM element representing the settings.

See also

readXml()

Parameters:
Return type:

QDomElement