Class: Qgis

class qgis.core.Qgis

Bases: sip.wrapper

The Qgis class provides global constants for use throughout the application.

Enums

ActionStart	Bases: enum.IntEnum
AnnotationItemEditOperationResult	Bases: enum.IntEnum
AnnotationItemFlag	Bases: enum.IntEnum
AnnotationItemGuiFlag	Bases: enum.IntEnum
AnnotationItemNodeType	Bases: enum.IntEnum
BabelCommandFlag	Bases: enum.IntEnum
BabelFormatCapability	Bases: enum.IntEnum
BrowserDirectoryMonitoring	Bases: enum.IntEnum
BrowserItemCapability	Bases: enum.IntEnum
BrowserItemState	Bases: enum.IntEnum
BrowserItemType	Bases: enum.IntEnum
BrowserLayerType	Bases: enum.IntEnum
BufferSide	Bases: enum.IntEnum
ContentStatus	Bases: enum.IntEnum
DataType	Bases: enum.IntEnum
DriveType	Bases: enum.IntEnum
EndCapStyle	Bases: enum.IntEnum
FeatureCountState	Bases: enum.IntEnum
FileOperationFlag	Bases: enum.IntEnum
FilePathType	Bases: enum.IntEnum
GeometryOperationResult	Bases: enum.IntEnum
GeometryValidationEngine	Bases: enum.IntEnum
GeometryValidityFlag	Bases: enum.IntEnum
GpsFeatureType	Bases: enum.IntEnum
GpsQualityIndicator	Bases: enum.IntEnum
HttpMethod	Bases: enum.IntEnum
JoinStyle	Bases: enum.IntEnum
MapLayerProperty	Bases: enum.IntEnum
MapSettingsFlag	Bases: enum.IntEnum
MeshEditingErrorType	Bases: enum.IntEnum
PythonMacroMode	Bases: enum.IntEnum
RasterPipeInterfaceRole	Bases: enum.IntEnum
RasterResamplingStage	Bases: enum.IntEnum
RasterTemporalMode	Bases: enum.IntEnum
RenderContextFlag	Bases: enum.IntEnum
RenderSubcomponentProperty	Bases: enum.IntEnum
ScaleMethod	Bases: enum.IntEnum
SelectBehavior	Bases: enum.IntEnum
SpatialFilterType	Bases: enum.IntEnum
SqlKeywordCategory	Bases: enum.IntEnum
SqlLayerDefinitionCapability	Bases: enum.IntEnum
SublayerFlag	Bases: enum.IntEnum
SublayerPromptMode	Bases: enum.IntEnum
SublayerQueryFlag	Bases: enum.IntEnum
SymbolFlag	Bases: enum.IntEnum
SymbolLayerFlag	Bases: enum.IntEnum
SymbolPreviewFlag	Bases: enum.IntEnum
SymbolRenderHint	Bases: enum.IntEnum
SymbolType	Bases: enum.IntEnum
TemporalIntervalMatchMethod	Bases: enum.IntEnum
TextRenderFormat	Bases: enum.IntEnum
TransformDirection	Bases: enum.IntEnum
UnplacedLabelVisibility	Bases: enum.IntEnum
VectorDataProviderTemporalMode	Bases: enum.IntEnum
VectorEditResult	Bases: enum.IntEnum
VectorExportResult	Bases: enum.IntEnum
VectorTemporalLimitMode	Bases: enum.IntEnum
VectorTemporalMode	Bases: enum.IntEnum
VertexMarkerType	Bases: enum.IntEnum
VertexType	Bases: enum.IntEnum

Methods

defaultProjectScales	A string with default project scales.
devVersion	The development version
geosVersion	GEOS string version linked
geosVersionInt	GEOS version number linked
geosVersionMajor	GEOS Major version number linked
geosVersionMinor	GEOS Minor version number linked
geosVersionPatch	GEOS Patch version number linked
releaseName	Release name
version	Version string.
versionInt	Version number used for comparing versions using the "Check QGIS Version" function

Attributes

