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
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
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
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 ActionStart(value)¶
Bases:
enum.IntEnum
Enum to determine when an operation would begin
New in version 3.22.
DownloadLater
: Do not start immediately the actionDownloadImmediately
: Action will start immediately
- baseClass¶
alias of
qgis._core.Qgis
- class AnnotationItemEditOperationResult(value)¶
Bases:
enum.IntEnum
Results from an edit operation on an annotation item.
New in version 3.22.
Success
: Item was modified successfullyInvalid
: Operation has invalid parameters for the item, no change occurredItemCleared
: The operation results in the item being cleared, and the item should be removed from the layer as a result
- Invalid = 1¶
- ItemCleared = 2¶
- Success = 0¶
- baseClass¶
alias of
qgis._core.Qgis
- class AnnotationItemFlag(value)¶
Bases:
enum.IntEnum
Flags for annotation items.
New in version 3.22.
ScaleDependentBoundingBox
: Item’s bounding box will vary depending on map scale
- ScaleDependentBoundingBox = 1¶
- baseClass¶
alias of
qgis._core.Qgis
- class AnnotationItemFlags¶
- class AnnotationItemFlags(Union[Qgis.AnnotationItemFlags, Qgis.AnnotationItemFlag]) None
- class AnnotationItemFlags(Qgis.AnnotationItemFlags) None
Bases:
sip.wrapper
- class AnnotationItemGuiFlag(value)¶
Bases:
enum.IntEnum
Flags for controlling how an annotation item behaves in the GUI.
New in version 3.22.
FlagNoCreationTools
: Do not show item creation tools for the item type
- FlagNoCreationTools = 1¶
- baseClass¶
alias of
qgis._core.Qgis
- class AnnotationItemGuiFlags¶
- class AnnotationItemGuiFlags(Union[Qgis.AnnotationItemGuiFlags, Qgis.AnnotationItemGuiFlag]) None
- class AnnotationItemGuiFlags(Qgis.AnnotationItemGuiFlags) None
Bases:
sip.wrapper
- class AnnotationItemNodeType(value)¶
Bases:
enum.IntEnum
Annotation item node types.
New in version 3.22.
VertexHandle
: Node is a handle for manipulating vertices
- VertexHandle = 0¶
- baseClass¶
alias of
qgis._core.Qgis
- class BabelCommandFlag(value)¶
Bases:
enum.IntEnum
Babel command flags, which control how commands and arguments are generated for executing GPSBabel processes.
New in version 3.22.
QuoteFilePaths
: File paths should be enclosed in quotations and escaped
- QuoteFilePaths = 1¶
- baseClass¶
alias of
qgis._core.Qgis
- class BabelCommandFlags¶
- class BabelCommandFlags(Union[Qgis.BabelCommandFlags, Qgis.BabelCommandFlag]) None
- class BabelCommandFlags(Qgis.BabelCommandFlags) None
Bases:
sip.wrapper
- class BabelFormatCapabilities¶
- class BabelFormatCapabilities(Union[Qgis.BabelFormatCapabilities, Qgis.BabelFormatCapability]) None
- class BabelFormatCapabilities(Qgis.BabelFormatCapabilities) None
Bases:
sip.wrapper
- class BabelFormatCapability(value)¶
Bases:
enum.IntEnum
Babel GPS format capabilities.
New in version 3.22.
Import
: Format supports importingExport
: Format supports exportingWaypoints
: Format supports waypointsRoutes
: Format supports routesTracks
: Format supports tracks
- Export = 2¶
- Import = 1¶
- Routes = 8¶
- Tracks = 16¶
- Waypoints = 4¶
- baseClass¶
alias of
qgis._core.Qgis
- 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 deletedItemRepresentsFile
: Item’s path() directly represents a file on disk (since QGIS 3.22)
- 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
- class BufferSide(value)¶
Bases:
enum.IntEnum
Side of line to buffer.
New in version 3.22.
SideLeft
: Buffer to left of lineSideRight
: Buffer to right of line
- baseClass¶
alias of
qgis._core.Qgis
- class ContentStatus(value)¶
Bases:
enum.IntEnum
Status for fetched or stored content
New in version 3.22.
NotStarted
: Content fetching/storing has not started yetRunning
: Content fetching/storing is in progressFinished
: Content fetching/storing is finished and successfulFailed
: Content fetching/storing has failedCanceled
: Content fetching/storing has been canceled
- Canceled = 4¶
- Failed = 3¶
- Finished = 2¶
- NotStarted = 0¶
- Running = 1¶
- 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 EndCapStyle(value)¶
Bases:
enum.IntEnum
End cap styles for buffers.
New in version 3.22.
CapRound
: Round capCapFlat
: Flat cap (in line with start/end of line)CapSquare
: Square cap (extends past start/end of line by buffer distance)
- 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
- class FileOperationFlag(value)¶
Bases:
enum.IntEnum
File operation flags.
New in version 3.22.
IncludeMetadataFile
: Indicates that any associated .qmd metadata file should be included with the operationIncludeStyleFile
: Indicates that any associated .qml styling file should be included with the operation
- IncludeMetadataFile = 1¶
- IncludeStyleFile = 2¶
- baseClass¶
alias of
qgis._core.Qgis
- class FileOperationFlags¶
- class FileOperationFlags(Union[Qgis.FileOperationFlags, Qgis.FileOperationFlag]) None
- class FileOperationFlags(Qgis.FileOperationFlags) None
Bases:
sip.wrapper
- class FilePathType(value)¶
Bases:
enum.IntEnum
File path types.
New in version 3.22.
Absolute
: Absolute pathRelative
: Relative path
- Absolute = 0¶
- Relative = 1¶
- baseClass¶
alias of
qgis._core.Qgis
- class GeometryOperationResult(value)¶
Bases:
enum.IntEnum
Split features */
Success
: Operation succeededNothingHappened
: Nothing happened, without any errorInvalidBaseGeometry
: The base geometry on which the operation is done is invalid or emptyInvalidInputGeometryType
: The input geometry (ring, part, split line, etc.) has not the correct geometry typeSelectionIsEmpty
: No features were selectedSelectionIsGreaterThanOne
: More than one features were selectedGeometryEngineError
: Geometry engine misses a method implemented or an error occurred in the geometry engineLayerNotEditable
: Cannot edit layerAddPartSelectedGeometryNotFound
: The selected geometry cannot be foundAddPartNotMultiGeometry
: The source geometry is not multiAddRingNotClosed
: The input ring is not closedAddRingNotValid
: The input ring is not validAddRingCrossesExistingRings
: The input ring crosses existing rings (it is not disjoint)AddRingNotInExistingFeature
: The input ring doesn’t have any existing ring to fit intoSplitCannotSplitPoint
: Cannot split points
- baseClass¶
alias of
qgis._core.Qgis
- class GeometryValidationEngine(value)¶
Bases:
enum.IntEnum
Available engines for validating geometries.
New in version 3.22.
ValidatorQgisInternal
: Use internalQgsGeometryValidator
methodValidatorGeos
: Use GEOS validation methods
- baseClass¶
alias of
qgis._core.Qgis
- class GeometryValidityFlag(value)¶
Bases:
enum.IntEnum
Geometry validity check flags.
New in version 3.22.
FlagAllowSelfTouchingHoles
: Indicates that self-touching holes are permitted. OGC validity states that self-touching holes are NOT permitted, whilst other vendor validity checks (e.g. ESRI) permit self-touching holes.
- baseClass¶
alias of
qgis._core.Qgis
- class GeometryValidityFlags¶
- class GeometryValidityFlags(Union[Qgis.GeometryValidityFlags, Qgis.GeometryValidityFlag]) None
- class GeometryValidityFlags(Qgis.GeometryValidityFlags) None
Bases:
sip.wrapper
- class GpsFeatureType(value)¶
Bases:
enum.IntEnum
GPS feature types.
New in version 3.22.
Waypoint
: WaypointRoute
: RouteTrack
: Track
- Route = 1¶
- Track = 2¶
- Waypoint = 0¶
- baseClass¶
alias of
qgis._core.Qgis
- class GpsQualityIndicator(value)¶
Bases:
enum.IntEnum
GPS signal quality indicator
New in version 3.22.6.
Unknown
: UnknownInvalid
: InvalidGPS
: StandaloneDGPS
: Differential GPSPPS
: PPSRTK
: Real-time-kynematicFloatRTK
: Float real-time-kynematicEstimated
: EstimatedManual
: Manual input modeSimulation
: Simulation mode
- DGPS = 2¶
- Estimated = 6¶
- FloatRTK = 5¶
- GPS = 1¶
- Invalid = 0¶
- Manual = 7¶
- PPS = 3¶
- RTK = 4¶
- Simulation = 8¶
- Unknown = -1¶
- baseClass¶
alias of
qgis._core.Qgis
- class HttpMethod(value)¶
Bases:
enum.IntEnum
Different methods of HTTP requests
New in version 3.22.
Get
: GET methodPost
: POST method
- Get = 0¶
- Post = 1¶
- baseClass¶
alias of
qgis._core.Qgis
- Info = 0¶
- class JoinStyle(value)¶
Bases:
enum.IntEnum
Join styles for buffers.
New in version 3.22.
JoinStyleRound
: Use rounded joinsJoinStyleMiter
: Use mitered joinsJoinStyleBevel
: Use beveled joins
- baseClass¶
alias of
qgis._core.Qgis
- class MapLayerProperties¶
- class MapLayerProperties(Union[Qgis.MapLayerProperties, Qgis.MapLayerProperty]) None
- class MapLayerProperties(Qgis.MapLayerProperties) None
Bases:
sip.wrapper
- class MapLayerProperty(value)¶
Bases:
enum.IntEnum
Generic map layer properties.
New in version 3.22.
UsersCannotToggleEditing
: Indicates that users are not allowed to toggle editing for this layer. Note that this does not imply that the layer is non-editable (see isEditable(), supportsEditing() ), rather that the editable status of the layer cannot be changed by users manually. Since QGIS 3.22.
- UsersCannotToggleEditing = 1¶
- baseClass¶
alias of
qgis._core.Qgis
- class MapSettingsFlag(value)¶
Bases:
enum.IntEnum
Flags which adjust the way maps are rendered.
New in version 3.22.
Antialiasing
: Enable anti-aliasing for map renderingDrawEditingInfo
: Enable drawing of vertex markers for layers in editing modeForceVectorOutput
: Vector graphics should not be cached and drawn as raster imagesUseAdvancedEffects
: Enable layer opacity and blending effectsDrawLabeling
: Enable drawing of labels on top of the mapUseRenderingOptimization
: Enable vector simplification and other rendering optimizationsDrawSelection
: Whether vector selections should be shown in the rendered mapDrawSymbolBounds
: Draw bounds of symbols (for debugging/testing)RenderMapTile
: Draw map such that there are no problems between adjacent tilesRenderPartialOutput
: Whether to make extra effort to update map image with partially rendered layers (better for interactive map canvas). Added in QGIS 3.0RenderPreviewJob
: Render is a ‘canvas preview’ render, and shortcuts should be taken to ensure fast renderingRenderBlocking
: Render and load remote sources in the same thread to ensure rendering remote sources (svg and images). WARNING: this flag must NEVER be used from GUI based applications (like the main QGIS application) or crashes will result. Only for use in external scripts or QGIS server.LosslessImageRendering
: Render images losslessly whenever possible, instead of the default lossy jpeg rendering used for some destination devices (e.g. PDF). This flag only works with builds based on Qt 5.13 or later.Render3DMap
: Render is for a 3D map
- baseClass¶
alias of
qgis._core.Qgis
- class MapSettingsFlags¶
- class MapSettingsFlags(Union[Qgis.MapSettingsFlags, Qgis.MapSettingsFlag]) None
- class MapSettingsFlags(Qgis.MapSettingsFlags) None
Bases:
sip.wrapper
- class MeshEditingErrorType(value)¶
Bases:
enum.IntEnum
Type of error that can occur during mesh frame editing.
New in version 3.22.
NoError
: No typeInvalidFace
: An error occurs due to an invalid face (for example, vertex indexes are unordered)TooManyVerticesInFace
: A face has more vertices than the maximum number supported per faceFlatFace
: A flat face is presentUniqueSharedVertex
: A least two faces share only one verticesInvalidVertex
: An error occurs due to an invalid vertex (for example, vertex index is out of range the available vertex)ManifoldFace
: ManifoldFace
- FlatFace = 3¶
- InvalidFace = 1¶
- InvalidVertex = 5¶
- ManifoldFace = 6¶
- NoError = 0¶
- TooManyVerticesInFace = 2¶
- baseClass¶
alias of
qgis._core.Qgis
- 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 = 'Białowieża'¶
- QGIS_VERSION = '3.22.7-Białowieża'¶
- QGIS_VERSION_INT = 32207¶
- class RasterPipeInterfaceRole(value)¶
Bases:
enum.IntEnum
Raster pipe interface roles.
New in version 3.22.
UnknownRole
: Unknown roleProviderRole
: Data provider roleRendererRole
: Raster renderer roleBrightnessRole
: Brightness filter roleResamplerRole
: Resampler roleProjectorRole
: Projector roleNullerRole
: Raster nuller roleHueSaturationRole
: Hue/saturation filter role (also applies grayscale/color inversion)
- baseClass¶
alias of
qgis._core.Qgis
- class RasterResamplingStage(value)¶
Bases:
enum.IntEnum
Stage at which raster resampling occurs.
New in version 3.22.
ResampleFilter
:Provider
:
- baseClass¶
alias of
qgis._core.Qgis
- class RasterTemporalMode(value)¶
Bases:
enum.IntEnum
Raster layer temporal modes
New in version 3.22.
ModeFixedTemporalRange
: Mode when temporal properties have fixed start and end datetimes.ModeTemporalRangeFromDataProvider
: Mode when raster layer delegates temporal range handling to the dataprovider.ModeRedrawLayerOnly
: Redraw the layer when temporal range changes, but don’t apply any filtering. Useful when raster symbology expressions depend on the time range. (since QGIS 3.22)
- baseClass¶
alias of
qgis._core.Qgis
- class RenderContextFlag(value)¶
Bases:
enum.IntEnum
Flags which affect rendering operations.
New in version 3.22.
DrawEditingInfo
: Enable drawing of vertex markers for layers in editing modeForceVectorOutput
: Vector graphics should not be cached and drawn as raster imagesUseAdvancedEffects
: Enable layer opacity and blending effectsUseRenderingOptimization
: Enable vector simplification and other rendering optimizationsDrawSelection
: Whether vector selections should be shown in the rendered mapDrawSymbolBounds
: Draw bounds of symbols (for debugging/testing)RenderMapTile
: Draw map such that there are no problems between adjacent tilesAntialiasing
: Use antialiasing while drawingRenderPartialOutput
: Whether to make extra effort to update map image with partially rendered layers (better for interactive map canvas). Added in QGIS 3.0RenderPreviewJob
: Render is a ‘canvas preview’ render, and shortcuts should be taken to ensure fast renderingRenderBlocking
: Render and load remote sources in the same thread to ensure rendering remote sources (svg and images). WARNING: this flag must NEVER be used from GUI based applications (like the main QGIS application) or crashes will result. Only for use in external scripts or QGIS server.RenderSymbolPreview
: The render is for a symbol preview only and map based properties may not be available, so care should be taken to handle map unit based sizes in an appropriate way.LosslessImageRendering
: Render images losslessly whenever possible, instead of the default lossy jpeg rendering used for some destination devices (e.g. PDF). This flag only works with builds based on Qt 5.13 or later.ApplyScalingWorkaroundForTextRendering
: Whether a scaling workaround designed to stablise the rendering of small font sizes (or for painters scaled out by a large amount) when rendering text. Generally this is recommended, but it may incur some performance cost.Render3DMap
: Render is for a 3D mapApplyClipAfterReprojection
: Feature geometry clipping to mapExtent() must be performed after the geometries are transformed using coordinateTransform(). Usually feature geometry clipping occurs using the extent() in the layer’s CRS prior to geometry transformation, but in some cases when extent() could not be accurately calculated it is necessary to clip geometries to mapExtent() AFTER transforming them using coordinateTransform().RenderingSubSymbol
: Set whenever a sub-symbol of a parent symbol is currently being rendered. Can be used during symbol and symbol layer rendering to determine whether the symbol being rendered is a subsymbol. (Since QGIS 3.24)
- baseClass¶
alias of
qgis._core.Qgis
- class RenderContextFlags¶
- class RenderContextFlags(Union[Qgis.RenderContextFlags, Qgis.RenderContextFlag]) None
- class RenderContextFlags(Qgis.RenderContextFlags) None
Bases:
sip.wrapper
- class RenderSubcomponentProperty(value)¶
Bases:
enum.IntEnum
Rendering subcomponent properties.
New in version 3.22.
Generic
: Generic subcomponent propertyShadowOffset
: Shadow offsetBlurSize
: Blur sizeGlowSpread
: Glow spread size
- BlurSize = 2¶
- Generic = 0¶
- GlowSpread = 3¶
- ShadowOffset = 1¶
- baseClass¶
alias of
qgis._core.Qgis
- 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
- class SelectBehavior(value)¶
Bases:
enum.IntEnum
Specifies how a selection should be applied.
New in version 3.22.
SetSelection
: Set selection, removing any existing selectionAddToSelection
: Add selection to current selectionIntersectSelection
: Modify current selection to include only select features which matchRemoveFromSelection
: Remove from current selection
- baseClass¶
alias of
qgis._core.Qgis
- class SpatialFilterType(value)¶
Bases:
enum.IntEnum
Feature request spatial filter types.
New in version 3.22.
NoFilter
: No spatial filtering of featuresBoundingBox
: Filter using a bounding boxDistanceWithin
: Filter by distance to reference geometry
- BoundingBox = 1¶
- DistanceWithin = 2¶
- NoFilter = 0¶
- baseClass¶
alias of
qgis._core.Qgis
- class SqlKeywordCategory(value)¶
Bases:
enum.IntEnum
SqlKeywordCategory enum represents the categories of the SQL keywords used by the SQL query editor.
Note
The category has currently no usage, but it was planned for future uses.
New in version 3.22.
Keyword
: SQL keywordConstant
: SQL constantFunction
: SQL generic functionGeospatial
: SQL spatial functionOperator
: SQL operatorMath
: SQL math functionAggregate
: SQL aggregate functionString
: SQL string functionIdentifier
: SQL identifier
- Aggregate = 6¶
- Constant = 1¶
- Function = 2¶
- Geospatial = 3¶
- Identifier = 8¶
- Keyword = 0¶
- Math = 5¶
- Operator = 4¶
- String = 7¶
- baseClass¶
alias of
qgis._core.Qgis
- class SqlLayerDefinitionCapabilities¶
- class SqlLayerDefinitionCapabilities(Union[Qgis.SqlLayerDefinitionCapabilities, Qgis.SqlLayerDefinitionCapability]) None
- class SqlLayerDefinitionCapabilities(Qgis.SqlLayerDefinitionCapabilities) None
Bases:
sip.wrapper
- class SqlLayerDefinitionCapability(value)¶
Bases:
enum.IntEnum
SqlLayerDefinitionCapability enum lists the arguments supported by the provider when creating SQL query layers.
New in version 3.22.
SubsetStringFilter
: SQL layer definition supports subset string filterGeometryColumn
: SQL layer definition supports geometry columnPrimaryKeys
: SQL layer definition supports primary keysUnstableFeatureIds
: SQL layer definition supports disabling select at id
- GeometryColumn = 4¶
- PrimaryKeys = 8¶
- SubsetStringFilter = 2¶
- UnstableFeatureIds = 16¶
- baseClass¶
alias of
qgis._core.Qgis
- class SublayerFlag(value)¶
Bases:
enum.IntEnum
Flags which reflect the properties of sublayers in a dataset.
New in version 3.22.
SystemTable
: Sublayer is a system or internal table, which should be hidden by default
- SystemTable = 1¶
- baseClass¶
alias of
qgis._core.Qgis
- class SublayerFlags¶
- class SublayerFlags(Union[Qgis.SublayerFlags, Qgis.SublayerFlag]) None
- class SublayerFlags(Qgis.SublayerFlags) None
Bases:
sip.wrapper
- class SublayerPromptMode(value)¶
Bases:
enum.IntEnum
Specifies how to handle layer sources with multiple sublayers.
New in version 3.22.
AlwaysAsk
: Always ask users to select from available sublayers, if sublayers are presentAskExcludingRasterBands
: Ask users to select from available sublayers, unless only raster bands are presentNeverAskSkip
: Never ask users to select sublayers, instead don’t load anythingNeverAskLoadAll
: Never ask users to select sublayers, instead automatically load all available sublayers
- AlwaysAsk = 0¶
- AskExcludingRasterBands = 1¶
- NeverAskLoadAll = 3¶
- NeverAskSkip = 2¶
- baseClass¶
alias of
qgis._core.Qgis
- class SublayerQueryFlag(value)¶
Bases:
enum.IntEnum
Flags which control how data providers will scan for sublayers in a dataset.
New in version 3.22.
FastScan
: Indicates that the provider must scan for sublayers using the fastest possible approach – e.g. by first checking that a uri has an extension which is known to be readable by the providerResolveGeometryType
: Attempt to resolve the geometry type for vector sublayersCountFeatures
: Count features in vector sublayersIncludeSystemTables
: Include system or internal tables (these are not included by default)
- CountFeatures = 4¶
- FastScan = 1¶
- IncludeSystemTables = 8¶
- ResolveGeometryType = 2¶
- baseClass¶
alias of
qgis._core.Qgis
- class SublayerQueryFlags¶
- class SublayerQueryFlags(Union[Qgis.SublayerQueryFlags, Qgis.SublayerQueryFlag]) None
- class SublayerQueryFlags(Qgis.SublayerQueryFlags) None
Bases:
sip.wrapper
- 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 SymbolLayerFlag(value)¶
Bases:
enum.IntEnum
Flags controlling behavior of symbol layers
New in version 3.22.
DisableFeatureClipping
: If present, indicates that features should never be clipped to the map extent during rendering
- DisableFeatureClipping = 1¶
- baseClass¶
alias of
qgis._core.Qgis
- class SymbolLayerFlags¶
- class SymbolLayerFlags(Union[Qgis.SymbolLayerFlags, Qgis.SymbolLayerFlag]) None
- class SymbolLayerFlags(Qgis.SymbolLayerFlags) 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
- class TemporalIntervalMatchMethod(value)¶
Bases:
enum.IntEnum
Method to use when resolving a temporal range to a data provider layer or band.
New in version 3.22.
MatchUsingWholeRange
: Use an exact match to the whole temporal rangeMatchExactUsingStartOfRange
: Match the start of the temporal range to a corresponding layer or band, and only use exact matching resultsMatchExactUsingEndOfRange
: Match the end of the temporal range to a corresponding layer or band, and only use exact matching resultsFindClosestMatchToStartOfRange
: Match the start of the temporal range to the least previous closest datetime.FindClosestMatchToEndOfRange
: Match the end of the temporal range to the least previous closest datetime.
- baseClass¶
alias of
qgis._core.Qgis
- class TextRenderFormat(value)¶
Bases:
enum.IntEnum
Options for rendering text.
New in version 3.22.
TextFormatAlwaysOutlines
: Always render text using path objects (AKA outlines/curves). This setting guarantees the best quality rendering, even when using a raster paint surface (where sub-pixel path based text rendering is superior to sub-pixel text-based rendering). The downside is that text is converted to paths only, so users cannot open created vector outputs for post-processing in other applications and retain text editability. This setting also guarantees complete compatibility with the full range of formatting options available throughQgsTextRenderer
andQgsTextFormat
, some of which may not be possible to reproduce when using a vector-based paint surface and TextFormatAlwaysText mode. A final benefit to this setting is that vector exports created using text as outlines do not require all users to have the original fonts installed in order to display the text in its original style.TextFormatAlwaysText
: Always render text as text objects. While this mode preserves text objects as text for post-processing in external vector editing applications, it can result in rendering artifacts or poor quality rendering, depending on the text format settings. Even with raster based paint devices, TextFormatAlwaysText can result in inferior rendering quality to TextFormatAlwaysOutlines. When rendering using TextFormatAlwaysText to a vector based device (e.g. PDF or SVG), care must be taken to ensure that the required fonts are available to users when opening the created files, or default fallback fonts will be used to display the output instead. (Although PDF exports MAY automatically embed some fonts when possible, depending on the user’s platform).
- baseClass¶
alias of
qgis._core.Qgis
- class TransformDirection(value)¶
Bases:
enum.IntEnum
Indicates the direction (forward or inverse) of a transform.
New in version 3.22.
ForwardTransform
: Forward transform (from source to destination)ReverseTransform
: Reverse/inverse transform (from destination to source)
- 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 VectorDataProviderTemporalMode(value)¶
Bases:
enum.IntEnum
Vector data provider temporal handling modes.
New in version 3.22.
ProviderHasFixedTemporalRange
: Entire dataset from provider has a fixed start and end datetime.ProviderStoresFeatureDateTimeInstantInField
: Dataset has feature datetime instants stored in a single fieldProviderStoresFeatureDateTimeStartAndEndInSeparateFields
: Dataset stores feature start and end datetimes in separate fields
- baseClass¶
alias of
qgis._core.Qgis
- class VectorEditResult(value)¶
Bases:
enum.IntEnum
Specifies the result of a vector layer edit operation
New in version 3.22.
Success
: Edit operation was successfulEmptyGeometry
: Edit operation resulted in an empty geometryEditFailed
: Edit operation failedFetchFeatureFailed
: Unable to fetch requested featureInvalidLayer
: Edit failed due to invalid layer
- 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
- class VectorTemporalLimitMode(value)¶
Bases:
enum.IntEnum
Mode for the handling of the limits of the filtering timeframe for vector features
New in version 3.22.
IncludeBeginExcludeEnd
: Default mode: include the Begin limit, but exclude the End limitIncludeBeginIncludeEnd
: Mode to include both limits of the filtering timeframe
- IncludeBeginExcludeEnd = 0¶
- IncludeBeginIncludeEnd = 1¶
- baseClass¶
alias of
qgis._core.Qgis
- class VectorTemporalMode(value)¶
Bases:
enum.IntEnum
Vector layer temporal feature modes
New in version 3.22.
ModeFixedTemporalRange
: Mode when temporal properties have fixed start and end datetimes.ModeFeatureDateTimeInstantFromField
: Mode when features have a datetime instant taken from a single fieldModeFeatureDateTimeStartAndEndFromFields
: Mode when features have separate fields for start and end timesModeFeatureDateTimeStartAndDurationFromFields
: Mode when features have a field for start time and a field for event durationModeFeatureDateTimeStartAndEndFromExpressions
: Mode when features use expressions for start and end timesModeRedrawLayerOnly
: Redraw the layer when temporal range changes, but don’t apply any filtering. Useful when symbology or rule based renderer expressions depend on the time range.
- baseClass¶
alias of
qgis._core.Qgis
- class VertexMarkerType(value)¶
Bases:
enum.IntEnum
Editing vertex markers, used for showing vertices during a edit operation.
New in version 3.22.
SemiTransparentCircle
: Semi-transparent circle markerCross
: Cross markerNoMarker
: No marker
- baseClass¶
alias of
qgis._core.Qgis
- class VertexType(value)¶
Bases:
enum.IntEnum
Types of vertex.
New in version 3.22.
SegmentVertex
: The actual start or end point of a segmentCurveVertex
: An intermediate point on a segment defining the curvature of the segment
- 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