Class: Qgis¶
- class qgis.core.Qgis¶
Bases:
sip.wrapper
The Qgis class provides global constants for use throughout the application.
Enums
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Methods
A string with default project scales.
The development version
GEOS string version linked
GEOS version number linked
GEOS Major version number linked
GEOS Minor version number linked
GEOS Patch version number linked
Release name
Version string.
Version number used for comparing versions using the "Check QGIS Version" function
Attributes
- class BrowserDirectoryMonitoring(value)¶
Bases:
enum.IntEnum
Browser directory item monitoring switches.
New in version 3.20.
Default
: Use default logic to determine whether directory should be monitoredNeverMonitor
: Never monitor the directory, regardless of the default logicAlwaysMonitor
: Always monitor the directory, regardless of the default logic
- AlwaysMonitor = 2¶
- Default = 0¶
- NeverMonitor = 1¶
- baseClass¶
alias of
qgis._core.Qgis
- class BrowserItemCapabilities¶
- class BrowserItemCapabilities(Union[Qgis.BrowserItemCapabilities, Qgis.BrowserItemCapability]) None
- class BrowserItemCapabilities(Qgis.BrowserItemCapabilities) None
Bases:
sip.wrapper
- class BrowserItemCapability(value)¶
Bases:
enum.IntEnum
Browser item capabilities.
New in version 3.20.
NoCapabilities
: Item has no capabilitiesSetCrs
: Can set CRS on layer or group of layers. deprecated since QGIS 3.6 – no longer used by QGIS and will be removed in QGIS 4.0Fertile
: Can create children. Even items without this capability may have children, but cannot create them, it means that children are created by item ancestors.Fast
: CreateChildren() is fast enough to be run in main thread when refreshing items, most root items (wms,wfs,wcs,postgres…) are considered fast because they are reading data only from QgsSettingsCollapse
: The collapse/expand status for this items children should be ignored in order to avoid undesired network connections (wms etc.)Rename
: Item can be renamedDelete
: Item can be deleted
- baseClass¶
alias of
qgis._core.Qgis
- class BrowserItemState(value)¶
Bases:
enum.IntEnum
Browser item states.
New in version 3.20.
NotPopulated
: Children not yet createdPopulating
: Creating children in separate thread (populating or refreshing)Populated
: Children created
- baseClass¶
alias of
qgis._core.Qgis
- class BrowserItemType(value)¶
Bases:
enum.IntEnum
Browser item types.
New in version 3.20.
Collection
: A collection of itemsDirectory
: Represents a file directoryLayer
: Represents a map layerError
: Contains an error messageFavorites
: Represents a favorite itemProject
: Represents a QGIS projectCustom
: Custom item typeFields
: Collection of fieldsField
: Vector layer field
- baseClass¶
alias of
qgis._core.Qgis
- class BrowserLayerType(value)¶
Bases:
enum.IntEnum
Browser item layer types
New in version 3.20.
NoType
: No typeVector
: Generic vector layerRaster
: Raster layerPoint
: Vector point layerLine
: Vector line layerPolygon
: Vector polygon layerTableLayer
: Vector non-spatial layerDatabase
: Database layerTable
: Database tablePlugin
: Plugin based layerMesh
: Mesh layerVectorTile
: Vector tile layerPointCloud
: Point cloud layer
- baseClass¶
alias of
qgis._core.Qgis
- Critical = 2¶
- DEFAULT_HIGHLIGHT_BUFFER_MM = 0.5¶
- DEFAULT_HIGHLIGHT_COLOR = <PyQt5.QtGui.QColor object>¶
- DEFAULT_HIGHLIGHT_MIN_WIDTH_MM = 1.0¶
- DEFAULT_MAPTOPIXEL_THRESHOLD = 1.0¶
- DEFAULT_M_COORDINATE = 0.0¶
- DEFAULT_SEARCH_RADIUS_MM = 2.0¶
- DEFAULT_SNAP_TOLERANCE = 12.0¶
- DEFAULT_SNAP_UNITS = 1¶
- DEFAULT_Z_COORDINATE = 0.0¶
- class DataType(value)¶
Bases:
enum.IntEnum
Raster data types. This is modified and extended copy of GDALDataType.
UnknownDataType
: Unknown or unspecified typeByte
: Eight bit unsigned integer (quint8)UInt16
: Sixteen bit unsigned integer (quint16)Int16
: Sixteen bit signed integer (qint16)UInt32
: Thirty two bit unsigned integer (quint32)Int32
: Thirty two bit signed integer (qint32)Float32
: Thirty two bit floating point (float)Float64
: Sixty four bit floating point (double)CInt16
: Complex Int16CInt32
: Complex Int32CFloat32
: Complex Float32CFloat64
: Complex Float64ARGB32
: Color, alpha, red, green, blue, 4 bytes the same as QImage::Format_ARGB32ARGB32_Premultiplied
: Color, alpha, red, green, blue, 4 bytes the same as QImage::Format_ARGB32_Premultiplied
- baseClass¶
alias of
qgis._core.Qgis
- class DriveType(value)¶
Bases:
enum.IntEnum
Drive types
New in version 3.20.
Unknown
: Unknown typeInvalid
: Invalid pathRemovable
: Removable driveFixed
: Fixed driveRemote
: Remote driveCdRom
: CD-ROMRamDisk
: RAM disk
- CdRom = 5¶
- Fixed = 3¶
- Invalid = 1¶
- RamDisk = 6¶
- Remote = 4¶
- Removable = 2¶
- Unknown = 0¶
- baseClass¶
alias of
qgis._core.Qgis
- class FeatureCountState(value)¶
Bases:
enum.IntEnum
Enumeration of feature count states
New in version 3.20.
Uncounted
: Feature count not yet computedUnknownCount
: Provider returned an unknown feature count
- baseClass¶
alias of
qgis._core.Qgis
- Info = 0¶
- class MessageLevel¶
Bases:
int
- baseClass¶
alias of
qgis._core.Qgis
- NoLevel = 4¶
- class PythonMacroMode(value)¶
Bases:
enum.IntEnum
Authorisation to run Python Macros
New in version 3.10.
Never
: Macros are never runAsk
: User is prompt before runningSessionOnly
: Only during this sessionAlways
: Macros are always runNotForThisSession
: Macros will not be run for this session
- baseClass¶
alias of
qgis._core.Qgis
- QGIS_DEV_VERSION = 'exported'¶
- QGIS_RELEASE_NAME = 'Odense'¶
- QGIS_VERSION = '3.20.3-Odense'¶
- QGIS_VERSION_INT = 32003¶
- SCALE_PRECISION = 0.9999999999¶
- class ScaleMethod(value)¶
Bases:
enum.IntEnum
Scale methods
New in version 3.20.
ScaleArea
: Calculate scale by the areaScaleDiameter
: Calculate scale by the diameter
- baseClass¶
alias of
qgis._core.Qgis
- Success = 3¶
- class SymbolFlag(value)¶
Bases:
enum.IntEnum
Flags controlling behavior of symbols
New in version 3.20.
RendererShouldUseSymbolLevels
: If present, indicates that aQgsFeatureRenderer
using the symbol should use symbol levels for best results
- RendererShouldUseSymbolLevels = 1¶
- baseClass¶
alias of
qgis._core.Qgis
- class SymbolFlags¶
- class SymbolFlags(Union[Qgis.SymbolFlags, Qgis.SymbolFlag]) None
- class SymbolFlags(Qgis.SymbolFlags) None
Bases:
sip.wrapper
- class SymbolPreviewFlag(value)¶
Bases:
enum.IntEnum
Flags for controlling how symbol preview images are generated.
New in version 3.20.
FlagIncludeCrosshairsForMarkerSymbols
: Include a crosshairs reference image in the background of marker symbol previews
- baseClass¶
alias of
qgis._core.Qgis
- class SymbolPreviewFlags¶
- class SymbolPreviewFlags(Union[Qgis.SymbolPreviewFlags, Qgis.SymbolPreviewFlag]) None
- class SymbolPreviewFlags(Qgis.SymbolPreviewFlags) None
Bases:
sip.wrapper
- class SymbolRenderHint(value)¶
Bases:
enum.IntEnum
Flags controlling behavior of symbols during rendering
New in version 3.20.
DynamicRotation
: Rotation of symbol may be changed during rendering and symbol should not be cached
- baseClass¶
alias of
qgis._core.Qgis
- class SymbolRenderHints¶
- class SymbolRenderHints(Union[Qgis.SymbolRenderHints, Qgis.SymbolRenderHint]) None
- class SymbolRenderHints(Qgis.SymbolRenderHints) None
Bases:
sip.wrapper
- class SymbolType(value)¶
Bases:
enum.IntEnum
Symbol types
New in version 3.20.
Marker
: Marker symbolLine
: Line symbolFill
: Fill symbolHybrid
: Hybrid symbol
- baseClass¶
alias of
qgis._core.Qgis
- UI_SCALE_FACTOR = 1.0¶
- class UnplacedLabelVisibility(value)¶
Bases:
enum.IntEnum
Unplaced label visibility.
New in version 3.20.
FollowEngineSetting
: Respect the label engine settingNeverShow
: Never show unplaced labels, regardless of the engine setting
- FollowEngineSetting = 0¶
- NeverShow = 1¶
- baseClass¶
alias of
qgis._core.Qgis
- class VectorExportResult(value)¶
Bases:
enum.IntEnum
Vector layer export result codes.
New in version 3.20.
NoError
: No errors were encounteredErrCreateDataSource
: Could not create the destination data sourceErrCreateLayer
: Could not create destination layerErrAttributeTypeUnsupported
: Source layer has an attribute type which could not be handled by destinationErrAttributeCreationFailed
: Destination provider was unable to create an attributeErrProjection
: An error occurred while reprojecting features to destination CRSErrFeatureWriteFailed
: An error occurred while writing a feature to the destinationErrInvalidLayer
: Could not access newly created destination layerErrInvalidProvider
: Could not find a matching provider keyErrProviderUnsupportedFeature
: Provider does not support creation of empty layersErrConnectionFailed
: Could not connect to destinationErrUserCanceled
: User canceled the export
- baseClass¶
alias of
qgis._core.Qgis
- Warning = 1¶
- defaultProjectScales() str ¶
A string with default project scales.
New in version 3.12.
- Return type
str
- devVersion() str ¶
The development version
New in version 3.12.
- Return type
str
- geosVersion() str ¶
GEOS string version linked
New in version 3.20.
- Return type
str
- geosVersionInt() int ¶
GEOS version number linked
New in version 3.20.
- Return type
int
- geosVersionMajor() int ¶
GEOS Major version number linked
New in version 3.20.
- Return type
int
- geosVersionMinor() int ¶
GEOS Minor version number linked
New in version 3.20.
- Return type
int
- geosVersionPatch() int ¶
GEOS Patch version number linked
New in version 3.20.
- Return type
int
- releaseName() str ¶
Release name
New in version 3.12.
- Return type
str
- staticMetaObject = <PyQt5.QtCore.QMetaObject object>¶
- version() str ¶
Version string.
New in version 3.12.
- Return type
str
- versionInt() int ¶
Version number used for comparing versions using the “Check QGIS Version” function
New in version 3.12.
- Return type
int