Critical
DEFAULT_HIGHLIGHT_BUFFER_MM
DEFAULT_HIGHLIGHT_COLOR
DEFAULT_HIGHLIGHT_MIN_WIDTH_MM
DEFAULT_MAPTOPIXEL_THRESHOLD
DEFAULT_M_COORDINATE
DEFAULT_SEARCH_RADIUS_MM
DEFAULT_SNAP_TOLERANCE
DEFAULT_SNAP_UNITS
DEFAULT_Z_COORDINATE
Info
NoLevel
QGIS_DEV_VERSION
QGIS_RELEASE_NAME
QGIS_VERSION
QGIS_VERSION_INT
SCALE_PRECISION
Success
UI_SCALE_FACTOR
Warning
staticMetaObject

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 action

• DownloadImmediately: Action will start immediately

baseClass

alias of 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 successfully

• Invalid: Operation has invalid parameters for the item, no change occurred

• ItemCleared: 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

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

class AnnotationItemFlags

class AnnotationItemFlags(Union[Qgis.AnnotationItemFlags, Qgis.AnnotationItemFlag])

class AnnotationItemFlags(Qgis.AnnotationItemFlags)

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

class AnnotationItemGuiFlags

class AnnotationItemGuiFlags(Union[Qgis.AnnotationItemGuiFlags, Qgis.AnnotationItemGuiFlag])

class AnnotationItemGuiFlags(Qgis.AnnotationItemGuiFlags)

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

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

class BabelCommandFlags

class BabelCommandFlags(Union[Qgis.BabelCommandFlags, Qgis.BabelCommandFlag])

class BabelCommandFlags(Qgis.BabelCommandFlags)

Bases: sip.wrapper

class BabelFormatCapabilities

class BabelFormatCapabilities(Union[Qgis.BabelFormatCapabilities, Qgis.BabelFormatCapability])

class BabelFormatCapabilities(Qgis.BabelFormatCapabilities)

Bases: sip.wrapper

class BabelFormatCapability(value)

Bases: enum.IntEnum

Babel GPS format capabilities.

New in version 3.22.

• Import: Format supports importing

• Export: Format supports exporting

• Waypoints: Format supports waypoints

• Routes: Format supports routes

• Tracks: Format supports tracks

Export = 2

Import = 1

Routes = 8

Tracks = 16

Waypoints = 4

baseClass

alias of 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 monitored

• NeverMonitor: Never monitor the directory, regardless of the default logic

• AlwaysMonitor: Always monitor the directory, regardless of the default logic

AlwaysMonitor = 2

Default = 0

NeverMonitor = 1

baseClass

alias of Qgis

class BrowserItemCapabilities

class BrowserItemCapabilities(Union[Qgis.BrowserItemCapabilities, Qgis.BrowserItemCapability])

class BrowserItemCapabilities(Qgis.BrowserItemCapabilities)

Bases: sip.wrapper

class BrowserItemCapability(value)

Bases: enum.IntEnum

Browser item capabilities.

New in version 3.20.

• NoCapabilities: Item has no capabilities

• SetCrs: 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.0

• Fertile: 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 QgsSettings

• Collapse: The collapse/expand status for this items children should be ignored in order to avoid undesired network connections (wms etc.)

• Rename: Item can be renamed

• Delete: Item can be deleted

• ItemRepresentsFile: Item’s path() directly represents a file on disk (since QGIS 3.22)

baseClass

alias of Qgis

class BrowserItemState(value)

Bases: enum.IntEnum

Browser item states.

New in version 3.20.

• NotPopulated: Children not yet created

• Populating: Creating children in separate thread (populating or refreshing)

• Populated: Children created

baseClass

alias of Qgis

class BrowserItemType(value)

Bases: enum.IntEnum

Browser item types.

New in version 3.20.

• Collection: A collection of items

• Directory: Represents a file directory

• Layer: Represents a map layer

• Error: Contains an error message

• Favorites: Represents a favorite item

• Project: Represents a QGIS project

• Custom: Custom item type

• Fields: Collection of fields

• Field: Vector layer field

baseClass

alias of Qgis

class BrowserLayerType(value)

Bases: enum.IntEnum

Browser item layer types

New in version 3.20.

• NoType: No type

• Vector: Generic vector layer

• Raster: Raster layer

• Point: Vector point layer

• Line: Vector line layer

• Polygon: Vector polygon layer

• TableLayer: Vector non-spatial layer

• Database: Database layer

• Table: Database table

• Plugin: Plugin based layer

• Mesh: Mesh layer

• VectorTile: Vector tile layer

• PointCloud: Point cloud layer

baseClass

alias of Qgis

class BufferSide(value)

Bases: enum.IntEnum

Side of line to buffer.

New in version 3.22.

• SideLeft: Buffer to left of line

• SideRight: Buffer to right of line

baseClass

alias of 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 yet

• Running: Content fetching/storing is in progress

• Finished: Content fetching/storing is finished and successful

• Failed: Content fetching/storing has failed

• Canceled: Content fetching/storing has been canceled

Canceled = 4

Failed = 3

Finished = 2

NotStarted = 0

Running = 1

baseClass

alias of 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 type

• Byte: 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 Int16

• CInt32: Complex Int32

• CFloat32: Complex Float32

• CFloat64: Complex Float64

• ARGB32: Color, alpha, red, green, blue, 4 bytes the same as QImage::Format_ARGB32

• ARGB32_Premultiplied: Color, alpha, red, green, blue, 4 bytes the same as QImage::Format_ARGB32_Premultiplied

baseClass

alias of Qgis

class DriveType(value)

Bases: enum.IntEnum

Drive types

New in version 3.20.

• Unknown: Unknown type

• Invalid: Invalid path

• Removable: Removable drive

• Fixed: Fixed drive

• Remote: Remote drive

• CdRom: CD-ROM

• RamDisk: RAM disk

CdRom = 5

Fixed = 3

Invalid = 1

RamDisk = 6

Remote = 4

Removable = 2

Unknown = 0

baseClass

alias of Qgis

class EndCapStyle(value)

Bases: enum.IntEnum

End cap styles for buffers.

New in version 3.22.

• CapRound: Round cap

• CapFlat: 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

class FeatureCountState(value)

Bases: enum.IntEnum

Enumeration of feature count states

New in version 3.20.

• Uncounted: Feature count not yet computed

• UnknownCount: Provider returned an unknown feature count

baseClass

alias of 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 operation

• IncludeStyleFile: Indicates that any associated .qml styling file should be included with the operation

IncludeMetadataFile = 1

IncludeStyleFile = 2

baseClass

alias of Qgis

class FileOperationFlags

class FileOperationFlags(Union[Qgis.FileOperationFlags, Qgis.FileOperationFlag])

class FileOperationFlags(Qgis.FileOperationFlags)

Bases: sip.wrapper

class FilePathType(value)

Bases: enum.IntEnum

File path types.

New in version 3.22.

• Absolute: Absolute path

• Relative: Relative path

Absolute = 0

Relative = 1

baseClass

alias of Qgis

class GeometryOperationResult(value)

Bases: enum.IntEnum

Split features */

• Success: Operation succeeded

• NothingHappened: Nothing happened, without any error

• InvalidBaseGeometry: The base geometry on which the operation is done is invalid or empty

• InvalidInputGeometryType: The input geometry (ring, part, split line, etc.) has not the correct geometry type

• SelectionIsEmpty: No features were selected

• SelectionIsGreaterThanOne: More than one features were selected

• GeometryEngineError: Geometry engine misses a method implemented or an error occurred in the geometry engine

• LayerNotEditable: Cannot edit layer

• AddPartSelectedGeometryNotFound: The selected geometry cannot be found

• AddPartNotMultiGeometry: The source geometry is not multi

• AddRingNotClosed: The input ring is not closed

• AddRingNotValid: The input ring is not valid

• AddRingCrossesExistingRings: The input ring crosses existing rings (it is not disjoint)

• AddRingNotInExistingFeature: The input ring doesn’t have any existing ring to fit into

• SplitCannotSplitPoint: Cannot split points

baseClass

alias of Qgis

class GeometryValidationEngine(value)

Bases: enum.IntEnum

Available engines for validating geometries.

New in version 3.22.

• ValidatorQgisInternal: Use internal QgsGeometryValidator method

• ValidatorGeos: Use GEOS validation methods

baseClass

alias of 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

class GeometryValidityFlags

class GeometryValidityFlags(Union[Qgis.GeometryValidityFlags, Qgis.GeometryValidityFlag])

class GeometryValidityFlags(Qgis.GeometryValidityFlags)

Bases: sip.wrapper

class GpsFeatureType(value)

Bases: enum.IntEnum

GPS feature types.

New in version 3.22.

• Waypoint: Waypoint

• Route: Route

• Track: Track

Route = 1

Track = 2

Waypoint = 0

baseClass

alias of Qgis

class GpsQualityIndicator(value)

Bases: enum.IntEnum

GPS signal quality indicator

New in version 3.22.6.

• Unknown: Unknown

• Invalid: Invalid

• GPS: Standalone

• DGPS: Differential GPS

• PPS: PPS

• RTK: Real-time-kynematic

• FloatRTK: Float real-time-kynematic

• Estimated: Estimated

• Manual: Manual input mode

• Simulation: 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

class HttpMethod(value)

Bases: enum.IntEnum

Different methods of HTTP requests

New in version 3.22.

• Get: GET method

• Post: POST method

Get = 0

Post = 1

baseClass

alias of Qgis

Info = 0

class JoinStyle(value)

Bases: enum.IntEnum

Join styles for buffers.

New in version 3.22.

• JoinStyleRound: Use rounded joins

• JoinStyleMiter: Use mitered joins

• JoinStyleBevel: Use beveled joins

baseClass

alias of Qgis

class MapLayerProperties

class MapLayerProperties(Union[Qgis.MapLayerProperties, Qgis.MapLayerProperty])

class MapLayerProperties(Qgis.MapLayerProperties)

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

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 rendering

• DrawEditingInfo: Enable drawing of vertex markers for layers in editing mode

• ForceVectorOutput: Vector graphics should not be cached and drawn as raster images

• UseAdvancedEffects: Enable layer opacity and blending effects

• DrawLabeling: Enable drawing of labels on top of the map

• UseRenderingOptimization: Enable vector simplification and other rendering optimizations

• DrawSelection: Whether vector selections should be shown in the rendered map

• DrawSymbolBounds: Draw bounds of symbols (for debugging/testing)

• RenderMapTile: Draw map such that there are no problems between adjacent tiles

• RenderPartialOutput: Whether to make extra effort to update map image with partially rendered layers (better for interactive map canvas). Added in QGIS 3.0

• RenderPreviewJob: Render is a ‘canvas preview’ render, and shortcuts should be taken to ensure fast rendering

• RenderBlocking: 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

class MapSettingsFlags

class MapSettingsFlags(Union[Qgis.MapSettingsFlags, Qgis.MapSettingsFlag])

class MapSettingsFlags(Qgis.MapSettingsFlags)

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 type

• InvalidFace: 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 face

• FlatFace: A flat face is present

• UniqueSharedVertex: A least two faces share only one vertices

• InvalidVertex: 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

UniqueSharedVertex = 4

baseClass

alias of Qgis

class MessageLevel

Bases: int

baseClass

alias of Qgis

NoLevel = 4

class PythonMacroMode(value)

Bases: enum.IntEnum

Authorisation to run Python Macros

New in version 3.10.

• Never: Macros are never run

• Ask: User is prompt before running

• SessionOnly: Only during this session

• Always: Macros are always run

• NotForThisSession: Macros will not be run for this session

baseClass

alias of Qgis

QGIS_DEV_VERSION = 'exported'

QGIS_RELEASE_NAME = 'Białowieża'

QGIS_VERSION = '3.22.9-Białowieża'

QGIS_VERSION_INT = 32209

class RasterPipeInterfaceRole(value)

Bases: enum.IntEnum

Raster pipe interface roles.

New in version 3.22.

• UnknownRole: Unknown role

• ProviderRole: Data provider role

• RendererRole: Raster renderer role

• BrightnessRole: Brightness filter role

• ResamplerRole: Resampler role

• ProjectorRole: Projector role

• NullerRole: Raster nuller role

• HueSaturationRole: Hue/saturation filter role (also applies grayscale/color inversion)

baseClass

alias of Qgis

class RasterResamplingStage(value)

Bases: enum.IntEnum

Stage at which raster resampling occurs.

New in version 3.22.

• ResampleFilter:

• Provider:

baseClass

alias of 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

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 mode

• ForceVectorOutput: Vector graphics should not be cached and drawn as raster images

• UseAdvancedEffects: Enable layer opacity and blending effects

• UseRenderingOptimization: Enable vector simplification and other rendering optimizations

• DrawSelection: Whether vector selections should be shown in the rendered map

• DrawSymbolBounds: Draw bounds of symbols (for debugging/testing)

• RenderMapTile: Draw map such that there are no problems between adjacent tiles

• Antialiasing: Use antialiasing while drawing

• RenderPartialOutput: Whether to make extra effort to update map image with partially rendered layers (better for interactive map canvas). Added in QGIS 3.0

• RenderPreviewJob: Render is a ‘canvas preview’ render, and shortcuts should be taken to ensure fast rendering

• RenderBlocking: 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 map

• ApplyClipAfterReprojection: 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

class RenderContextFlags

class RenderContextFlags(Union[Qgis.RenderContextFlags, Qgis.RenderContextFlag])

class RenderContextFlags(Qgis.RenderContextFlags)

Bases: sip.wrapper

class RenderSubcomponentProperty(value)

Bases: enum.IntEnum

Rendering subcomponent properties.

New in version 3.22.

• Generic: Generic subcomponent property

• ShadowOffset: Shadow offset

• BlurSize: Blur size

• GlowSpread: Glow spread size

BlurSize = 2

Generic = 0

GlowSpread = 3

ShadowOffset = 1

baseClass

alias of Qgis

SCALE_PRECISION = 0.9999999999

class ScaleMethod(value)

Bases: enum.IntEnum

Scale methods

New in version 3.20.

• ScaleArea: Calculate scale by the area

• ScaleDiameter: Calculate scale by the diameter

baseClass

alias of 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 selection

• AddToSelection: Add selection to current selection

• IntersectSelection: Modify current selection to include only select features which match

• RemoveFromSelection: Remove from current selection

baseClass

alias of Qgis

class SpatialFilterType(value)

Bases: enum.IntEnum

Feature request spatial filter types.

New in version 3.22.

• NoFilter: No spatial filtering of features

• BoundingBox: Filter using a bounding box

• DistanceWithin: Filter by distance to reference geometry

BoundingBox = 1

DistanceWithin = 2

NoFilter = 0

baseClass

alias of 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 keyword

• Constant: SQL constant

• Function: SQL generic function

• Geospatial: SQL spatial function

• Operator: SQL operator

• Math: SQL math function

• Aggregate: SQL aggregate function

• String: SQL string function

• Identifier: SQL identifier

Aggregate = 6

Constant = 1

Function = 2

Geospatial = 3

Identifier = 8

Keyword = 0

Math = 5

Operator = 4

String = 7

baseClass

alias of Qgis

class SqlLayerDefinitionCapabilities

class SqlLayerDefinitionCapabilities(Union[Qgis.SqlLayerDefinitionCapabilities, Qgis.SqlLayerDefinitionCapability])

class SqlLayerDefinitionCapabilities(Qgis.SqlLayerDefinitionCapabilities)

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 filter

• GeometryColumn: SQL layer definition supports geometry column

• PrimaryKeys: SQL layer definition supports primary keys

• UnstableFeatureIds: SQL layer definition supports disabling select at id

GeometryColumn = 4

PrimaryKeys = 8

SubsetStringFilter = 2

UnstableFeatureIds = 16

baseClass

alias of 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

class SublayerFlags

class SublayerFlags(Union[Qgis.SublayerFlags, Qgis.SublayerFlag])

class SublayerFlags(Qgis.SublayerFlags)

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 present

• AskExcludingRasterBands: Ask users to select from available sublayers, unless only raster bands are present

• NeverAskSkip: Never ask users to select sublayers, instead don’t load anything

• NeverAskLoadAll: Never ask users to select sublayers, instead automatically load all available sublayers

AlwaysAsk = 0

AskExcludingRasterBands = 1

NeverAskLoadAll = 3

NeverAskSkip = 2

baseClass

alias of 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 provider

• ResolveGeometryType: Attempt to resolve the geometry type for vector sublayers

• CountFeatures: Count features in vector sublayers

• IncludeSystemTables: Include system or internal tables (these are not included by default)

CountFeatures = 4

FastScan = 1

IncludeSystemTables = 8

ResolveGeometryType = 2

baseClass

alias of Qgis

class SublayerQueryFlags

class SublayerQueryFlags(Union[Qgis.SublayerQueryFlags, Qgis.SublayerQueryFlag])

class SublayerQueryFlags(Qgis.SublayerQueryFlags)

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 a QgsFeatureRenderer using the symbol should use symbol levels for best results

RendererShouldUseSymbolLevels = 1

baseClass

alias of Qgis

class SymbolFlags

class SymbolFlags(Union[Qgis.SymbolFlags, Qgis.SymbolFlag])

class SymbolFlags(Qgis.SymbolFlags)

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

class SymbolLayerFlags

class SymbolLayerFlags(Union[Qgis.SymbolLayerFlags, Qgis.SymbolLayerFlag])

class SymbolLayerFlags(Qgis.SymbolLayerFlags)

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

class SymbolPreviewFlags

class SymbolPreviewFlags(Union[Qgis.SymbolPreviewFlags, Qgis.SymbolPreviewFlag])

class SymbolPreviewFlags(Qgis.SymbolPreviewFlags)

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

class SymbolRenderHints

class SymbolRenderHints(Union[Qgis.SymbolRenderHints, Qgis.SymbolRenderHint])

class SymbolRenderHints(Qgis.SymbolRenderHints)

Bases: sip.wrapper

class SymbolType(value)

Bases: enum.IntEnum

Symbol types

New in version 3.20.

• Marker: Marker symbol

• Line: Line symbol

• Fill: Fill symbol

• Hybrid: Hybrid symbol

baseClass

alias of 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 range

• MatchExactUsingStartOfRange: Match the start of the temporal range to a corresponding layer or band, and only use exact matching results

• MatchExactUsingEndOfRange: Match the end of the temporal range to a corresponding layer or band, and only use exact matching results

• FindClosestMatchToStartOfRange: 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

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 through QgsTextRenderer and QgsTextFormat, 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

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

UI_SCALE_FACTOR = 1.0

class UnplacedLabelVisibility(value)

Bases: enum.IntEnum

Unplaced label visibility.

New in version 3.20.

• FollowEngineSetting: Respect the label engine setting

• NeverShow: Never show unplaced labels, regardless of the engine setting

FollowEngineSetting = 0

NeverShow = 1

baseClass

alias of 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 field

• ProviderStoresFeatureDateTimeStartAndEndInSeparateFields: Dataset stores feature start and end datetimes in separate fields

baseClass

alias of 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 successful

• EmptyGeometry: Edit operation resulted in an empty geometry

• EditFailed: Edit operation failed

• FetchFeatureFailed: Unable to fetch requested feature

• InvalidLayer: Edit failed due to invalid layer

baseClass

alias of Qgis

class VectorExportResult(value)

Bases: enum.IntEnum

Vector layer export result codes.

New in version 3.20.

• NoError: No errors were encountered

• ErrCreateDataSource: Could not create the destination data source

• ErrCreateLayer: Could not create destination layer

• ErrAttributeTypeUnsupported: Source layer has an attribute type which could not be handled by destination

• ErrAttributeCreationFailed: Destination provider was unable to create an attribute

• ErrProjection: An error occurred while reprojecting features to destination CRS

• ErrFeatureWriteFailed: An error occurred while writing a feature to the destination

• ErrInvalidLayer: Could not access newly created destination layer

• ErrInvalidProvider: Could not find a matching provider key

• ErrProviderUnsupportedFeature: Provider does not support creation of empty layers

• ErrConnectionFailed: Could not connect to destination

• ErrUserCanceled: User canceled the export

baseClass

alias of 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 limit

• IncludeBeginIncludeEnd: Mode to include both limits of the filtering timeframe

IncludeBeginExcludeEnd = 0

IncludeBeginIncludeEnd = 1

baseClass

alias of 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 field

• ModeFeatureDateTimeStartAndEndFromFields: Mode when features have separate fields for start and end times

• ModeFeatureDateTimeStartAndDurationFromFields: Mode when features have a field for start time and a field for event duration

• ModeFeatureDateTimeStartAndEndFromExpressions: Mode when features use expressions for start and end times

• ModeRedrawLayerOnly: 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

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 marker

• Cross: Cross marker

• NoMarker: No marker

baseClass

alias of Qgis

class VertexType(value)

Bases: enum.IntEnum

Types of vertex.

New in version 3.22.

• SegmentVertex: The actual start or end point of a segment

• CurveVertex: An intermediate point on a segment defining the curvature of the segment

baseClass

alias of 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