Class: Qgis¶

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

Enums

`ActionStart`	Enum to determine when an operation would begin
`ActionType`	Action types.
`Aggregate`	Available aggregates to calculate.
`AltitudeBinding`	Altitude binding.
`AltitudeClamping`	Altitude clamping.
`AngleUnit`	Units of angles.
`AngularDirection`	Angular directions.
`AnimationState`	Animation states.
`AnnotationItemEditOperationResult`	Results from an edit operation on an annotation item.
`AnnotationItemFlag`	Flags for annotation items.
`AnnotationItemGuiFlag`	Flags for controlling how an annotation item behaves in the GUI.
`AnnotationItemNodeType`	Annotation item node types.
`AnnotationPlacementMode`	Annotation item placement modes.
`ArcGisRestServiceType`	Available ArcGIS REST service types.
`AreaUnit`	Units of area
`AttributeActionType`	Attribute action types.
`AttributeEditorContainerType`	Attribute editor container types.
`AttributeEditorType`	Attribute editor types.
`AttributeFormLayout`	Available form types for layout of the attribute form editor.
`AttributeFormPythonInitCodeSource`	The Python init code source for attribute forms.
`AttributeFormSuppression`	Available form types for layout of the attribute form editor.
`AuthConfigurationStorageCapability`	Authentication configuration storage capabilities.
`AutoRefreshMode`	Map layer automatic refresh modes.
`AvoidIntersectionsMode`	Flags which control how intersections of pre-existing feature are handled when digitizing new features.
`Axis`	Cartesian axes.
`BabelCommandFlag`	Babel command flags, which control how commands and arguments are generated for executing GPSBabel processes.
`BabelFormatCapability`	Babel GPS format capabilities.
`BetweenLineConstraint`	Between line constraints which can be enabled
`BlendMode`	Blending modes defining the available composition modes that can be used when painting.
`BrowserDirectoryMonitoring`	Browser directory item monitoring switches.
`BrowserItemCapability`	Browser item capabilities.
`BrowserItemState`	Browser item states.
`BrowserItemType`	Browser item types.
`BrowserLayerType`	Browser item layer types
`BufferSide`	Side of line to buffer.
`CadConstraintType`	Advanced digitizing constraint type.
`Capitalization`	String capitalization options.
`CaptureTechnique`	Capture technique.
`ColorModel`	Color model types
`ContentStatus`	Status for fetched or stored content
`CoordinateDisplayType`	Formats for displaying coordinates
`CoordinateOrder`	Order of coordinates.
`CoordinateTransformationFlag`	Flags which adjust the coordinate transformations behave.
`CoverageValidityResult`	Coverage validity results.
`CrsAxisDirection`	Coordinate reference system axis directions.
`CrsDefinitionFormat`	CRS definition formats.
`CrsIdentifierType`	Available identifier string types for representing coordinate reference systems
`CrsType`	Coordinate reference system types.
`CrsWktVariant`	Coordinate reference system WKT formatting variants.
`DashPatternLineEndingRule`	Dash pattern line ending rules.
`DashPatternSizeAdjustment`	Dash pattern size adjustment options.
`DataItemProviderCapability`	Capabilities for data item providers.
`DataProviderFlag`	Generic data provider flags.
`DataProviderReadFlag`	Flags which control data provider construction.
`DataType`	Raster data types.
`DatabaseProviderConnectionCapability2`	The Capability enum represents the extended operations supported by the connection.
`DateTimeStatistic`	Available date/time statistics.
`DeviceConnectionStatus`	GPS connection status.
`DistanceUnit`	Units of distance
`DistanceUnitType`	Types of distance units
`DpiMode`	DpiMode enum
`DriveType`	Drive types
`ElevationMapCombineMethod`	Methods used to select the elevation when two elevation maps are combined
`EndCapStyle`	End cap styles for buffers.
`ExpressionType`	Expression types
`FeatureAvailability`	Possible return value for `QgsFeatureSource.hasFeatures()` to determine if a source is empty.
`FeatureCountState`	Enumeration of feature count states
`FeatureRendererFlag`	Flags controlling behavior of vector feature renderers.
`FeatureRequestFilterType`	Types of feature request filters.
`FeatureRequestFlag`	Flags for controlling feature requests.
`FeatureSymbologyExport`	Options for exporting features considering their symbology.
`FieldConfigurationFlag`	Configuration flags for fields These flags are meant to be user-configurable and are not describing any information from the data provider.
`FieldDomainMergePolicy`	Merge policy for field domains.
`FieldDomainSplitPolicy`	Split policy for field domains.
`FieldDomainType`	Types of field domain
`FieldDuplicatePolicy`	Duplicate policy for fields.
`FieldMetadataProperty`	Standard field metadata values.
`FieldOrigin`	Field origin.
`FileFilterType`	Type of file filters
`FileOperationFlag`	File operation flags.
`FilePathType`	File path types.
`GdalResampleAlgorithm`	Resampling algorithm to be used (equivalent to GDAL's enum GDALResampleAlg)
`GeometryOperationResult`	Success or failure of a geometry operation.
`GeometryType`	The geometry types are used to group Qgis.WkbType in a coarse way.
`GeometryValidationEngine`	Available engines for validating geometries.
`GeometryValidityFlag`	Geometry validity check flags.
`GeosCreationFlag`	Flags which control geos geometry creation behavior.
`GnssConstellation`	GNSS constellation
`GpsConnectionStatus`	alias of `DeviceConnectionStatus`
`GpsConnectionType`	GPS connection types.
`GpsFeatureType`	GPS feature types.
`GpsFixStatus`	GPS fix status.
`GpsInformationComponent`	GPS information component.
`GpsNavigationStatus`	GPS navigation status.
`GpsQualityIndicator`	GPS signal quality indicator
`GradientColorSource`	Gradient color sources.
`GradientSpread`	Gradient spread options, which control how gradients are rendered outside of their start and end points.
`GradientType`	Gradient types.
`GraduatedMethod`	Methods for modifying symbols by range in a graduated symbol renderer.
`HistoryProviderBackend`	History provider backends.
`HttpMethod`	Different methods of HTTP requests
`InputControllerType`	Input controller types.
`InvalidGeometryCheck`	Methods for handling of features with invalid geometries
`JoinStyle`	Join styles for buffers.
`LabelLinePlacementFlag`	Line placement flags, which control how candidates are generated for a linear feature.
`LabelMultiLineAlignment`	Text alignment for multi-line labels.
`LabelOffsetType`	Behavior modifier for label offset and distance, only applies in some label placement modes.
`LabelOverlapHandling`	Label overlap handling.
`LabelPlacement`	Placement modes which determine how label candidates are generated for a feature.
`LabelPlacementEngineVersion`	Labeling placement engine version.
`LabelPolygonPlacementFlag`	Polygon placement flags, which control how candidates are generated for a polygon feature.
`LabelPredefinedPointPosition`	Positions for labels when using the Qgis.LabelPlacement.OrderedPositionsAroundPoint placement mode.
`LabelPrioritization`	Label prioritization.
`LabelQuadrantPosition`	Label quadrant positions
`LabelingFlag`	Various flags that affect drawing and placement of labels.
`LayerFilter`	Filter for layers
`LayerTreeFilterFlag`	Layer tree filter flags.
`LayerTreeInsertionMethod`	Layer tree insertion methods
`LayerType`	Types of layers that can be added to a map
`LayoutUnit`	Layout measurement units
`LayoutUnitType`	Types of layout units
`LegendJsonRenderFlag`	Legend JSON export flags.
`LightSourceType`	Light source types for 3D scenes.
`LineClipMode`	Line clipping modes.
`LineExtensionSide`	Designates whether the line extension constraint is currently soft locked with the previous or next vertex of the locked one.
`LinearReferencingLabelSource`	Defines what quantity to use for the labels shown in a linear referencing symbol layer.
`LinearReferencingPlacement`	Defines how/where the labels should be placed in a linear referencing symbol layer.
`LoadStyleFlag`	Flags for loading layer styles.
`MakeValidMethod`	Algorithms to use when repairing invalid geometries.
`MapBoxGlStyleSourceType`	Available MapBox GL style source types.
`MapCanvasFlag`	Flags controlling behavior of map canvases.
`MapLayerActionFlag`	Map layer action flags.
`MapLayerActionTarget`	Map layer action targets.
`MapLayerProperty`	Generic map layer properties.
`MapLayerRendererFlag`	Flags which control how map layer renderers behave.
`MapRecenteringMode`	Modes for recentering map canvases.
`MapSettingsFlag`	Flags which adjust the way maps are rendered.
`MapToolUnit`	Type of unit of tolerance value from settings.
`MarkerClipMode`	Marker clipping modes.
`MarkerLinePlacement`	Defines how/where the symbols should be placed on a line.
`MarkerShape`	Marker shapes.
`MeshEditingErrorType`	Type of error that can occur during mesh frame editing.
`MeshElevationMode`	Mesh layer elevation modes.
`MetadataDateType`	Date types for metadata.
`NavigationMode`	The navigation mode used by 3D cameras.
`PictureFormat`	Picture formats.
`PlaybackOperation`	Media playback operations.
`PlotAxisSuffixPlacement`	Placement options for suffixes in the labels for axis of plots.
`PlotToolFlag`	Flags that control the way the `QgsPlotTools` operate.
`Point3DShape`	3D point shape types.
`PointCloudDrawOrder`	Pointcloud rendering order for 2d views
`PointCloudSymbol`	Rendering symbols for point cloud points.
`PointCountMethod`	Methods which define the number of points randomly filling a polygon.
`PostgresRelKind`	Postgres database relkind options.
`ProcessingAlgorithmDocumentationFlag`	Flags describing algorithm behavior for documentation purposes.
`ProcessingAlgorithmFlag`	Flags indicating how and when an algorithm operates and should be exposed to users.
`ProcessingDateTimeParameterDataType`	Processing date time parameter data types.
`ProcessingFeatureSourceDefinitionFlag`	Flags which control behavior for a Processing feature source.
`ProcessingFeatureSourceFlag`	Flags which control how `QgsProcessingFeatureSource` fetches features.
`ProcessingFieldParameterDataType`	Processing field parameter data types.
`ProcessingFileParameterBehavior`	Flags which dictate the behavior of `QgsProcessingParameterFile`.
`ProcessingLogLevel`	Logging level for algorithms to use when pushing feedback messages.
`ProcessingModelChildAlgorithmExecutionStatus`	Reflects the status of a child algorithm in a Processing model.
`ProcessingModelChildParameterSource`	Processing model child parameter sources.
`ProcessingNumberParameterType`	Processing numeric parameter data types.
`ProcessingParameterFlag`	Flags which dictate the behavior of Processing parameters.
`ProcessingParameterTypeFlag`	Flags which dictate the behavior of Processing parameter types.
`ProcessingPropertyAvailability`	Property availability, used for `QgsProcessingAlgorithm`.VectorProperties in order to determine if properties are available or not.
`ProcessingProviderFlag`	Flags indicating how and when an processing provider operates and should be exposed to users.
`ProcessingSourceType`	Processing data source types.
`ProcessingTinInputLayerType`	Defines the type of input layer for a Processing TIN input.
`ProfileExportType`	Types of export for elevation profiles.
`ProfileGeneratorFlag`	Flags that control the way the `QgsAbstractProfileGenerator` operate.
`ProfileSurfaceSymbology`	Surface symbology type for elevation profile plots.
`ProjectCapability`	Flags which control project capabilities.
`ProjectFileFormat`	Flags which control project read behavior.
`ProjectFlag`	Flags which control the behavior of `QgsProjects`.
`ProjectReadFlag`	Flags which control project read behavior.
`PropertyType`	Property types
`ProviderStyleStorageCapability`	The StorageCapability enum represents the style storage operations supported by the provider.
`PythonEmbeddedMode`	Authorisation to run Python Embedded in projects
`PythonEmbeddedType`	Type of Python Embedded in projects
`PythonMacroMode`	alias of `PythonEmbeddedMode`
`RangeLimits`	Describes how the limits of a range are handled.
`RasterAttributeTableFieldUsage`	The RasterAttributeTableFieldUsage enum represents the usage of a Raster Attribute Table field.
`RasterAttributeTableType`	The RasterAttributeTableType enum represents the type of RAT.
`RasterBandStatistic`	Available raster band statistics.
`RasterBuildPyramidOption`	Raster pyramid building options.
`RasterColorInterpretation`	Raster color interpretation.
`RasterDrawingStyle`	Raster drawing styles.
`RasterElevationMode`	Raster layer elevation modes.
`RasterExportType`	Raster file export types.
`RasterFileWriterResult`	Raster file export results.
`RasterIdentifyFormat`	Raster identify formats.
`RasterInterfaceCapability`	Raster interface capabilities.
`RasterLayerType`	Raster layer types.
`RasterPipeInterfaceRole`	Raster pipe interface roles.
`RasterProviderCapability`	Raster data provider capabilities.
`RasterPyramidFormat`	Raster pyramid formats.
`RasterRendererCapability`	Raster renderer capabilities.
`RasterRendererFlag`	Flags which control behavior of raster renderers.
`RasterResamplingStage`	Stage at which raster resampling occurs.
`RasterTemporalCapabilityFlag`	Flags for raster layer temporal capabilities.
`RasterTemporalMode`	Raster layer temporal modes
`RelationshipCapability`	Relationship capabilities.
`RelationshipCardinality`	Relationship cardinality.
`RelationshipStrength`	Relationship strength.
`RelationshipType`	Relationship types.
`RenderContextFlag`	Flags which affect rendering operations.
`RenderSubcomponentProperty`	Rendering subcomponent properties.
`RenderUnit`	Rendering size units
`RendererUsage`	Usage of the renderer.
`ScaleBarAlignment`	Scalebar alignment.
`ScaleBarDistanceLabelHorizontalPlacement`	Scale bar distance label horizontal placement.
`ScaleBarDistanceLabelVerticalPlacement`	Scale bar distance label vertical placement.
`ScaleBarSegmentSizeMode`	Modes for setting size for scale bar segments.
`ScaleCalculationMethod`	Scale calculation logic.
`ScaleMethod`	Scale methods
`ScaleToTileZoomLevelMethod`	Available methods for converting map scales to tile zoom levels.
`ScriptLanguage`	Scripting languages.
`ScriptLanguageCapability`	Script language capabilities.
`SelectBehavior`	Specifies how a selection should be applied.
`SelectGeometryRelationship`	Geometry relationship test to apply for selecting features.
`SelectionFlag`	Flags which control feature selection behavior.
`SelectionRenderingMode`	Specifies how a selection should be rendered.
`SensorThingsEntity`	OGC SensorThings API entity types.
`SettingsOption`	Settings options
`SettingsOrigin`	The setting origin describes where a setting is stored.
`SettingsTreeNodeOption`	Options for named list nodes
`SettingsTreeNodeType`	Type of tree node
`SettingsType`	Types of settings entries
`ShaderClassificationMethod`	Color ramp shader classification methods.
`ShaderInterpolationMethod`	Color ramp shader interpolation methods.
`SldExportOption`	SLD export options
`SldExportVendorExtension`	SLD export vendor extensions, allow the use of vendor extensions when exporting to SLD.
`SnappingMode`	SnappingMode defines on which layer the snapping is performed
`SnappingType`	SnappingTypeFlag defines on what object the snapping is performed
`SpatialFilterType`	Feature request spatial filter types.
`SpatialIndexPresence`	Enumeration of spatial index presence states.
`SqlKeywordCategory`	SqlKeywordCategory enum represents the categories of the SQL keywords used by the SQL query editor.
`SqlLayerDefinitionCapability`	SqlLayerDefinitionCapability enum lists the arguments supported by the provider when creating SQL query layers.
`Statistic`	Available generic statistics.
`StringStatistic`	Available string statistics.
`SublayerFlag`	Flags which reflect the properties of sublayers in a dataset.
`SublayerPromptMode`	Specifies how to handle layer sources with multiple sublayers.
`SublayerQueryFlag`	Flags which control how data providers will scan for sublayers in a dataset.
`SymbolCoordinateReference`	Symbol coordinate reference modes.
`SymbolFlag`	Flags controlling behavior of symbols
`SymbolLayerFlag`	Flags controlling behavior of symbol layers
`SymbolLayerUserFlag`	User-specified flags controlling behavior of symbol layers.
`SymbolPreviewFlag`	Flags for controlling how symbol preview images are generated.
`SymbolRenderHint`	Flags controlling behavior of symbols during rendering
`SymbolRotationMode`	Modes for handling how symbol and text entity rotation is handled when maps are rotated.
`SymbolType`	Symbol types
`SystemOfMeasurement`	Systems of unit measurement.
`TemporalIntervalMatchMethod`	Method to use when resolving a temporal range to a data provider layer or band.
`TemporalNavigationMode`	Temporal navigation modes.
`TemporalUnit`	Temporal units.
`TextCharacterVerticalAlignment`	Text vertical alignment for characters.
`TextComponent`	Text components.
`TextHorizontalAlignment`	Text horizontal alignment.
`TextLayoutMode`	Text layout modes.
`TextOrientation`	Text orientations.
`TextRenderFormat`	Options for rendering text.
`TextRendererFlag`	Flags which control the behavior of rendering text.
`TextVerticalAlignment`	Text vertical alignment.
`TileAvailability`	Possible availability states for a tile within a tile matrix.
`TileChildrenAvailability`	Possible availability states for a tile's children.
`TilePixelRatio`	DpiMode enum
`TileRefinementProcess`	Tiled scene tile refinement processes.
`TiledSceneBoundingVolumeType`	Tiled scene bounding volume types.
`TiledSceneProviderCapability`	Tiled scene data provider capabilities.
`TiledSceneRendererFlag`	Flags which control how tiled scene 2D renderers behave.
`TiledSceneRequestFlag`	Flags which control how tiled scene requests behave.
`TransactionMode`	Transaction mode.
`TransformDirection`	Indicates the direction (forward or inverse) of a transform.
`UnitType`	Unit types.
`UnplacedLabelVisibility`	Unplaced label visibility.
`UpsideDownLabelHandling`	Handling techniques for upside down labels.
`UriCleaningFlag`	Flags for cleaning layer URIs.
`UserProfileSelectionPolicy`	User profile selection policy.
`VectorDataProviderAttributeEditCapability`	Attribute editing capabilities which may be supported by vector data providers.
`VectorDataProviderTemporalMode`	Vector data provider temporal handling modes.
`VectorEditResult`	Specifies the result of a vector layer edit operation
`VectorExportResult`	Vector layer export result codes.
`VectorFileWriterCapability`	Capabilities supported by a `QgsVectorFileWriter` object.
`VectorLayerTypeFlag`	Vector layer type flags.
`VectorProfileType`	Types of elevation profiles to generate for vector sources.
`VectorProviderCapability`	Vector data provider capabilities.
`VectorRenderingSimplificationFlag`	Simplification flags for vector feature rendering.
`VectorSimplificationAlgorithm`	Simplification algorithms for vector features.
`VectorTemporalLimitMode`	Mode for the handling of the limits of the filtering timeframe for vector features
`VectorTemporalMode`	Vector layer temporal feature modes
`VectorTileProviderCapability`	Enumeration with capabilities that vector tile data providers might implement.
`VectorTileProviderFlag`	Flags for vector tile data providers.
`VertexMarkerType`	Editing vertex markers, used for showing vertices during a edit operation.
`VertexType`	Types of vertex.
`VerticalAxisInversion`	Vertical axis inversion options for 3D views.
`ViewSyncModeFlag`	Synchronization of 2D map canvas and 3D view
`VolumeUnit`	Units of volume.
`VsiHandlerType`	GDAL VSI handler types.
`WkbType`	The WKB type describes the number of dimensions a geometry has
`ZonalStatistic`	Statistics to be calculated during a zonal statistics operation.
`ZonalStatisticResult`	Zonal statistics result codes.

Static 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 buffer in mm.
`DEFAULT_HIGHLIGHT_COLOR`	Default highlight color.
`DEFAULT_HIGHLIGHT_MIN_WIDTH_MM`	Default highlight line/stroke minimum width in mm.
`DEFAULT_MAPTOPIXEL_THRESHOLD`	Default threshold between map coordinates and device coordinates for map2pixel simplification
`DEFAULT_M_COORDINATE`	Default M coordinate value.
`DEFAULT_SEARCH_RADIUS_MM`	Identify search radius in mm
`DEFAULT_SNAP_TOLERANCE`	Default snapping distance tolerance.
`DEFAULT_Z_COORDINATE`	Default Z coordinate value.
`Info`
`NoLevel`
`QGIS_DEV_VERSION`	The development version
`QGIS_RELEASE_NAME`
`QGIS_VERSION`
`QGIS_VERSION_INT`
`SCALE_PRECISION`	Fudge factor used to compare two scales.
`Success`
`UI_SCALE_FACTOR`	UI scaling factor.
`Warning`

class qgis.core.Qgis[source]¶

Bases: object

class ActionStart(*values)¶

Bases: IntEnum

Enum to determine when an operation would begin

Added in version 3.22.

Deferred: Do not start immediately the action

Available as QgsNetworkContentFetcherRegistry.DownloadLater in older QGIS releases.
Immediate: Action will start immediately

Available as QgsNetworkContentFetcherRegistry.DownloadImmediately in older QGIS releases.

class ActionType(*values)¶

Bases: IntEnum

Action types.

Prior to QGIS 3.30 this was available as QgsActionMenu.ActionType

Added in version 3.30.

Invalid: Invalid
MapLayerAction: Standard actions (defined by core or plugins), corresponds to QgsMapLayerAction class.
AttributeAction: Custom actions (manually defined in layer properties), corresponds to QgsAction class.

class Aggregate(*values)¶

Bases: IntEnum

Available aggregates to calculate. Not all aggregates are available for all field types.

Added in version 3.36..

Count: Count
CountDistinct: Number of distinct values
CountMissing: Number of missing (null) values
Min: Min of values
Max: Max of values
Sum: Sum of values
Mean: Mean of values (numeric fields only)
Median: Median of values (numeric fields only)
StDev: Standard deviation of values (numeric fields only)
StDevSample: Sample standard deviation of values (numeric fields only)
Range: Range of values (max - min) (numeric and datetime fields only)
Minority: Minority of values
Majority: Majority of values
FirstQuartile: First quartile (numeric fields only)
ThirdQuartile: Third quartile (numeric fields only)
InterQuartileRange: Inter quartile range (IQR) (numeric fields only)
StringMinimumLength: Minimum length of string (string fields only)
StringMaximumLength: Maximum length of string (string fields only)
StringConcatenate: Concatenate values with a joining string (string fields only). Specify the delimiter using setDelimiter().
GeometryCollect: Create a multipart geometry from aggregated geometries
ArrayAggregate: Create an array of values
StringConcatenateUnique: Concatenate unique values with a joining string (string fields only). Specify the delimiter using setDelimiter().

class AltitudeBinding(*values)¶

Bases: IntEnum

Altitude binding.

Added in version 3.26.

Vertex: Clamp every vertex of feature
Centroid: Clamp just centroid of feature

class AltitudeClamping(*values)¶

Bases: IntEnum

Altitude clamping.

Added in version 3.26.

Absolute: Elevation is taken directly from feature and is independent of terrain height (final elevation = feature elevation)
Relative: Elevation is relative to terrain height (final elevation = terrain elevation + feature elevation)
Terrain: Elevation is clamped to terrain (final elevation = terrain elevation)

class AngleUnit(*values)¶

Bases: IntEnum

Units of angles.

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes.AngleUnit.

Added in version 3.30.

Degrees: Degrees

Available as QgsUnitTypes.AngleDegrees in older QGIS releases.
Radians: Square kilometers

Available as QgsUnitTypes.AngleRadians in older QGIS releases.
Gon: Gon/gradian

Available as QgsUnitTypes.AngleGon in older QGIS releases.
MinutesOfArc: Minutes of arc

Available as QgsUnitTypes.AngleMinutesOfArc in older QGIS releases.
SecondsOfArc: Seconds of arc

Available as QgsUnitTypes.AngleSecondsOfArc in older QGIS releases.
Turn: Turn/revolutions

Available as QgsUnitTypes.AngleTurn in older QGIS releases.
MilliradiansSI: Angular milliradians (SI definition, 1/1000 of radian)

Available as QgsUnitTypes.AngleMilliradiansSI in older QGIS releases.
MilNATO: Angular mil (NATO definition, 6400 mil = 2PI radians)

Available as QgsUnitTypes.AngleMilNATO in older QGIS releases.
Unknown: Unknown angle unit

Available as QgsUnitTypes.AngleUnknownUnit in older QGIS releases.

class AngularDirection(*values)¶

Bases: IntEnum

Angular directions.

Added in version 3.24.

Clockwise: Clockwise direction
CounterClockwise: Counter-clockwise direction
NoOrientation: Unknown orientation or sentinel value

class AnimationState(*values)¶

Bases: IntEnum

Animation states.

Note

Prior to QGIS 3.36 this was available as QgsTemporalNavigationObject.AnimationState

Added in version 3.36.

Forward: Animation is playing forward.
Reverse: Animation is playing in reverse.
Idle: Animation is paused.

class AnnotationItemEditOperationResult(*values)¶

Bases: IntEnum

Results from an edit operation on an annotation item.

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

class AnnotationItemFlag(*values)¶

Bases: IntEnum

Flags for annotation items.

Added in version 3.22.

ScaleDependentBoundingBox: Item’s bounding box will vary depending on map scale
SupportsReferenceScale: Item supports reference scale based rendering

Added in version 3.40.
SupportsCallouts: Item supports callouts

Added in version 3.40.

ScaleDependentBoundingBox = 1¶

SupportsCallouts = 4¶

SupportsReferenceScale = 2¶

class AnnotationItemFlags¶
class AnnotationItemFlags(f: Qgis.AnnotationItemFlags | Qgis.AnnotationItemFlag)
class AnnotationItemFlags(a0: Qgis.AnnotationItemFlags): Bases: object

class AnnotationItemGuiFlag(*values)¶

Bases: IntEnum

Flags for controlling how an annotation item behaves in the GUI.

Added in version 3.22.

FlagNoCreationTools: Do not show item creation tools for the item type

FlagNoCreationTools = 1¶

class AnnotationItemGuiFlags¶
class AnnotationItemGuiFlags(f: Qgis.AnnotationItemGuiFlags | Qgis.AnnotationItemGuiFlag)
class AnnotationItemGuiFlags(a0: Qgis.AnnotationItemGuiFlags): Bases: object

class AnnotationItemNodeType(*values)¶

Bases: IntEnum

Annotation item node types.

Added in version 3.22.

VertexHandle: Node is a handle for manipulating vertices
CalloutHandle: Node is a handle for manipulating callouts

Added in version 3.40.

CalloutHandle = 1¶

VertexHandle = 0¶

class AnnotationPlacementMode(*values)¶

Bases: IntEnum

Annotation item placement modes.

Added in version 3.40.

SpatialBounds: Item is rendered inside fixed spatial bounds, and size will depend on map scale
FixedSize: Item is rendered at a fixed size, regardless of map scale. Item’s location is georeferenced to a spatial location.
RelativeToMapFrame: Items size and placement is relative to the map’s frame, and the item will always be rendered in the same visible location regardless of map extent or scale.

FixedSize = 1¶

RelativeToMapFrame = 2¶

SpatialBounds = 0¶

class ArcGisRestServiceType(*values)¶

Bases: IntEnum

Available ArcGIS REST service types.

Note

Prior to QGIS 3.26 this was available as QgsArcGisPortalUtils.ItemType.

Added in version 3.28.

FeatureServer: FeatureServer

Available as QgsArcGisPortalUtils.FeatureService in older QGIS releases.
MapServer: MapServer

Available as QgsArcGisPortalUtils.MapService in older QGIS releases.
ImageServer: ImageServer

Available as QgsArcGisPortalUtils.ImageService in older QGIS releases.
GlobeServer: GlobeServer
GPServer: GPServer
GeocodeServer: GeocodeServer
Unknown: Other unknown/unsupported type

class AreaUnit(*values)¶

Bases: IntEnum

Units of area

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes.AreaUnit.

Added in version 3.30.

SquareMeters: Square meters

Available as QgsUnitTypes.AreaSquareMeters in older QGIS releases.
SquareKilometers: Square kilometers

Available as QgsUnitTypes.AreaSquareKilometers in older QGIS releases.
SquareFeet: Square feet

Available as QgsUnitTypes.AreaSquareFeet in older QGIS releases.
SquareYards: Square yards

Available as QgsUnitTypes.AreaSquareYards in older QGIS releases.
SquareMiles: Square miles

Available as QgsUnitTypes.AreaSquareMiles in older QGIS releases.
Hectares: Hectares

Available as QgsUnitTypes.AreaHectares in older QGIS releases.
Acres: Acres

Available as QgsUnitTypes.AreaAcres in older QGIS releases.
SquareNauticalMiles: Square nautical miles

Available as QgsUnitTypes.AreaSquareNauticalMiles in older QGIS releases.
SquareDegrees: Square degrees, for planar geographic CRS area measurements

Available as QgsUnitTypes.AreaSquareDegrees in older QGIS releases.
SquareCentimeters: Square centimeters

Available as QgsUnitTypes.AreaSquareCentimeters in older QGIS releases.
SquareMillimeters: Square millimeters

Available as QgsUnitTypes.AreaSquareMillimeters in older QGIS releases.
SquareInches: Square inches

Added in version 3.32.
Unknown: Unknown areal unit

Available as QgsUnitTypes.AreaUnknownUnit in older QGIS releases.

class AttributeActionType(*values)¶

Bases: IntEnum

Attribute action types.

Prior to QGIS 3.30 this was available as QgsAction.ActionType

Added in version 3.30.

Generic: Generic
GenericPython: Python
Mac: MacOS specific
Windows: Windows specific
Unix: Unix specific
OpenUrl: Open URL action
SubmitUrlEncoded: POST data to an URL, using “application/x-www-form-urlencoded” or “application/json” if the body is valid JSON

Added in version 3.24.
SubmitUrlMultipart: POST data to an URL using “multipart/form-data”

Added in version 3.24.

class AttributeEditorContainerType(*values)¶

Bases: IntEnum

Attribute editor container types.

Added in version 3.32.

GroupBox: A group box
Tab: A tab widget
Row: A row of editors (horizontal layout)

GroupBox = 0¶

Row = 2¶

Tab = 1¶

class AttributeEditorType(*values)¶

Bases: IntEnum

Attribute editor types.

Note

Prior to QGIS 3.32 this was available as QgsAttributeEditorElement.AttributeEditorType.

Added in version 3.32.

Container: A container

Available as QgsAttributeEditorElement.AeTypeContainer in older QGIS releases.
Field: A field

Available as QgsAttributeEditorElement.AeTypeField in older QGIS releases.
Relation: A relation

Available as QgsAttributeEditorElement.AeTypeRelation in older QGIS releases.
QmlElement: A QML element

Available as QgsAttributeEditorElement.AeTypeQmlElement in older QGIS releases.
HtmlElement: A HTML element

Available as QgsAttributeEditorElement.AeTypeHtmlElement in older QGIS releases.
Action: A layer action element

Added in version 3.22.

Available as QgsAttributeEditorElement.AeTypeAction in older QGIS releases.
TextElement: A text element

Added in version 3.30.

Available as QgsAttributeEditorElement.AeTypeTextElement in older QGIS releases.
SpacerElement: A spacer element

Added in version 3.30.

Available as QgsAttributeEditorElement.AeTypeSpacerElement in older QGIS releases.
Invalid: Invalid

Available as QgsAttributeEditorElement.AeTypeInvalid in older QGIS releases.

class AttributeFormLayout(*values)¶

Bases: IntEnum

Available form types for layout of the attribute form editor.

Note

Prior to QGIS 3.32 this was available as QgsEditFormConfig.EditorLayout.

Added in version 3.32.

AutoGenerated: Autogenerate a simple tabular layout for the form

Available as QgsEditFormConfig.GeneratedLayout in older QGIS releases.
DragAndDrop: “Drag and drop” layout. Needs to be configured.

Available as QgsEditFormConfig.TabLayout in older QGIS releases.
UiFile: Load a .ui file for the layout. Needs to be configured.

Available as QgsEditFormConfig.UiFileLayout in older QGIS releases.

class AttributeFormPythonInitCodeSource(*values)¶

Bases: IntEnum

The Python init code source for attribute forms.

Note

Prior to QGIS 3.32 this was available as QgsEditFormConfig.PythonInitCodeSource.

Added in version 3.32.

NoSource: Do not use Python code at all

Available as QgsEditFormConfig.CodeSourceNone in older QGIS releases.
File: Load the Python code from an external file

Available as QgsEditFormConfig.CodeSourceFile in older QGIS releases.
Dialog: Use the Python code provided in the dialog

Available as QgsEditFormConfig.CodeSourceDialog in older QGIS releases.
Environment: Use the Python code available in the Python environment

Available as QgsEditFormConfig.CodeSourceEnvironment in older QGIS releases.

class AttributeFormSuppression(*values)¶

Bases: IntEnum

Available form types for layout of the attribute form editor.

Note

Prior to QGIS 3.32 this was available as QgsEditFormConfig.FeatureFormSuppress.

Added in version 3.32.

Default: Use the application-wide setting.

Available as QgsEditFormConfig.SuppressDefault in older QGIS releases.
On: Always suppress feature form.

Available as QgsEditFormConfig.SuppressOn in older QGIS releases.
Off: Never suppress feature form.

Available as QgsEditFormConfig.SuppressOff in older QGIS releases.

class AuthConfigurationStorageCapabilities¶
class AuthConfigurationStorageCapabilities(f: Qgis.AuthConfigurationStorageCapabilities | Qgis.AuthConfigurationStorageCapability)
class AuthConfigurationStorageCapabilities(a0: Qgis.AuthConfigurationStorageCapabilities): Bases: object

class AuthConfigurationStorageCapability(*values)¶

Bases: IntEnum

Authentication configuration storage capabilities.

Added in version 3.40.

ClearStorage: Can clear all configurations from storage
ReadConfiguration: Can read an authentication configuration
UpdateConfiguration: Can update an authentication configuration
DeleteConfiguration: Can deleet an authentication configuration
CreateConfiguration: Can create a new authentication configuration
ReadCertificateIdentity: Can read a certificate identity
UpdateCertificateIdentity: Can update a certificate identity
DeleteCertificateIdentity: Can delete a certificate identity
CreateCertificateIdentity: Can create a new certificate identity
ReadSslCertificateCustomConfig: Can read a SSL certificate custom config
UpdateSslCertificateCustomConfig: Can update a SSL certificate custom config
DeleteSslCertificateCustomConfig: Can delete a SSL certificate custom config
CreateSslCertificateCustomConfig: Can create a new SSL certificate custom config
ReadCertificateAuthority: Can read a certificate authority
UpdateCertificateAuthority: Can update a certificate authority
DeleteCertificateAuthority: Can delete a certificate authority
CreateCertificateAuthority: Can create a new certificate authority
ReadCertificateTrustPolicy: Can read a certificate trust policy
UpdateCertificateTrustPolicy: Can update a certificate trust policy
DeleteCertificateTrustPolicy: Can delete a certificate trust policy
CreateCertificateTrustPolicy: Can create a new certificate trust policy
ReadMasterPassword: Can read the master password
UpdateMasterPassword: Can update the master password
DeleteMasterPassword: Can delete the master password
CreateMasterPassword: Can create a new master password
ReadSetting: Can read the authentication settings
UpdateSetting: Can update the authentication setting
DeleteSetting: Can delete the authentication setting
CreateSetting: Can create a new authentication setting

ClearStorage = 1¶

CreateCertificateAuthority = 65536¶

CreateCertificateIdentity = 256¶

CreateCertificateTrustPolicy = 1048576¶

CreateConfiguration = 16¶

CreateMasterPassword = 16777216¶

CreateSetting = 268435456¶

CreateSslCertificateCustomConfig = 4096¶

DeleteCertificateAuthority = 32768¶

DeleteCertificateIdentity = 128¶

DeleteCertificateTrustPolicy = 524288¶

DeleteConfiguration = 8¶

DeleteMasterPassword = 8388608¶

DeleteSetting = 134217728¶

DeleteSslCertificateCustomConfig = 2048¶

ReadCertificateAuthority = 8192¶

ReadCertificateIdentity = 32¶

ReadCertificateTrustPolicy = 131072¶

ReadConfiguration = 2¶

ReadMasterPassword = 2097152¶

ReadSetting = 33554432¶

ReadSslCertificateCustomConfig = 512¶

UpdateCertificateAuthority = 16384¶

UpdateCertificateIdentity = 64¶

UpdateCertificateTrustPolicy = 262144¶

UpdateConfiguration = 4¶

UpdateMasterPassword = 4194304¶

UpdateSetting = 67108864¶

UpdateSslCertificateCustomConfig = 1024¶

class AutoRefreshMode(*values)¶

Bases: IntEnum

Map layer automatic refresh modes.

Added in version 3.34.

Disabled: Automatic refreshing is disabled
ReloadData: Reload data (and draw the new data)
RedrawOnly: Redraw current data only

Disabled = 0¶

RedrawOnly = 2¶

ReloadData = 1¶

class AvoidIntersectionsMode(*values)¶

Bases: IntEnum

Flags which control how intersections of pre-existing feature are handled when digitizing new features.

Note

Prior to QGIS 3.26 this was available as QgsProject.AvoidIntersectionsMode

Added in version 3.26.

AllowIntersections: Overlap with any feature allowed when digitizing new features
AvoidIntersectionsCurrentLayer: Overlap with features from the active layer when digitizing new features not allowed
AvoidIntersectionsLayers: Overlap with features from a specified list of layers when digitizing new features not allowed

class Axis(*values)¶

Bases: IntEnum

Cartesian axes.

Added in version 3.34.

X: X-axis
Y: Y-axis
Z: Z-axis

X = 0¶

Y = 1¶

Z = 2¶

class BabelCommandFlag(*values)¶

Bases: IntEnum

Babel command flags, which control how commands and arguments are generated for executing GPSBabel processes.

Added in version 3.22.

QuoteFilePaths: File paths should be enclosed in quotations and escaped

QuoteFilePaths = 1¶

class BabelCommandFlags¶
class BabelCommandFlags(f: Qgis.BabelCommandFlags | Qgis.BabelCommandFlag)
class BabelCommandFlags(a0: Qgis.BabelCommandFlags): Bases: object

class BabelFormatCapabilities¶
class BabelFormatCapabilities(f: Qgis.BabelFormatCapabilities | Qgis.BabelFormatCapability)
class BabelFormatCapabilities(a0: Qgis.BabelFormatCapabilities): Bases: object

class BabelFormatCapability(*values)¶

Bases: IntEnum

Babel GPS format capabilities.

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

class BetweenLineConstraint(*values)¶

Bases: IntEnum

Between line constraints which can be enabled

Added in version 3.26.

NoConstraint: No additional constraint
Perpendicular: Perpendicular
Parallel: Parallel

class BlendMode(*values)¶

Bases: IntEnum

Blending modes defining the available composition modes that can be used when painting.

Note

Prior to QGIS 3.30 this was available as QgsPainting.BlendMode.

Added in version 3.30.

Normal: Normal

Available as QgsPainting.BlendNormal in older QGIS releases.
Lighten: Lighten

Available as QgsPainting.BlendLighten in older QGIS releases.
Screen: Screen

Available as QgsPainting.BlendScreen in older QGIS releases.
Dodge: Dodge

Available as QgsPainting.BlendDodge in older QGIS releases.
Addition: Addition

Available as QgsPainting.BlendAddition in older QGIS releases.
Darken: Darken

Available as QgsPainting.BlendDarken in older QGIS releases.
Multiply: Multiple

Available as QgsPainting.BlendMultiply in older QGIS releases.
Burn: Burn

Available as QgsPainting.BlendBurn in older QGIS releases.
Overlay: Overlay

Available as QgsPainting.BlendOverlay in older QGIS releases.
SoftLight: Soft light

Available as QgsPainting.BlendSoftLight in older QGIS releases.
HardLight: Hard light

Available as QgsPainting.BlendHardLight in older QGIS releases.
Difference: Difference

Available as QgsPainting.BlendDifference in older QGIS releases.
Subtract: Subtract

Available as QgsPainting.BlendSubtract in older QGIS releases.
Source: Source

Available as QgsPainting.BlendSource in older QGIS releases.
DestinationOver: Destination over

Available as QgsPainting.BlendDestinationOver in older QGIS releases.
Clear: Clear

Available as QgsPainting.BlendClear in older QGIS releases.
Destination: Destination

Available as QgsPainting.BlendDestination in older QGIS releases.
SourceIn: Source in

Available as QgsPainting.BlendSourceIn in older QGIS releases.
DestinationIn: Destination in

Available as QgsPainting.BlendDestinationIn in older QGIS releases.
SourceOut: Source out

Available as QgsPainting.BlendSourceOut in older QGIS releases.
DestinationOut: Destination out

Available as QgsPainting.BlendDestinationOut in older QGIS releases.
SourceAtop: Source atop

Available as QgsPainting.BlendSourceAtop in older QGIS releases.
DestinationAtop: Destination atop

Available as QgsPainting.BlendDestinationAtop in older QGIS releases.
Xor: XOR

Available as QgsPainting.BlendXor in older QGIS releases.

class BrowserDirectoryMonitoring(*values)¶

Bases: IntEnum

Browser directory item monitoring switches.

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

class BrowserItemCapabilities¶
class BrowserItemCapabilities(f: Qgis.BrowserItemCapabilities | Qgis.BrowserItemCapability)
class BrowserItemCapabilities(a0: Qgis.BrowserItemCapabilities): Bases: object

class BrowserItemCapability(*values)¶

Bases: IntEnum

Browser item capabilities.

Added 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

Added in version 3.22.
RefreshChildrenWhenItemIsRefreshed: When the item is refreshed, all its populated children will also be refreshed in turn

Added in version 3.26.
ReadOnly: Item is read only

Added in version 3.40.

class BrowserItemState(*values)¶

Bases: IntEnum

Browser item states.

Added in version 3.20.

NotPopulated: Children not yet created
Populating: Creating children in separate thread (populating or refreshing)
Populated: Children created

class BrowserItemType(*values)¶

Bases: IntEnum

Browser item types.

Added 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

class BrowserLayerType(*values)¶

Bases: IntEnum

Browser item layer types

Added 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
TiledScene: Tiled scene layer

Added in version 3.34.

class BufferSide(*values)¶

Bases: IntEnum

Side of line to buffer.

Added in version 3.22.

Left: Buffer to left of line

Available as QgsGeometry.SideLeft in older QGIS releases.
Right: Buffer to right of line

Available as QgsGeometry.SideRight in older QGIS releases.

class CadConstraintType(*values)¶

Bases: IntEnum

Advanced digitizing constraint type.

Added in version 3.32.

Generic: Generic value
Angle: Angle value
Distance: Distance value
XCoordinate: X Coordinate value
YCoordinate: Y Coordinate value
ZValue: Z value
MValue: M value

Angle = 1¶

Distance = 2¶

Generic = 0¶

MValue = 6¶

XCoordinate = 3¶

YCoordinate = 4¶

ZValue = 5¶

class Capitalization(*values)¶

Bases: IntEnum

String capitalization options.

Note

Prior to QGIS 3.24 this was available as QgsStringUtils.Capitalization

Added in version 3.24.

MixedCase: Mixed case, ie no change
AllUppercase: Convert all characters to uppercase
AllLowercase: Convert all characters to lowercase
ForceFirstLetterToCapital: Convert just the first letter of each word to uppercase, leave the rest untouched
SmallCaps: Mixed case small caps

Added in version 3.24.
TitleCase: Simple title case conversion - does not fully grammatically parse the text and uses simple rules only. Note that this method does not convert any characters to lowercase, it only uppercases required letters. Callers must ensure that input strings are already lowercased.
UpperCamelCase: Convert the string to upper camel case. Note that this method does not unaccent characters.
AllSmallCaps: Force all characters to small caps

Added in version 3.24.

class CaptureTechnique(*values)¶

Bases: IntEnum

Capture technique.

Added in version 3.26.

StraightSegments: Default capture mode - capture occurs with straight line segments
CircularString: Capture in circular strings
Streaming: Streaming points digitizing mode (points are automatically added as the mouse cursor moves).
Shape: Digitize shapes.

class ColorModel(*values)¶

Bases: IntEnum

Color model types

Added in version 3.40.

Rgb: RGB color model
Cmyk: CMYK color model

Cmyk = 1¶

Rgb = 0¶

class ContentStatus(*values)¶

Bases: IntEnum

Status for fetched or stored content

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

class CoordinateDisplayType(*values)¶

Bases: IntEnum

Formats for displaying coordinates

Added in version 3.28.

MapCrs: Map CRS
MapGeographic: Map Geographic CRS equivalent (stays unchanged if the map CRS is geographic)
CustomCrs: Custom CRS

CustomCrs = 2¶

MapCrs = 0¶

MapGeographic = 1¶

class CoordinateOrder(*values)¶

Bases: IntEnum

Order of coordinates.

Added in version 3.26.

Default: Respect the default axis ordering for the CRS, as defined in the CRS’s parameters
XY: Easting/Northing (or Longitude/Latitude for geographic CRS)
YX: Northing/Easting (or Latitude/Longitude for geographic CRS)

Default = 0¶

XY = 1¶

YX = 2¶

class CoordinateTransformationFlag(*values)¶

Bases: IntEnum

Flags which adjust the coordinate transformations behave.

Added in version 3.26.

BallparkTransformsAreAppropriate: Indicates that approximate “ballpark” results are appropriate for this coordinate transform. See QgsCoordinateTransform.setBallparkTransformsAreAppropriate() for further details.
IgnoreImpossibleTransformations: Indicates that impossible transformations (such as those which attempt to transform between two different celestial bodies) should be silently handled and marked as invalid. See QgsCoordinateTransform.isTransformationPossible() and QgsCoordinateTransform.isValid().

BallparkTransformsAreAppropriate = 1¶

IgnoreImpossibleTransformations = 2¶

class CoordinateTransformationFlags¶
class CoordinateTransformationFlags(f: Qgis.CoordinateTransformationFlags | Qgis.CoordinateTransformationFlag)
class CoordinateTransformationFlags(a0: Qgis.CoordinateTransformationFlags): Bases: object

class CoverageValidityResult(*values)¶

Bases: IntEnum

Coverage validity results.

Added in version 3.36.

Invalid: Coverage is invalid. Invalidity includes polygons that overlap, that have gaps smaller than the gap width, or non-polygonal entries in the input collection.
Valid: Coverage is valid
Error: An exception occurred while determining validity

Error = 2¶

Invalid = 0¶

Valid = 1¶

Critical = 2¶

class CrsAxisDirection(*values)¶

Bases: IntEnum

Coordinate reference system axis directions.

From “Geographic information — Well-known text representation of coordinate reference systems”, section 7.5.1.

Added in version 3.26.

North: North
NorthNorthEast: North North East
NorthEast: North East
EastNorthEast: East North East
East: East
EastSouthEast: East South East
SouthEast: South East
SouthSouthEast: South South East
South: South
SouthSouthWest: South South West
SouthWest: South West
WestSouthWest: West South West
West: West
WestNorthWest: West North West
NorthWest: North West
NorthNorthWest: North North West
GeocentricX: Geocentric (X)
GeocentricY: Geocentric (Y)
GeocentricZ: Geocentric (Z)
Up: Up
Down: Down
Forward: Forward
Aft: Aft
Port: Port
Starboard: Starboard
Clockwise: Clockwise
CounterClockwise: Counter clockwise
ColumnPositive: Column positive
ColumnNegative: Column negative
RowPositive: Row positive
RowNegative: Row negative
DisplayRight: Display right
DisplayLeft: Display left
DisplayUp: Display up
DisplayDown: Display down
Future: Future
Past: Past
Towards: Towards
AwayFrom: Away from
Unspecified: Unspecified

Aft = 22¶

AwayFrom = 38¶

Clockwise = 25¶

ColumnNegative = 28¶

ColumnPositive = 27¶

CounterClockwise = 26¶

DisplayDown = 34¶

DisplayLeft = 32¶

DisplayRight = 31¶

DisplayUp = 33¶

Down = 20¶

East = 4¶

EastNorthEast = 3¶

EastSouthEast = 5¶

Forward = 21¶

Future = 35¶

GeocentricX = 16¶

GeocentricY = 17¶

GeocentricZ = 18¶

North = 0¶

NorthEast = 2¶

NorthNorthEast = 1¶

NorthNorthWest = 15¶

NorthWest = 14¶

Past = 36¶

Port = 23¶

RowNegative = 30¶

RowPositive = 29¶

South = 8¶

SouthEast = 6¶

SouthSouthEast = 7¶

SouthSouthWest = 9¶

SouthWest = 10¶

Starboard = 24¶

Towards = 37¶

Unspecified = 39¶

Up = 19¶

West = 12¶

WestNorthWest = 13¶

WestSouthWest = 11¶

class CrsDefinitionFormat(*values)¶

Bases: IntEnum

CRS definition formats.

Added in version 3.24.

Wkt: WKT format (always recommended over proj string format)

Available as QgsCoordinateReferenceSystem.FormatWkt in older QGIS releases.
Proj: Proj string format

Available as QgsCoordinateReferenceSystem.FormatProj in older QGIS releases.

class CrsIdentifierType(*values)¶

Bases: IntEnum

Available identifier string types for representing coordinate reference systems

Note

Prior to QGIS 3.36 this was available as QgsCoordinateReferenceSystem.IdentifierType

Added in version 3.36.

ShortString: A heavily abbreviated string, for use when a compact representation is required
MediumString: A medium-length string, recommended for general purpose use
FullString: Full definition – possibly a very lengthy string, e.g. with no truncation of custom WKT definitions

class CrsType(*values)¶

Bases: IntEnum

Coordinate reference system types.

Contains a subset of Proj’s PJ_TYPE enum, specifically the types which relate to CRS types.

Added in version 3.34.

Unknown: Unknown type
Geodetic: Geodetic CRS
Geocentric: Geocentric CRS
Geographic2d: 2D geographic CRS
Geographic3d: 3D geopraphic CRS
Vertical: Vertical CRS
Projected: Projected CRS
Compound: Compound (horizontal + vertical) CRS
Temporal: Temporal CRS
Engineering: Engineering CRS
Bound: Bound CRS
Other: Other type
DerivedProjected: Derived projected CRS

Bound = 10¶

Compound = 7¶

DerivedProjected = 12¶

Engineering = 9¶

Geocentric = 2¶

Geodetic = 1¶

Geographic2d = 3¶

Geographic3d = 4¶

Other = 11¶

Projected = 6¶

Temporal = 8¶

Unknown = 0¶

Vertical = 5¶

class CrsWktVariant(*values)¶

Bases: IntEnum

Coordinate reference system WKT formatting variants.

Note

Prior to QGIS 3.36 this was available as QgsCoordinateReferenceSystem.WktVariant

Added in version 3.36.

Wkt1Gdal: WKT1 as traditionally output by GDAL, deriving from OGC 01-009. A notable departure from WKT1_GDAL with respect to OGC 01-009 is that in WKT1_GDAL, the unit of the PRIMEM value is always degrees.

Available as QgsCoordinateReferenceSystem.WKT1_GDAL in older QGIS releases.
Wkt1Esri: WKT1 as traditionally output by ESRI software, deriving from OGC 99-049.

Available as QgsCoordinateReferenceSystem.WKT1_ESRI in older QGIS releases.
Wkt2_2015: Full WKT2 string, conforming to ISO 19162:2015(E) / OGC 12-063r5 with all possible nodes and new keyword names.

Available as QgsCoordinateReferenceSystem.WKT2_2015 in older QGIS releases.
Wkt2_2015Simplified: Same as WKT2_2015 with the following exceptions: UNIT keyword used. ID node only on top element. No ORDER element in AXIS element. PRIMEM node omitted if it is Greenwich. ELLIPSOID.UNIT node omitted if it is UnitOfMeasure.METRE. PARAMETER.UNIT / PRIMEM.UNIT omitted if same as AXIS. AXIS.UNIT omitted and replaced by a common GEODCRS.UNIT if they are all the same on all axis.

Available as QgsCoordinateReferenceSystem.WKT2_2015_SIMPLIFIED in older QGIS releases.
Wkt2_2019: Full WKT2 string, conforming to ISO 19162:2019 / OGC 18-010, with all possible nodes and new keyword names. Non-normative list of differences: WKT2_2019 uses GEOGCRS / BASEGEOGCRS keywords for GeographicCRS.

Available as QgsCoordinateReferenceSystem.WKT2_2019 in older QGIS releases.
Wkt2_2019Simplified: WKT2_2019 with the simplification rule of WKT2_SIMPLIFIED

Available as QgsCoordinateReferenceSystem.WKT2_2019_SIMPLIFIED in older QGIS releases.
Preferred: Preferred format, matching the most recent WKT ISO standard. Currently an alias to WKT2_2019, but may change in future versions.

Available as QgsCoordinateReferenceSystem.WKT_PREFERRED in older QGIS releases.
PreferredSimplified: Preferred simplified format, matching the most recent WKT ISO standard. Currently an alias to WKT2_2019_SIMPLIFIED, but may change in future versions.

Available as QgsCoordinateReferenceSystem.WKT_PREFERRED_SIMPLIFIED in older QGIS releases.
PreferredGdal: Preferred format for conversion of CRS to WKT for use with the GDAL library.

Available as QgsCoordinateReferenceSystem.WKT_PREFERRED_GDAL in older QGIS releases.

DEFAULT_HIGHLIGHT_BUFFER_MM = 0.5¶: Default highlight buffer in mm.

DEFAULT_HIGHLIGHT_COLOR = <QColor: RGBA 255, 0, 0, 128>¶: Default highlight color. The transparency is expected to only be applied to polygon fill. Lines and outlines are rendered opaque.

DEFAULT_HIGHLIGHT_MIN_WIDTH_MM = 1.0¶: Default highlight line/stroke minimum width in mm.

DEFAULT_MAPTOPIXEL_THRESHOLD = 1.0¶: Default threshold between map coordinates and device coordinates for map2pixel simplification

DEFAULT_M_COORDINATE = 0.0¶: Default M coordinate value. This value have to be assigned to the M coordinate for the vertex.

Added in version 3.20.

DEFAULT_SEARCH_RADIUS_MM = 2.0¶: Identify search radius in mm

DEFAULT_SNAP_TOLERANCE = 12.0¶: Default snapping distance tolerance.

DEFAULT_Z_COORDINATE = 0.0¶: Default Z coordinate value. This value have to be assigned to the Z coordinate for the vertex.

class DashPatternLineEndingRule(*values)¶

Bases: IntEnum

Dash pattern line ending rules.

Added in version 3.24.

NoRule: No special rule
FullDash: Start or finish the pattern with a full dash
HalfDash: Start or finish the pattern with a half length dash
FullGap: Start or finish the pattern with a full gap
HalfGap: Start or finish the pattern with a half length gap

FullDash = 1¶

FullGap = 3¶

HalfDash = 2¶

HalfGap = 4¶

NoRule = 0¶

class DashPatternSizeAdjustment(*values)¶

Bases: IntEnum

Dash pattern size adjustment options.

Added in version 3.24.

ScaleBothDashAndGap: Both the dash and gap lengths are adjusted equally
ScaleDashOnly: Only dash lengths are adjusted
ScaleGapOnly: Only gap lengths are adjusted

ScaleBothDashAndGap = 0¶

ScaleDashOnly = 1¶

ScaleGapOnly = 2¶

class DataItemProviderCapabilities¶
class DataItemProviderCapabilities(f: Qgis.DataItemProviderCapabilities | Qgis.DataItemProviderCapability)
class DataItemProviderCapabilities(a0: Qgis.DataItemProviderCapabilities): Bases: object

class DataItemProviderCapability(*values)¶

Bases: IntEnum

Capabilities for data item providers.

Note

Prior to QGIS 3.36 this was available as QgsDataProvider.DataCapability

Added in version 3.36.

NoCapabilities: No capabilities

Available as QgsDataProvider.NoDataCapabilities in older QGIS releases.
Files: Can provides items which corresponds to files

Available as QgsDataProvider.File in older QGIS releases.
Directories: Can provides items which corresponds to directories

Available as QgsDataProvider.Dir in older QGIS releases.
Databases: Can provides items which corresponds to databases

Available as QgsDataProvider.Database in older QGIS releases.
NetworkSources: Network/internet source

Available as QgsDataProvider.Net in older QGIS releases.

class DataProviderFlag(*values)¶

Bases: IntEnum

Generic data provider flags.

Added in version 3.26.

IsBasemapSource: Associated source should be considered a ‘basemap’ layer. See Qgis.MapLayerProperty.IsBasemapLayer.
FastExtent2D: Provider’s 2D extent retrieval via QgsDataProvider.extent() is always guaranteed to be trivial/fast to calculate

Added in version 3.38.
FastExtent3D: Provider’s 3D extent retrieval via QgsDataProvider.extent3D() is always guaranteed to be trivial/fast to calculate

Added in version 3.38.

FastExtent2D = 4¶

FastExtent3D = 8¶

IsBasemapSource = 2¶

class DataProviderFlags¶
class DataProviderFlags(f: Qgis.DataProviderFlags | Qgis.DataProviderFlag)
class DataProviderFlags(a0: Qgis.DataProviderFlags): Bases: object

class DataProviderReadFlag(*values)¶

Bases: IntEnum

Flags which control data provider construction.

Note

Prior to QGIS 3.40 this was available as QgsDataProvider.ReadFlag

Added in version 3.40.

TrustDataSource: Trust datasource config (primary key unicity, geometry type and srid, etc). Improves provider load time by skipping expensive checks like primary key unicity, geometry type and srid and by using estimated metadata on data load

Added in version 3.16.

Available as QgsDataProvider.FlagTrustDataSource in older QGIS releases.
SkipFeatureCount: Make featureCount() return -1 to indicate unknown, and subLayers() to return a unknown feature count as well. Since QGIS 3.18. Only implemented by OGR provider at time of writing.
LoadDefaultStyle: Reset the layer’s style to the default for the datasource

Available as QgsDataProvider.FlagLoadDefaultStyle in older QGIS releases.
SkipGetExtent: Skip the extent from provider
SkipFullScan: Skip expensive full scan on files (i.e. on delimited text)

Added in version 3.24.
ForceReadOnly: Open layer in a read-only mode

Added in version 3.28.
SkipCredentialsRequest: Skip credentials if the provided one are not valid, let the provider be invalid, avoiding to block the thread creating the provider if it is not the main thread

Added in version 3.32.
ParallelThreadLoading: Provider is created in a parallel thread than the one where it will live

Added in version 3.32.1.

class DataProviderReadFlags¶
class DataProviderReadFlags(f: Qgis.DataProviderReadFlags | Qgis.DataProviderReadFlag)
class DataProviderReadFlags(a0: Qgis.DataProviderReadFlags): Bases: object

class DataType(*values)¶

Bases: IntEnum

Raster data types. This is modified and extended copy of GDALDataType.

UnknownDataType: Unknown or unspecified type
Byte: Eight bit unsigned integer (quint8)
Int8: Eight bit signed integer (qint8) (added in QGIS 3.30)
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

class DatabaseProviderConnectionCapabilities2¶
class DatabaseProviderConnectionCapabilities2(f: Qgis.DatabaseProviderConnectionCapabilities2 | Qgis.DatabaseProviderConnectionCapability2)
class DatabaseProviderConnectionCapabilities2(a0: Qgis.DatabaseProviderConnectionCapabilities2): Bases: object

class DatabaseProviderConnectionCapability2(*values)¶

Bases: IntEnum

The Capability enum represents the extended operations supported by the connection.

Added in version 3.32.

SetFieldComment: Can set comments for fields via setFieldComment()
SetFieldAlias: Can set aliases for fields via setFieldAlias()

SetFieldAlias = 2¶

SetFieldComment = 1¶

class DateTimeStatistic(*values)¶

Bases: IntEnum

Available date/time statistics.

Added in version 3.36..

Count: Count
CountDistinct: Number of distinct datetime values
CountMissing: Number of missing (null) values
Min: Minimum (earliest) datetime value
Max: Maximum (latest) datetime value
Range: Interval between earliest and latest datetime value
All: All statistics

class DateTimeStatistics¶
class DateTimeStatistics(f: Qgis.DateTimeStatistics | Qgis.DateTimeStatistic)
class DateTimeStatistics(a0: Qgis.DateTimeStatistics): Bases: object

class DeviceConnectionStatus(*values)¶

Bases: IntEnum

GPS connection status.

Added in version 3.30.

Disconnected: Device is disconnected
Connecting: Device is connecting
Connected: Device is successfully connected

class DistanceUnit(*values)¶

Bases: IntEnum

Units of distance

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes.DistanceUnit.

Added in version 3.30.

Meters: Meters

Available as QgsUnitTypes.DistanceMeters in older QGIS releases.
Kilometers: Kilometers

Available as QgsUnitTypes.DistanceKilometers in older QGIS releases.
Feet: Imperial feet

Available as QgsUnitTypes.DistanceFeet in older QGIS releases.
NauticalMiles: Nautical miles

Available as QgsUnitTypes.DistanceNauticalMiles in older QGIS releases.
Yards: Imperial yards

Available as QgsUnitTypes.DistanceYards in older QGIS releases.
Miles: Terrestrial miles

Available as QgsUnitTypes.DistanceMiles in older QGIS releases.
Degrees: Degrees, for planar geographic CRS distance measurements

Available as QgsUnitTypes.DistanceDegrees in older QGIS releases.
Centimeters: Centimeters

Available as QgsUnitTypes.DistanceCentimeters in older QGIS releases.
Millimeters: Millimeters

Available as QgsUnitTypes.DistanceMillimeters in older QGIS releases.
Inches: Inches

Added in version 3.32.
ChainsInternational: International chains

Added in version 3.40.
ChainsBritishBenoit1895A: British chains (Benoit 1895 A)

Added in version 3.40.
ChainsBritishBenoit1895B: British chains (Benoit 1895 B)

Added in version 3.40.
ChainsBritishSears1922Truncated: British chains (Sears 1922 truncated)

Added in version 3.40.
ChainsBritishSears1922: British chains (Sears 1922)

Added in version 3.40.
ChainsClarkes: Clarke’s chains

Added in version 3.40.
ChainsUSSurvey: US Survey chains

Added in version 3.40.
FeetBritish1865: British feet (1865)

Added in version 3.40.
FeetBritish1936: British feet (1936)

Added in version 3.40.
FeetBritishBenoit1895A: British feet (Benoit 1895 A)

Added in version 3.40.
FeetBritishBenoit1895B: British feet (Benoit 1895 B)

Added in version 3.40.
FeetBritishSears1922Truncated: British feet (Sears 1922 truncated)

Added in version 3.40.
FeetBritishSears1922: British feet (Sears 1922)

Added in version 3.40.
FeetClarkes: Clarke’s feet

Added in version 3.40.
FeetGoldCoast: Gold Coast feet

Added in version 3.40.
FeetIndian: Indian (geodetic) feet

Added in version 3.40.
FeetIndian1937: Indian feet (1937)

Added in version 3.40.
FeetIndian1962: Indian feet (1962)

Added in version 3.40.
FeetIndian1975: Indian feet (1975)

Added in version 3.40.
FeetUSSurvey: US Survey feet

Added in version 3.40.
LinksInternational: International links

Added in version 3.40.
LinksBritishBenoit1895A: British links (Benoit 1895 A)

Added in version 3.40.
LinksBritishBenoit1895B: British links (Benoit 1895 B)

Added in version 3.40.
LinksBritishSears1922Truncated: British links (Sears 1922 truncated)

Added in version 3.40.
LinksBritishSears1922: British links (Sears 1922)

Added in version 3.40.
LinksClarkes: Clarke’s links

Added in version 3.40.
LinksUSSurvey: US Survey links

Added in version 3.40.
YardsBritishBenoit1895A: British yards (Benoit 1895 A)

Added in version 3.40.
YardsBritishBenoit1895B: British yards (Benoit 1895 B)

Added in version 3.40.
YardsBritishSears1922Truncated: British yards (Sears 1922 truncated)

Added in version 3.40.
YardsBritishSears1922: British yards (Sears 1922)

Added in version 3.40.
YardsClarkes: Clarke’s yards

Added in version 3.40.
YardsIndian: Indian yards

Added in version 3.40.
YardsIndian1937: Indian yards (1937)

Added in version 3.40.
YardsIndian1962: Indian yards (1962)

Added in version 3.40.
YardsIndian1975: Indian yards (1975)

Added in version 3.40.
MilesUSSurvey: US Survey miles

Added in version 3.40.
Fathoms: Fathoms

Added in version 3.40.
MetersGermanLegal: German legal meter

Added in version 3.40.
Unknown: Unknown distance unit

Available as QgsUnitTypes.DistanceUnknownUnit in older QGIS releases.

class DistanceUnitType(*values)¶

Bases: IntEnum

Types of distance units

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes.DistanceUnitType.

Added in version 3.30.

Standard: Unit is a standard measurement unit
Geographic: Unit is a geographic (e.g., degree based) unit
Unknown: Unknown unit type

Available as QgsUnitTypes.UnknownType in older QGIS releases.

class DpiMode(*values)¶

Bases: IntEnum

DpiMode enum

Added in version 3.26.

All: All
Off: Off
QGIS: QGIS
UMN: UMN
GeoServer: GeoServer

All = 7¶

GeoServer = 4¶

Off = 0¶

QGIS = 1¶

UMN = 2¶

class DriveType(*values)¶

Bases: IntEnum

Drive types

Added 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
Cloud: Cloud storage – files may be remote or locally stored, depending on user configuration

CdRom = 5¶

Cloud = 7¶

Fixed = 3¶

Invalid = 1¶

RamDisk = 6¶

Remote = 4¶

Removable = 2¶

Unknown = 0¶

class ElevationMapCombineMethod(*values)¶

Bases: IntEnum

Methods used to select the elevation when two elevation maps are combined

Added in version 3.30.

HighestElevation: Keep the highest elevation if it is not null
NewerElevation: Keep the new elevation regardless of its value if it is not null

HighestElevation = 0¶

NewerElevation = 1¶

class EndCapStyle(*values)¶

Bases: IntEnum

End cap styles for buffers.

Added in version 3.22.

Round: Round cap

Available as QgsGeometry.CapRound in older QGIS releases.
Flat: Flat cap (in line with start/end of line)

Available as QgsGeometry.CapFlat in older QGIS releases.
Square: Square cap (extends past start/end of line by buffer distance)

Available as QgsGeometry.CapSquare in older QGIS releases.

class ExpressionType(*values)¶

Bases: IntEnum

Expression types

Added in version 3.32.

Qgis: Native QGIS expression
PointCloud: Point cloud expression
RasterCalculator: Raster calculator expression

Added in version 3.34.

PointCloud = 1¶

Qgis = 0¶

RasterCalculator = 2¶

class FeatureAvailability(*values)¶

Bases: IntEnum

Possible return value for QgsFeatureSource.hasFeatures() to determine if a source is empty.

It is implemented as a three-value logic, so it can return if there are features available for sure, if there are no features available for sure or if there might be features available but there is no guarantee for this.

Note

Prior to QGIS 3.36 this was available as QgsFeatureSource.FeatureAvailability

Added in version 3.36.

NoFeaturesAvailable: There are certainly no features available in this source
FeaturesAvailable: There is at least one feature available in this source
FeaturesMaybeAvailable: There may be features available in this source

class FeatureCountState(*values)¶

Bases: IntEnum

Enumeration of feature count states

Added in version 3.20.

Uncounted: Feature count not yet computed
UnknownCount: Provider returned an unknown feature count

class FeatureRendererFlag(*values)¶

Bases: IntEnum

Flags controlling behavior of vector feature renderers.

Added in version 3.40.

AffectsLabeling: If present, indicates that the renderer will participate in the map labeling problem

AffectsLabeling = 1¶

class FeatureRendererFlags¶
class FeatureRendererFlags(f: Qgis.FeatureRendererFlags | Qgis.FeatureRendererFlag)
class FeatureRendererFlags(a0: Qgis.FeatureRendererFlags): Bases: object

class FeatureRequestFilterType(*values)¶

Bases: IntEnum

Types of feature request filters.

Note

Prior to QGIS 3.36 this was available as QgsFeatureRequest.FilterType

Added in version 3.36.

NoFilter: No filter is applied

Available as QgsFeatureRequest.FilterNone in older QGIS releases.
Fid: Filter using feature ID

Available as QgsFeatureRequest.FilterFid in older QGIS releases.
Expression: Filter using expression

Available as QgsFeatureRequest.FilterExpression in older QGIS releases.
Fids: Filter using feature IDs

Available as QgsFeatureRequest.FilterFids in older QGIS releases.

class FeatureRequestFlag(*values)¶

Bases: IntEnum

Flags for controlling feature requests.

Note

Prior to QGIS 3.36 this was available as QgsFeatureRequest.Flag

Added in version 3.36.

NoFlags: No flags are set
NoGeometry: Geometry is not required. It may still be returned if e.g. required for a filter condition.
SubsetOfAttributes: Fetch only a subset of attributes (setSubsetOfAttributes sets this flag)
ExactIntersect: Use exact geometry intersection (slower) instead of bounding boxes
IgnoreStaticNodesDuringExpressionCompilation: If a feature request uses a filter expression which can be partially precalculated due to static nodes in the expression, setting this flag will prevent these precalculated values from being utilized during compilation of the filter for the backend provider. This flag significantly slows down feature requests and should be used for debugging purposes only.

Added in version 3.18.
EmbeddedSymbols: Retrieve any embedded feature symbology

Added in version 3.20.

class FeatureRequestFlags¶
class FeatureRequestFlags(f: Qgis.FeatureRequestFlags | Qgis.FeatureRequestFlag)
class FeatureRequestFlags(a0: Qgis.FeatureRequestFlags): Bases: object

class FeatureSymbologyExport(*values)¶

Bases: IntEnum

Options for exporting features considering their symbology.

Note

Prior to QGIS 3.32 this was available as QgsVectorFileWriter.SymbologyExport.

Added in version 3.32.

NoSymbology: Export only data
PerFeature: Keeps the number of features and export symbology per feature

Available as QgsVectorFileWriter.FeatureSymbology in older QGIS releases.
PerSymbolLayer: Exports one feature per symbol layer (considering symbol levels)

Available as QgsVectorFileWriter.SymbolLayerSymbology in older QGIS releases.

class FieldConfigurationFlag(*values)¶

Bases: IntEnum

Configuration flags for fields These flags are meant to be user-configurable and are not describing any information from the data provider.

Note

FieldConfigurationFlag are expressed in the negative forms so that default flags is NoFlag.

Added in version 3.34.

NoFlag: No flag is defined
NotSearchable: Defines if the field is searchable (used in the locator search for instance)
HideFromWms: Field is not available if layer is served as WMS from QGIS server
HideFromWfs: Field is not available if layer is served as WFS from QGIS server

HideFromWfs = 8¶

HideFromWms = 4¶

NoFlag = 0¶

NotSearchable = 2¶

class FieldConfigurationFlags¶
class FieldConfigurationFlags(f: Qgis.FieldConfigurationFlags | Qgis.FieldConfigurationFlag)
class FieldConfigurationFlags(a0: Qgis.FieldConfigurationFlags): Bases: object

class FieldDomainMergePolicy(*values)¶

Bases: IntEnum

Merge policy for field domains.

When a feature is built by merging multiple features, defines how the value of attributes following the domain are computed.

Added in version 3.26.

DefaultValue: Use default field value
Sum: Sum of values
GeometryWeighted: New values are computed as the weighted average of the source values

DefaultValue = 0¶

GeometryWeighted = 2¶

Sum = 1¶

class FieldDomainSplitPolicy(*values)¶

Bases: IntEnum

Split policy for field domains.

When a feature is split into multiple parts, defines how the value of attributes following the domain are computed.

Added in version 3.26.

DefaultValue: Use default field value
Duplicate: Duplicate original value
GeometryRatio: New values are computed by the ratio of their area/length compared to the area/length of the original feature
UnsetField: Clears the field value so that the data provider backend will populate using any backend triggers or similar logic

Added in version 3.30.

DefaultValue = 0¶

Duplicate = 1¶

GeometryRatio = 2¶

UnsetField = 3¶

class FieldDomainType(*values)¶

Bases: IntEnum

Types of field domain

Added in version 3.26.

Coded: Coded field domain
Range: Numeric range field domain (min/max)
Glob: Glob string pattern field domain

Coded = 0¶

Glob = 2¶

Range = 1¶

class FieldDuplicatePolicy(*values)¶

Bases: IntEnum

Duplicate policy for fields.

When a feature is duplicated, defines how the value of attributes are computed.

Added in version 3.38.

DefaultValue: Use default field value
Duplicate: Duplicate original value
UnsetField: Clears the field value so that the data provider backend will populate using any backend triggers or similar logic

Added in version 3.30.

DefaultValue = 0¶

Duplicate = 1¶

UnsetField = 2¶

class FieldMetadataProperty(*values)¶

Bases: IntEnum

Standard field metadata values.

Added in version 3.30.

GeometryCrs: Available for geometry field types with a specific associated coordinate reference system (as a QgsCoordinateReferenceSystem value)
GeometryWkbType: Available for geometry field types which accept geometries of a specific WKB type only (as a QgsWkbTypes.Type value)
CustomProperty: Starting point for custom user set properties

CustomProperty = 1048576¶

GeometryCrs = 4096¶

GeometryWkbType = 4097¶

class FieldOrigin(*values)¶

Bases: IntEnum

Field origin.

Note

Prior to QGIS 3.38 this was available as QgsFields.FieldOrigin

Added in version 3.38.

Unknown: The field origin has not been specified

Available as QgsFields.OriginUnknown in older QGIS releases.
Provider: Field originates from the underlying data provider of the vector layer

Available as QgsFields.OriginProvider in older QGIS releases.
Join: Field originates from a joined layer

Available as QgsFields.OriginJoin in older QGIS releases.
Edit: Field has been temporarily added in editing mode

Available as QgsFields.OriginEdit in older QGIS releases.
Expression: Field is calculated from an expression

Available as QgsFields.OriginExpression in older QGIS releases.

class FileFilterType(*values)¶

Bases: IntEnum

Type of file filters

Prior to QGIS 3.32 this was available as QgsProviderMetadata.FilterType

Added in version 3.32.

Vector: Vector layers

Available as QgsProviderMetadata.FilterVector in older QGIS releases.
Raster: Raster layers

Available as QgsProviderMetadata.FilterRaster in older QGIS releases.
Mesh: Mesh layers

Available as QgsProviderMetadata.FilterMesh in older QGIS releases.
MeshDataset: Mesh datasets

Available as QgsProviderMetadata.FilterMeshDataset in older QGIS releases.
PointCloud: Point clouds

Added in version 3.18.

Available as QgsProviderMetadata.FilterPointCloud in older QGIS releases.
VectorTile: Vector tile layers

Added in version 3.32.
TiledScene: Tiled scene layers

Added in version 3.34.

class FileOperationFlag(*values)¶

Bases: IntEnum

File operation flags.

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

class FileOperationFlags¶
class FileOperationFlags(f: Qgis.FileOperationFlags | Qgis.FileOperationFlag)
class FileOperationFlags(a0: Qgis.FileOperationFlags): Bases: object

class FilePathType(*values)¶

Bases: IntEnum

File path types.

Added in version 3.22.

Absolute: Absolute path
Relative: Relative path

Absolute = 0¶

Relative = 1¶

class GdalResampleAlgorithm(*values)¶

Bases: IntEnum

Resampling algorithm to be used (equivalent to GDAL’s enum GDALResampleAlg)

Note

RA_Max, RA_Min, RA_Median, RA_Q1 and RA_Q3 are available on GDAL >= 2.0 builds only

Added in version 3.34.

RA_NearestNeighbour: Nearest neighbour (select on one input pixel)
RA_Bilinear: Bilinear (2x2 kernel)
RA_Cubic: Cubic Convolution Approximation (4x4 kernel)
RA_CubicSpline: Cubic B-Spline Approximation (4x4 kernel)
RA_Lanczos: Lanczos windowed sinc interpolation (6x6 kernel)
RA_Average: Average (computes the average of all non-NODATA contributing pixels)
RA_Mode: Mode (selects the value which appears most often of all the sampled points)
RA_Max: Maximum (selects the maximum of all non-NODATA contributing pixels)
RA_Min: Minimum (selects the minimum of all non-NODATA contributing pixels)
RA_Median: Median (selects the median of all non-NODATA contributing pixels)
RA_Q1: First quartile (selects the first quartile of all non-NODATA contributing pixels)
RA_Q3: Third quartile (selects the third quartile of all non-NODATA contributing pixels)

class GeometryOperationResult(*values)¶

Bases: IntEnum

Success or failure of a geometry operation.

This enum gives details about cause of failure.

Added in version 3.22.

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
GeometryTypeHasChanged: Operation has changed geometry type

class GeometryType(*values)¶

Bases: IntEnum

The geometry types are used to group Qgis.WkbType in a coarse way.

Note

Prior to 3.30 this was available as QgsWkbTypes.GeometryType.

Added in version 3.30.

Point: Points

Available as QgsWkbTypes.PointGeometry in older QGIS releases.
Line: Lines

Available as QgsWkbTypes.LineGeometry in older QGIS releases.
Polygon: Polygons

Available as QgsWkbTypes.PolygonGeometry in older QGIS releases.
Unknown: Unknown types

Available as QgsWkbTypes.UnknownGeometry in older QGIS releases.
Null: No geometry

Available as QgsWkbTypes.NullGeometry in older QGIS releases.

class GeometryValidationEngine(*values)¶

Bases: IntEnum

Available engines for validating geometries.

Added in version 3.22.

QgisInternal: Use internal QgsGeometryValidator method

Available as QgsGeometry.ValidatorQgisInternal in older QGIS releases.
Geos: Use GEOS validation methods

Available as QgsGeometry.ValidatorGeos in older QGIS releases.

class GeometryValidityFlag(*values)¶

Bases: IntEnum

Geometry validity check flags.

Added in version 3.22.

AllowSelfTouchingHoles: 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.

Available as QgsGeometry.FlagAllowSelfTouchingHoles in older QGIS releases.

class GeometryValidityFlags¶
class GeometryValidityFlags(f: Qgis.GeometryValidityFlags | Qgis.GeometryValidityFlag)
class GeometryValidityFlags(a0: Qgis.GeometryValidityFlags): Bases: object

class GeosCreationFlag(*values)¶

Bases: IntEnum

Flags which control geos geometry creation behavior.

Added in version 3.40.

RejectOnInvalidSubGeometry: Don’t allow geometries with invalid sub-geometries to be created
SkipEmptyInteriorRings: Skip any empty polygon interior ring

RejectOnInvalidSubGeometry = 1¶

SkipEmptyInteriorRings = 2¶

class GeosCreationFlags¶
class GeosCreationFlags(f: Qgis.GeosCreationFlags | Qgis.GeosCreationFlag)
class GeosCreationFlags(a0: Qgis.GeosCreationFlags): Bases: object

class GnssConstellation(*values)¶

Bases: IntEnum

GNSS constellation

Added in version 3.30.

Unknown: Unknown/other system
Gps: Global Positioning System (GPS)
Glonass: Global Navigation Satellite System (GLONASS)
Galileo: Galileo
BeiDou: BeiDou
Qzss: Quasi Zenith Satellite System (QZSS)
Navic: Indian Regional Navigation Satellite System (IRNSS) / NAVIC
Sbas: SBAS

BeiDou = 4¶

Galileo = 3¶

Glonass = 2¶

Gps = 1¶

Navic = 6¶

Qzss = 5¶

Sbas = 7¶

Unknown = 0¶

GpsConnectionStatus¶: alias of DeviceConnectionStatus

class GpsConnectionType(*values)¶

Bases: IntEnum

GPS connection types.

Added in version 3.30.

Automatic: Automatically detected GPS device connection
Internal: Internal GPS device
Serial: Serial port GPS device
Gpsd: GPSD device

Automatic = 0¶

Gpsd = 3¶

Internal = 1¶

Serial = 2¶

class GpsFeatureType(*values)¶

Bases: IntEnum

GPS feature types.

Added in version 3.22.

Waypoint: Waypoint
Route: Route
Track: Track

Route = 1¶

Track = 2¶

Waypoint = 0¶

class GpsFixStatus(*values)¶

Bases: IntEnum

GPS fix status.

Note

Prior to QGIS 3.30 this was available as QgsGpsInformation.FixStatus

Added in version 3.30.

NoData: No fix data available
NoFix: GPS is not fixed
Fix2D: 2D fix
Fix3D: 3D fix

class GpsInformationComponent(*values)¶

Bases: IntEnum

GPS information component.

Added in version 3.30.

Location: 2D location (latitude/longitude), as a QgsPointXY value
Altitude: Altitude/elevation above or below the mean sea level
GroundSpeed: Ground speed
Bearing: Bearing measured in degrees clockwise from true north to the direction of travel
TotalTrackLength: Total distance of current GPS track (available from QgsGpsLogger class only)
TrackDistanceFromStart: Direct distance from first vertex in current GPS track to last vertex (available from QgsGpsLogger class only)
Pdop: Dilution of precision
Hdop: Horizontal dilution of precision
Vdop: Vertical dilution of precision
HorizontalAccuracy: Horizontal accuracy in meters
VerticalAccuracy: Vertical accuracy in meters
HvAccuracy: 3D RMS
SatellitesUsed: Count of satellites used in obtaining the fix
Timestamp: Timestamp
TrackStartTime: Timestamp at start of current track (available from QgsGpsLogger class only)
TrackEndTime: Timestamp at end (current point) of current track (available from QgsGpsLogger class only)
TrackDistanceSinceLastPoint: Distance since last recorded location (available from QgsGpsLogger class only)
TrackTimeSinceLastPoint: Time since last recorded location (available from QgsGpsLogger class only)
GeoidalSeparation: Geoidal separation, the difference between the WGS-84 Earth ellipsoid and mean-sea-level (geoid), “-” means mean-sea-level below ellipsoid
EllipsoidAltitude: Altitude/elevation above or below the WGS-84 Earth ellipsoid

Altitude = 2¶

Bearing = 8¶

EllipsoidAltitude = 524288¶

GeoidalSeparation = 262144¶

GroundSpeed = 4¶

Hdop = 128¶

HorizontalAccuracy = 512¶

HvAccuracy = 2048¶

Location = 1¶

Pdop = 64¶

SatellitesUsed = 4096¶

Timestamp = 8192¶

TotalTrackLength = 16¶

TrackDistanceFromStart = 32¶

TrackDistanceSinceLastPoint = 65536¶

TrackEndTime = 32768¶

TrackStartTime = 16384¶

TrackTimeSinceLastPoint = 131072¶

Vdop = 256¶

VerticalAccuracy = 1024¶

class GpsInformationComponents¶
class GpsInformationComponents(f: Qgis.GpsInformationComponents | Qgis.GpsInformationComponent)
class GpsInformationComponents(a0: Qgis.GpsInformationComponents): Bases: object

class GpsNavigationStatus(*values)¶

Bases: IntEnum

GPS navigation status.

Added in version 3.38.

NotValid: Navigation status not valid
Safe: Safe
Caution: Caution
Unsafe: Unsafe

Caution = 2¶

NotValid = 0¶

Safe = 1¶

Unsafe = 3¶

class GpsQualityIndicator(*values)¶

Bases: IntEnum

GPS signal quality indicator

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

class GradientColorSource(*values)¶

Bases: IntEnum

Gradient color sources.

Note

Prior to QGIS 3.24 this was available as QgsGradientFillSymbolLayer.GradientColorType

Added in version 3.24.

SimpleTwoColor: Simple two color gradient
ColorRamp: Gradient color ramp

class GradientSpread(*values)¶

Bases: IntEnum

Gradient spread options, which control how gradients are rendered outside of their start and end points.

Note

Prior to QGIS 3.24 this was available as QgsGradientFillSymbolLayer.GradientSpread

Added in version 3.24.

Pad: Pad out gradient using colors at endpoint of gradient
Reflect: Reflect gradient
Repeat: Repeat gradient

class GradientType(*values)¶

Bases: IntEnum

Gradient types.

Note

Prior to QGIS 3.24 this was available as QgsGradientFillSymbolLayer.GradientType

Added in version 3.24.

Linear: Linear gradient
Radial: Radial (circular) gradient
Conical: Conical (polar) gradient

class GraduatedMethod(*values)¶

Bases: IntEnum

Methods for modifying symbols by range in a graduated symbol renderer.

Note

Prior to QGIS 3.26 this was available as QgsGraduatedSymbolRenderer.GraduatedMethod

Added in version 3.26.

Color: Alter color of symbols

Available as QgsGraduatedSymbolRenderer.GraduatedColor in older QGIS releases.
Size: Alter size of symbols

Available as QgsGraduatedSymbolRenderer.GraduatedSize in older QGIS releases.

class HistoryProviderBackend(*values)¶

Bases: IntEnum

History provider backends.

Added in version 3.24.

LocalProfile: Local profile

LocalProfile = 1¶

class HistoryProviderBackends¶
class HistoryProviderBackends(f: Qgis.HistoryProviderBackends | Qgis.HistoryProviderBackend)
class HistoryProviderBackends(a0: Qgis.HistoryProviderBackends): Bases: object

class HttpMethod(*values)¶

Bases: IntEnum

Different methods of HTTP requests

Added in version 3.22.

Get: GET method
Post: POST method

Get = 0¶

Post = 1¶

Info = 0¶

class InputControllerType(*values)¶

Bases: IntEnum

Input controller types.

Added in version 3.34.

Map2D: 2D map controller
Map3D: 3D map controller

Map2D = 0¶

Map3D = 1¶

class InvalidGeometryCheck(*values)¶

Bases: IntEnum

Methods for handling of features with invalid geometries

Note

Prior to QGIS 3.36 this was available as QgsFeatureRequest.InvalidGeometryCheck

Added in version 3.36.

NoCheck: No invalid geometry checking

Available as QgsFeatureRequest.GeometryNoCheck in older QGIS releases.
SkipInvalid: Skip any features with invalid geometry. This requires a slow geometry validity check for every feature.

Available as QgsFeatureRequest.GeometrySkipInvalid in older QGIS releases.
AbortOnInvalid: Close iterator on encountering any features with invalid geometry. This requires a slow geometry validity check for every feature.

Available as QgsFeatureRequest.GeometryAbortOnInvalid in older QGIS releases.

class JoinStyle(*values)¶

Bases: IntEnum

Join styles for buffers.

Added in version 3.22.

Round: Use rounded joins

Available as QgsGeometry.JoinStyleRound in older QGIS releases.
Miter: Use mitered joins

Available as QgsGeometry.JoinStyleMiter in older QGIS releases.
Bevel: Use beveled joins

Available as QgsGeometry.JoinStyleBevel in older QGIS releases.

class LabelLinePlacementFlag(*values)¶

Bases: IntEnum

Line placement flags, which control how candidates are generated for a linear feature.

Note

Prior to QGIS 3.32 this was available as QgsLabeling.LinePlacementFlag

Added in version 3.32.

OnLine: Labels can be placed directly over a line feature.
AboveLine: Labels can be placed above a line feature. Unless MapOrientation is also specified this mode respects the direction of the line feature, so a line from right to left labels will have labels placed placed below the line feature.
BelowLine: Labels can be placed below a line feature. Unless MapOrientation is also specified this mode respects the direction of the line feature, so a line from right to left labels will have labels placed placed above the line feature.
MapOrientation: Signifies that the AboveLine and BelowLine flags should respect the map’s orientation rather than the feature’s orientation. For example, AboveLine will always result in label’s being placed above a line, regardless of the line’s direction.

class LabelLinePlacementFlags¶
class LabelLinePlacementFlags(f: Qgis.LabelLinePlacementFlags | Qgis.LabelLinePlacementFlag)
class LabelLinePlacementFlags(a0: Qgis.LabelLinePlacementFlags): Bases: object

class LabelMultiLineAlignment(*values)¶

Bases: IntEnum

Text alignment for multi-line labels.

Note

Prior to QGIS 3.26 this was available as QgsPalLayerSettings.MultiLineAlign

Added in version 3.26.

Left: Left align

Available as QgsPalLayerSettings.MultiLeft in older QGIS releases.
Center: Center align

Available as QgsPalLayerSettings.MultiCenter in older QGIS releases.
Right: Right align

Available as QgsPalLayerSettings.MultiRight in older QGIS releases.
FollowPlacement: Alignment follows placement of label, e.g., labels to the left of a feature will be drawn with right alignment

Available as QgsPalLayerSettings.MultiFollowPlacement in older QGIS releases.
Justify: Justified

Available as QgsPalLayerSettings.MultiJustify in older QGIS releases.

class LabelOffsetType(*values)¶

Bases: IntEnum

Behavior modifier for label offset and distance, only applies in some label placement modes.

Note

Prior to QGIS 3.26 this was available as QgsPalLayerSettings.OffsetType

Added in version 3.26.

FromPoint: Offset distance applies from point geometry
FromSymbolBounds: Offset distance applies from rendered symbol bounds

class LabelOverlapHandling(*values)¶

Bases: IntEnum

Label overlap handling.

Added in version 3.26.

PreventOverlap: Do not allow labels to overlap other labels
AllowOverlapIfRequired: Avoids overlapping labels when possible, but permit overlaps if labels for features cannot otherwise be placed
AllowOverlapAtNoCost: Labels may freely overlap other labels, at no cost

AllowOverlapAtNoCost = 2¶

AllowOverlapIfRequired = 1¶

PreventOverlap = 0¶

class LabelPlacement(*values)¶

Bases: IntEnum

Placement modes which determine how label candidates are generated for a feature.

Note

Prior to QGIS 3.26 this was available as QgsPalLayerSettings.Placement

Added in version 3.26.

AroundPoint: Arranges candidates in a circle around a point (or centroid of a polygon). Applies to point or polygon layers only.
OverPoint: Arranges candidates over a point (or centroid of a polygon), or at a preset offset from the point. Applies to point or polygon layers only.
Line: Arranges candidates parallel to a generalised line representing the feature or parallel to a polygon’s perimeter. Applies to line or polygon layers only.
Curved: Arranges candidates following the curvature of a line feature. Applies to line layers only.
Horizontal: Arranges horizontal candidates scattered throughout a polygon feature. Applies to polygon layers only.
Free: Arranges candidates scattered throughout a polygon feature. Candidates are rotated to respect the polygon’s orientation. Applies to polygon layers only.
OrderedPositionsAroundPoint: Candidates are placed in predefined positions around a point. Preference is given to positions with greatest cartographic appeal, e.g., top right, bottom right, etc. Applies to point layers only.
PerimeterCurved: Arranges candidates following the curvature of a polygon’s boundary. Applies to polygon layers only.
OutsidePolygons: Candidates are placed outside of polygon boundaries. Applies to polygon layers only

Added in version 3.14.

class LabelPlacementEngineVersion(*values)¶

Bases: IntEnum

Labeling placement engine version.

Prior to QGIS 3.30 this was available as QgsLabelingEngineSettings.PlacementEngineVersion

Added in version 3.30.

Version1: Version 1, matches placement from QGIS <= 3.10.1

Available as QgsLabelingEngineSettings.PlacementEngineVersion1 in older QGIS releases.
Version2: Version 2 (default for new projects since QGIS 3.12)

Available as QgsLabelingEngineSettings.PlacementEngineVersion2 in older QGIS releases.

class LabelPolygonPlacementFlag(*values)¶

Bases: IntEnum

Polygon placement flags, which control how candidates are generated for a polygon feature.

Note

Prior to QGIS 3.32 this was available as QgsLabeling.PolygonPlacementFlag

Added in version 3.32.

AllowPlacementOutsideOfPolygon: Labels can be placed outside of a polygon feature
AllowPlacementInsideOfPolygon: Labels can be placed inside a polygon feature

class LabelPolygonPlacementFlags¶
class LabelPolygonPlacementFlags(f: Qgis.LabelPolygonPlacementFlags | Qgis.LabelPolygonPlacementFlag)
class LabelPolygonPlacementFlags(a0: Qgis.LabelPolygonPlacementFlags): Bases: object

class LabelPredefinedPointPosition(*values)¶

Bases: IntEnum

Positions for labels when using the Qgis.LabelPlacement.OrderedPositionsAroundPoint placement mode.

Note

Prior to QGIS 3.26 this was available as QgsPalLayerSettings.PredefinedPointPosition

Added in version 3.26.

TopLeft: Label on top-left of point
TopSlightlyLeft: Label on top of point, slightly left of center
TopMiddle: Label directly above point
TopSlightlyRight: Label on top of point, slightly right of center
TopRight: Label on top-right of point
MiddleLeft: Label on left of point
MiddleRight: Label on right of point
BottomLeft: Label on bottom-left of point
BottomSlightlyLeft: Label below point, slightly left of center
BottomMiddle: Label directly below point
BottomSlightlyRight: Label below point, slightly right of center
BottomRight: Label on bottom right of point
OverPoint: Label directly centered over point

Added in version 3.38.

class LabelPrioritization(*values)¶

Bases: IntEnum

Label prioritization.

Added in version 3.38.

PreferCloser: Prefer closer labels, falling back to alternate positions before larger distances
PreferPositionOrdering: Prefer labels follow position ordering, falling back to more distance labels before alternate positions

PreferCloser = 0¶

PreferPositionOrdering = 1¶

class LabelQuadrantPosition(*values)¶

Bases: IntEnum

Label quadrant positions

Note

Prior to QGIS 3.26 this was available as QgsPalLayerSettings.QuadrantPosition

Added in version 3.26.

AboveLeft: Above left

Available as QgsPalLayerSettings.QuadrantAboveLeft in older QGIS releases.
Above: Above center

Available as QgsPalLayerSettings.QuadrantAbove in older QGIS releases.
AboveRight: Above right

Available as QgsPalLayerSettings.QuadrantAboveRight in older QGIS releases.
Left: Left middle

Available as QgsPalLayerSettings.QuadrantLeft in older QGIS releases.
Over: Center middle

Available as QgsPalLayerSettings.QuadrantOver in older QGIS releases.
Right: Right middle

Available as QgsPalLayerSettings.QuadrantRight in older QGIS releases.
BelowLeft: Below left

Available as QgsPalLayerSettings.QuadrantBelowLeft in older QGIS releases.
Below: Below center

Available as QgsPalLayerSettings.QuadrantBelow in older QGIS releases.
BelowRight: BelowRight

Available as QgsPalLayerSettings.QuadrantBelowRight in older QGIS releases.

class LabelingFlag(*values)¶

Bases: IntEnum

Various flags that affect drawing and placement of labels.

Prior to QGIS 3.30 this was available as QgsLabelingEngineSettings.Flag

Added in version 3.30.

UseAllLabels: Whether to draw all labels even if there would be collisions
UsePartialCandidates: Whether to use also label candidates that are partially outside of the map view
RenderOutlineLabels: Whether to render labels as text or outlines. Deprecated and of QGIS 3.4.3 - use defaultTextRenderFormat() instead.
DrawLabelRectOnly: Whether to only draw the label rect and not the actual label text (used for unit tests)
DrawCandidates: Whether to draw rectangles of generated candidates (good for debugging)
DrawUnplacedLabels: Whether to render unplaced labels as an indicator/warning for users
CollectUnplacedLabels: Whether unplaced labels should be collected in the labeling results (regardless of whether they are being rendered)

Added in version 3.20.
DrawLabelMetrics: Whether to render label metric guides (for debugging)

Added in version 3.30.

class LabelingFlags¶
class LabelingFlags(f: Qgis.LabelingFlags | Qgis.LabelingFlag)
class LabelingFlags(a0: Qgis.LabelingFlags): Bases: object

class LayerFilter(*values)¶

Bases: IntEnum

Filter for layers

Added in version 3.34..

RasterLayer:
NoGeometry:
PointLayer:
LineLayer:
PolygonLayer:
HasGeometry:
VectorLayer:
PluginLayer:
WritableLayer:
MeshLayer: QgsMeshLayer

Added in version 3.6.
VectorTileLayer: QgsVectorTileLayer

Added in version 3.14.
PointCloudLayer: QgsPointCloudLayer

Added in version 3.18.
AnnotationLayer: QgsAnnotationLayer

Added in version 3.22.
TiledSceneLayer: QgsTiledSceneLayer

Added in version 3.34.
All: All layers
SpatialLayer: All spatial layers.

Added in version 3.24.

class LayerFilters¶
class LayerFilters(f: Qgis.LayerFilters | Qgis.LayerFilter)
class LayerFilters(a0: Qgis.LayerFilters): Bases: object

class LayerTreeFilterFlag(*values)¶

Bases: IntEnum

Layer tree filter flags.

Added in version 3.32.

SkipVisibilityCheck: If set, the standard visibility check should be skipped

SkipVisibilityCheck = 1¶

class LayerTreeFilterFlags¶
class LayerTreeFilterFlags(f: Qgis.LayerTreeFilterFlags | Qgis.LayerTreeFilterFlag)
class LayerTreeFilterFlags(a0: Qgis.LayerTreeFilterFlags): Bases: object

class LayerTreeInsertionMethod(*values)¶

Bases: IntEnum

Layer tree insertion methods

Added in version 3.30.

AboveInsertionPoint: Layers are added in the tree above the insertion point
TopOfTree: Layers are added at the top of the layer tree
OptimalInInsertionGroup: Layers are added at optimal locations across the insertion point’s group

AboveInsertionPoint = 0¶

OptimalInInsertionGroup = 2¶

TopOfTree = 1¶

class LayerType(*values)¶

Bases: IntEnum

Types of layers that can be added to a map

Added in version 3.30..

Vector: Vector layer

Available as QgsMapLayer.VectorLayer in older QGIS releases.
Raster: Raster layer

Available as QgsMapLayer.RasterLayer in older QGIS releases.
Plugin: Plugin based layer

Available as QgsMapLayer.PluginLayer in older QGIS releases.
Mesh: Mesh layer. Added in QGIS 3.2

Available as QgsMapLayer.MeshLayer in older QGIS releases.
VectorTile: Vector tile layer. Added in QGIS 3.14

Available as QgsMapLayer.VectorTileLayer in older QGIS releases.
Annotation: Contains freeform, georeferenced annotations. Added in QGIS 3.16

Available as QgsMapLayer.AnnotationLayer in older QGIS releases.
PointCloud: Point cloud layer. Added in QGIS 3.18

Available as QgsMapLayer.PointCloudLayer in older QGIS releases.
Group: Composite group layer. Added in QGIS 3.24

Available as QgsMapLayer.GroupLayer in older QGIS releases.
TiledScene: Tiled scene layer. Added in QGIS 3.34

class LayoutUnit(*values)¶

Bases: IntEnum

Layout measurement units

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes.LayoutUnit.

Added in version 3.30.

Millimeters: Millimeters

Available as QgsUnitTypes.LayoutMillimeters in older QGIS releases.
Centimeters: Centimeters

Available as QgsUnitTypes.LayoutCentimeters in older QGIS releases.
Meters: Meters

Available as QgsUnitTypes.LayoutMeters in older QGIS releases.
Inches: Inches

Available as QgsUnitTypes.LayoutInches in older QGIS releases.
Feet: Feet

Available as QgsUnitTypes.LayoutFeet in older QGIS releases.
Points: Typographic points

Available as QgsUnitTypes.LayoutPoints in older QGIS releases.
Picas: Typographic picas

Available as QgsUnitTypes.LayoutPicas in older QGIS releases.
Pixels: Pixels

Available as QgsUnitTypes.LayoutPixels in older QGIS releases.

class LayoutUnitType(*values)¶

Bases: IntEnum

Types of layout units

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes.LayoutUnitType.

Added in version 3.30.

PaperUnits: Unit is a paper based measurement unit

Available as QgsUnitTypes.LayoutPaperUnits in older QGIS releases.
ScreenUnits: Unit is a screen based measurement unit

Available as QgsUnitTypes.LayoutScreenUnits in older QGIS releases.

class LegendJsonRenderFlag(*values)¶

Bases: IntEnum

Legend JSON export flags.

Flags to control JSON attributes when exporting a legend in JSON format.

Added in version 3.36.

ShowRuleDetails: If set, the rule expression of a rule based renderer legend item will be added to the JSON

ShowRuleDetails = 1¶

class LegendJsonRenderFlags¶
class LegendJsonRenderFlags(f: Qgis.LegendJsonRenderFlags | Qgis.LegendJsonRenderFlag)
class LegendJsonRenderFlags(a0: Qgis.LegendJsonRenderFlags): Bases: object

class LightSourceType(*values)¶

Bases: IntEnum

Light source types for 3D scenes.

Added in version 3.26.

Point: Point light source
Directional: Directional light source

Directional = 1¶

Point = 0¶

class LineClipMode(*values)¶

Bases: IntEnum

Line clipping modes.

Added in version 3.24.

ClipPainterOnly: Applying clipping on the painter only (i.e. line endpoints will coincide with polygon bounding box, but will not be part of the visible portion of the line)
ClipToIntersection: Clip lines to intersection with polygon shape (slower) (i.e. line endpoints will coincide with polygon exterior)
NoClipping: Lines are not clipped, will extend to shape’s bounding box.

ClipPainterOnly = 0¶

ClipToIntersection = 1¶

NoClipping = 2¶

class LineExtensionSide(*values)¶

Bases: IntEnum

Designates whether the line extension constraint is currently soft locked with the previous or next vertex of the locked one.

Added in version 3.26.

BeforeVertex: Lock to previous vertex
AfterVertex: Lock to next vertex
NoVertex: Don’t lock to vertex

AfterVertex = 1¶

BeforeVertex = 0¶

NoVertex = 2¶

class LinearReferencingLabelSource(*values)¶

Bases: IntEnum

Defines what quantity to use for the labels shown in a linear referencing symbol layer.

Added in version 3.40.

CartesianDistance2D: Distance along line, calculated using Cartesian calculations on a 2D plane.
Z: Z values
M: M values

CartesianDistance2D = 0¶

M = 2¶

Z = 1¶

class LinearReferencingPlacement(*values)¶

Bases: IntEnum

Defines how/where the labels should be placed in a linear referencing symbol layer.

Added in version 3.40.

IntervalCartesian2D: Place labels at regular intervals, using Cartesian distance calculations on a 2D plane
IntervalZ: Place labels at regular intervals, linearly interpolated using Z values
IntervalM: Place labels at regular intervals, linearly interpolated using M values
Vertex: Place labels on every vertex in the line

IntervalCartesian2D = 1¶

IntervalM = 4¶

IntervalZ = 2¶

Vertex = 8¶

class LoadStyleFlag(*values)¶

Bases: IntEnum

Flags for loading layer styles.

Added in version 3.38.

IgnoreMissingStyleErrors: If the style is missing, then don’t flag it as an error. This flag can be used when the caller is not certain that a style exists, and accordingly a failure to find the style does not indicate an issue with loading the style itself.

IgnoreMissingStyleErrors = 1¶

class LoadStyleFlags¶
class LoadStyleFlags(f: Qgis.LoadStyleFlags | Qgis.LoadStyleFlag)
class LoadStyleFlags(a0: Qgis.LoadStyleFlags): Bases: object

class MakeValidMethod(*values)¶

Bases: IntEnum

Algorithms to use when repairing invalid geometries.

Added in version 3.28.

Linework: Combines all rings into a set of noded lines and then extracts valid polygons from that linework.
Structure: Structured method, first makes all rings valid and then merges shells and subtracts holes from shells to generate valid result. Assumes that holes and shells are correctly categorized. Requires GEOS 3.10+.

Linework = 0¶

Structure = 1¶

class MapBoxGlStyleSourceType(*values)¶

Bases: IntEnum

Available MapBox GL style source types.

Added in version 3.28.

Vector: Vector source
Raster: Raster source
RasterDem: Raster DEM source
GeoJson: GeoJSON source
Image: Image source
Video: Video source
Unknown: Other/unknown source type

GeoJson = 3¶

Image = 4¶

Raster = 1¶

RasterDem = 2¶

Unknown = 6¶

Vector = 0¶

Video = 5¶

class MapCanvasFlag(*values)¶

Bases: IntEnum

Flags controlling behavior of map canvases.

Added in version 3.40.

ShowMainAnnotationLayer: The project’s main annotation layer should be rendered in the canvas

ShowMainAnnotationLayer = 1¶

class MapCanvasFlags¶
class MapCanvasFlags(f: Qgis.MapCanvasFlags | Qgis.MapCanvasFlag)
class MapCanvasFlags(a0: Qgis.MapCanvasFlags): Bases: object

class MapLayerActionFlag(*values)¶

Bases: IntEnum

Map layer action flags.

Prior to QGIS 3.30 this was available as QgsMapLayerAction.Flag

Added in version 3.30.

EnabledOnlyWhenEditable: Action should be shown only for editable layers
EnableOnlyWhenHasGeometry: Action should be shown only for layers with geometry,

Added in version 3.42.

EnableOnlyWhenHasGeometry = 4¶

class MapLayerActionFlags¶
class MapLayerActionFlags(f: Qgis.MapLayerActionFlags | Qgis.MapLayerActionFlag)
class MapLayerActionFlags(a0: Qgis.MapLayerActionFlags): Bases: object

class MapLayerActionTarget(*values)¶

Bases: IntEnum

Map layer action targets.

Prior to QGIS 3.30 this was available as QgsMapLayerAction.Target

Added in version 3.30.

Layer: Action targets a complete layer
SingleFeature: Action targets a single feature from a layer
MultipleFeatures: Action targets multiple features from a layer
AllActions:

class MapLayerActionTargets¶
class MapLayerActionTargets(f: Qgis.MapLayerActionTargets | Qgis.MapLayerActionTarget)
class MapLayerActionTargets(a0: Qgis.MapLayerActionTargets): Bases: object

class MapLayerProperties¶
class MapLayerProperties(f: Qgis.MapLayerProperties | Qgis.MapLayerProperty)
class MapLayerProperties(a0: Qgis.MapLayerProperties): Bases: object

class MapLayerProperty(*values)¶

Bases: IntEnum

Generic map layer properties.

Added 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

Added in version 3.22.
IsBasemapLayer: Layer is considered a ‘basemap’ layer, and certain properties of the layer should be ignored when calculating project-level properties. For instance, the extent of basemap layers is ignored when calculating the extent of a project, as these layers are typically global and extend outside of a project’s area of interest

Added in version 3.26.

IsBasemapLayer = 2¶

UsersCannotToggleEditing = 1¶

class MapLayerRendererFlag(*values)¶

Bases: IntEnum

Flags which control how map layer renderers behave.

Added in version 3.34.

RenderPartialOutputs: The renderer benefits from rendering temporary in-progress preview renders. These are temporary results which will be used for the layer during rendering in-progress compositions, which will differ from the final layer render. They can be used for showing overlays or other information to users which help inform them about what is actually occurring during a slow layer render, but where these overlays and additional content is not wanted in the final layer renders. Another use case is rendering unsorted results as soon as they are available, before doing a final sorted render of the entire layer contents.
RenderPartialOutputOverPreviousCachedImage: When rendering temporary in-progress preview renders, these preview renders can be drawn over any previously cached layer render we have for the same region. This can allow eg a low-resolution zoomed in version of the last map render to be used as a base painting surface to overdraw with incremental preview render outputs. If not set, an empty image will be used as the starting point for the render preview image.
AffectsLabeling: The layer rendering will interact with the map labeling

Added in version 3.40.

AffectsLabeling = 4¶

RenderPartialOutputOverPreviousCachedImage = 2¶

RenderPartialOutputs = 1¶

class MapLayerRendererFlags¶
class MapLayerRendererFlags(f: Qgis.MapLayerRendererFlags | Qgis.MapLayerRendererFlag)
class MapLayerRendererFlags(a0: Qgis.MapLayerRendererFlags): Bases: object

class MapRecenteringMode(*values)¶

Bases: IntEnum

Modes for recentering map canvases.

Added in version 3.30.

Always: Always recenter map
WhenOutsideVisibleExtent: Only recenter map when new center would be outside of current visible extent
Never: Never recenter map

Always = 0¶

Never = 2¶

WhenOutsideVisibleExtent = 1¶

class MapSettingsFlag(*values)¶

Bases: IntEnum

Flags which adjust the way maps are rendered.

Added 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
HighQualityImageTransforms: Enable high quality image transformations, which results in better appearance of scaled or rotated raster components of a map

Added in version 3.24.
SkipSymbolRendering: Disable symbol rendering while still drawing labels if enabled

Added in version 3.24.
ForceRasterMasks: Force symbol masking to be applied using a raster method. This is considerably faster when compared to the vector method, but results in a inferior quality output.

Added in version 3.26.1.
RecordProfile: Enable run-time profiling while rendering

Added in version 3.34.
AlwaysUseGlobalMasks: When applying clipping paths for selective masking, always use global (“entire map”) paths, instead of calculating local clipping paths per rendered feature. This results in considerably more complex vector exports in all current Qt versions. This flag only applies to vector map exports.

Added in version 3.38.

class MapSettingsFlags¶
class MapSettingsFlags(f: Qgis.MapSettingsFlags | Qgis.MapSettingsFlag)
class MapSettingsFlags(a0: Qgis.MapSettingsFlags): Bases: object

class MapToolUnit(*values)¶

Bases: IntEnum

Type of unit of tolerance value from settings. For map (project) units, use MapToolUnit.Project.

Added in version 3.32.

Layer: Layer unit value

Available as QgsTolerance.LayerUnits in older QGIS releases.
Pixels: Pixels unit of tolerance
Project: Map (project) units

Available as QgsTolerance.ProjectUnits in older QGIS releases.

class MarkerClipMode(*values)¶

Bases: IntEnum

Marker clipping modes.

Added in version 3.24.

NoClipping: No clipping, render complete markers
Shape: Clip to polygon shape
CentroidWithin: Render complete markers wherever their centroid falls within the polygon shape
CompletelyWithin: Render complete markers wherever the completely fall within the polygon shape

CentroidWithin = 2¶

CompletelyWithin = 3¶

NoClipping = 0¶

Shape = 1¶

class MarkerLinePlacement(*values)¶

Bases: IntEnum

Defines how/where the symbols should be placed on a line.

Note

Prior to QGIS 3.24 this was available as QgsTemplatedLineSymbolLayerBase.Placement

Added in version 3.24.

Interval: Place symbols at regular intervals
Vertex: Place symbols on every vertex in the line
LastVertex: Place symbols on the last vertex in the line
FirstVertex: Place symbols on the first vertex in the line
CentralPoint: Place symbols at the mid point of the line
CurvePoint: Place symbols at every virtual curve point in the line (used when rendering curved geometry types only)
SegmentCenter: Place symbols at the center of every line segment
InnerVertices: Inner vertices (i.e. all vertices except the first and last vertex)

Added in version 3.24.

class MarkerLinePlacements¶
class MarkerLinePlacements(f: Qgis.MarkerLinePlacements | Qgis.MarkerLinePlacement)
class MarkerLinePlacements(a0: Qgis.MarkerLinePlacements): Bases: object

class MarkerShape(*values)¶

Bases: IntEnum

Marker shapes.

Note

Prior to QGIS 3.24 this was available as QgsSimpleMarkerSymbolLayerBase.Shape

Added in version 3.24.

Square: Square
Diamond: Diamond
Pentagon: Pentagon
Hexagon: Hexagon
Triangle: Triangle
EquilateralTriangle: Equilateral triangle
Star: Star
Arrow: Arrow
Circle: Circle
Cross: Cross (lines only)
CrossFill: Solid filled cross
Cross2: Rotated cross (lines only), ‘x’ shape
Line: Vertical line
ArrowHead: Right facing arrow head (unfilled, lines only)
ArrowHeadFilled: Right facing filled arrow head
SemiCircle: Semi circle (top half)
ThirdCircle: One third circle (top left third)
QuarterCircle: Quarter circle (top left quarter)
QuarterSquare: Quarter square (top left quarter)
HalfSquare: Half square (left half)
DiagonalHalfSquare: Diagonal half square (bottom left half)
RightHalfTriangle: Right half of triangle
LeftHalfTriangle: Left half of triangle
Octagon: Octagon

Added in version 3.18.
SquareWithCorners: A square with diagonal corners

Added in version 3.18.
AsteriskFill: A filled asterisk shape

Added in version 3.18.
HalfArc: A line-only half arc

Added in version 3.20.
ThirdArc: A line-only one third arc

Added in version 3.20.
QuarterArc: A line-only one quarter arc

Added in version 3.20.
ParallelogramRight: Parallelogram that slants right

Added in version 3.28.
ParallelogramLeft: Parallelogram that slants left

Added in version 3.28.
Trapezoid: Trapezoid

Added in version 3.28.
Shield: A shape consisting of a triangle attached to a rectangle

Added in version 3.28.
DiamondStar: A 4-sided star

Added in version 3.28.
Heart: Heart

Added in version 3.28.
Decagon: Decagon

Added in version 3.28.
RoundedSquare: A square with rounded corners

Added in version 3.28.

class MeshEditingErrorType(*values)¶

Bases: IntEnum

Type of error that can occur during mesh frame editing.

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

class MeshElevationMode(*values)¶

Bases: IntEnum

Mesh layer elevation modes.

Added in version 3.38.

FixedElevationRange: Layer has a fixed elevation range
FromVertices: Elevation should be taken from mesh vertices
FixedRangePerGroup: Layer has a fixed (manually specified) elevation range per group

FixedElevationRange = 0¶

FixedRangePerGroup = 2¶

FromVertices = 1¶

class MessageLevel¶: Bases: int

class MetadataDateType(*values)¶

Bases: IntEnum

Date types for metadata.

Added in version 3.30.

Created: Date created
Published: Date published
Revised: Date revised
Superseded: Date superseded

Created = 0¶

Published = 1¶

Revised = 2¶

Superseded = 3¶

class NavigationMode(*values)¶

Bases: IntEnum

The navigation mode used by 3D cameras.

Added in version 3.30.

TerrainBased: The default navigation based on the terrain
Walk: Uses WASD keys or arrows to navigate in walking (first person) manner

TerrainBased = 0¶

Walk = 1¶

NoLevel = 4¶

class PictureFormat(*values)¶

Bases: IntEnum

Picture formats.

Note

Prior to QGIS 3.40 this was available as QgsLayoutItemPicture.Format.

Added in version 3.40.

SVG: SVG image

Available as QgsLayoutItemPicture.FormatSVG in older QGIS releases.
Raster: Raster image

Available as QgsLayoutItemPicture.FormatRaster in older QGIS releases.
Unknown: Invalid or unknown image type

Available as QgsLayoutItemPicture.FormatUnknown in older QGIS releases.

class PlaybackOperation(*values)¶

Bases: IntEnum

Media playback operations.

Added in version 3.36.

SkipToStart: Jump to start of playback
PreviousFrame: Step to previous frame
PlayReverse: Play in reverse
Pause: Pause playback
PlayForward: Play forward
NextFrame: Step to next frame
SkipToEnd: Jump to end of playback

NextFrame = 5¶

Pause = 3¶

PlayForward = 4¶

PlayReverse = 2¶

PreviousFrame = 1¶

SkipToEnd = 6¶

SkipToStart = 0¶

class PlotAxisSuffixPlacement(*values)¶

Bases: IntEnum

Placement options for suffixes in the labels for axis of plots.

Added in version 3.32.

NoLabels: Do not place suffixes
EveryLabel: Place suffix after every value label
FirstLabel: Place suffix after the first label value only
LastLabel: Place suffix after the last label value only
FirstAndLastLabels: Place suffix after the first and last label values only

EveryLabel = 1¶

FirstAndLastLabels = 4¶

FirstLabel = 2¶

LastLabel = 3¶

NoLabels = 0¶

class PlotToolFlag(*values)¶

Bases: IntEnum

Flags that control the way the QgsPlotTools operate.

Added in version 3.26.

ShowContextMenu: Show a context menu when right-clicking with the tool.

ShowContextMenu = 1¶

class PlotToolFlags¶
class PlotToolFlags(f: Qgis.PlotToolFlags | Qgis.PlotToolFlag)
class PlotToolFlags(a0: Qgis.PlotToolFlags): Bases: object

class Point3DShape(*values)¶

Bases: IntEnum

3D point shape types.

Note

Prior to QGIS 3.36 this was available as QgsPoint3DSymbol.Shape

Added in version 3.36.

Cylinder: Cylinder
Sphere: Sphere
Cone: Cone
Cube: Cube
Torus: Torus
Plane: Flat plane
ExtrudedText: Extruded text
Model: Model
Billboard: Billboard

class PointCloudDrawOrder(*values)¶

Bases: IntEnum

Pointcloud rendering order for 2d views

/since QGIS 3.26

Default: Draw points in the order they are stored
BottomToTop: Draw points with larger Z values last
TopToBottom: Draw points with larger Z values first

class PointCloudSymbol(*values)¶

Bases: IntEnum

Rendering symbols for point cloud points.

Added in version 3.26.

Square: Renders points as squares
Circle: Renders points as circles

class PointCountMethod(*values)¶

Bases: IntEnum

Methods which define the number of points randomly filling a polygon.

Note

Prior to QGIS 3.24 this was available as QgsRandomMarkerFillSymbolLayer.CountMethod

Added in version 3.24.

Absolute: The point count is used as an absolute count of markers

Available as QgsRandomMarkerFillSymbolLayer.AbsoluteCount in older QGIS releases.
DensityBased: The point count is part of a marker density count

Available as QgsRandomMarkerFillSymbolLayer.DensityBasedCount in older QGIS releases.

class PostgresRelKind(*values)¶

Bases: IntEnum

Postgres database relkind options.

Added in version 3.32.

NotSet: Not set
Unknown: Unknown
OrdinaryTable: Ordinary table
Index: Index
Sequence: Sequence
View: View
MaterializedView: Materialized view
CompositeType: Composition type
ToastTable: TOAST table
ForeignTable: Foreign table
PartitionedTable: Partitioned table

CompositeType = 7¶

ForeignTable = 9¶

Index = 3¶

MaterializedView = 6¶

NotSet = 0¶

OrdinaryTable = 2¶

PartitionedTable = 10¶

Sequence = 4¶

ToastTable = 8¶

Unknown = 1¶

View = 5¶

class ProcessingAlgorithmDocumentationFlag(*values)¶

Bases: IntEnum

Flags describing algorithm behavior for documentation purposes.

Added in version 3.40.

RegeneratesPrimaryKey: Algorithm always drops any existing primary keys or FID values and regenerates them in outputs
RegeneratesPrimaryKeyInSomeScenarios: Algorithm may drop the existing primary keys or FID values in some scenarios, depending on algorithm inputs and parameters

RegeneratesPrimaryKey = 1¶

RegeneratesPrimaryKeyInSomeScenarios = 2¶

class ProcessingAlgorithmDocumentationFlags¶
class ProcessingAlgorithmDocumentationFlags(f: Qgis.ProcessingAlgorithmDocumentationFlags | Qgis.ProcessingAlgorithmDocumentationFlag)
class ProcessingAlgorithmDocumentationFlags(a0: Qgis.ProcessingAlgorithmDocumentationFlags): Bases: object

class ProcessingAlgorithmFlag(*values)¶

Bases: IntEnum

Flags indicating how and when an algorithm operates and should be exposed to users.

Note

Prior to QGIS 3.36 this was available as QgsProcessingAlgorithm.Flag

Added in version 3.36.

HideFromToolbox: Algorithm should be hidden from the toolbox

Available as QgsProcessingAlgorithm.FlagHideFromToolbox in older QGIS releases.
HideFromModeler: Algorithm should be hidden from the modeler

Available as QgsProcessingAlgorithm.FlagHideFromModeler in older QGIS releases.
SupportsBatch: Algorithm supports batch mode

Available as QgsProcessingAlgorithm.FlagSupportsBatch in older QGIS releases.
CanCancel: Algorithm can be canceled

Available as QgsProcessingAlgorithm.FlagCanCancel in older QGIS releases.
RequiresMatchingCrs: Algorithm requires that all input layers have matching coordinate reference systems

Available as QgsProcessingAlgorithm.FlagRequiresMatchingCrs in older QGIS releases.
NoThreading: Algorithm is not thread safe and cannot be run in a background thread, e.g. for algorithms which manipulate the current project, layer selections, or with external dependencies which are not thread-safe.

Available as QgsProcessingAlgorithm.FlagNoThreading in older QGIS releases.
DisplayNameIsLiteral: Algorithm’s display name is a static literal string, and should not be translated or automatically formatted. For use with algorithms named after commands, e.g. GRASS ‘v.in.ogr’.

Available as QgsProcessingAlgorithm.FlagDisplayNameIsLiteral in older QGIS releases.
SupportsInPlaceEdits: Algorithm supports in-place editing

Available as QgsProcessingAlgorithm.FlagSupportsInPlaceEdits in older QGIS releases.
KnownIssues: Algorithm has known issues

Available as QgsProcessingAlgorithm.FlagKnownIssues in older QGIS releases.
CustomException: Algorithm raises custom exception notices, don’t use the standard ones

Available as QgsProcessingAlgorithm.FlagCustomException in older QGIS releases.
PruneModelBranchesBasedOnAlgorithmResults: Algorithm results will cause remaining model branches to be pruned based on the results of running the algorithm

Available as QgsProcessingAlgorithm.FlagPruneModelBranchesBasedOnAlgorithmResults in older QGIS releases.
SkipGenericModelLogging: When running as part of a model, the generic algorithm setup and results logging should be skipped

Available as QgsProcessingAlgorithm.FlagSkipGenericModelLogging in older QGIS releases.
NotAvailableInStandaloneTool: Algorithm should not be available from the standalone “qgis_process” tool. Used to flag algorithms which make no sense outside of the QGIS application, such as “select by…” style algorithms.

Available as QgsProcessingAlgorithm.FlagNotAvailableInStandaloneTool in older QGIS releases.
RequiresProject: The algorithm requires that a valid QgsProject is available from the processing context in order to execute

Available as QgsProcessingAlgorithm.FlagRequiresProject in older QGIS releases.
SecurityRisk: The algorithm represents a potential security risk if executed with untrusted inputs.

Added in version 3.40.
Deprecated: Algorithm is deprecated

Available as QgsProcessingAlgorithm.FlagDeprecated in older QGIS releases.

class ProcessingAlgorithmFlags¶
class ProcessingAlgorithmFlags(f: Qgis.ProcessingAlgorithmFlags | Qgis.ProcessingAlgorithmFlag)
class ProcessingAlgorithmFlags(a0: Qgis.ProcessingAlgorithmFlags): Bases: object

class ProcessingDateTimeParameterDataType(*values)¶

Bases: IntEnum

Processing date time parameter data types.

Note

Prior to QGIS 3.36 this was available as QgsProcessingParameterDateTime.Type

Added in version 3.36.

DateTime: Datetime values
Date: Date values
Time: Time values

class ProcessingFeatureSourceDefinitionFlag(*values)¶

Bases: IntEnum

Flags which control behavior for a Processing feature source.

Note

Prior to QGIS 3.36 this was available as QgsProcessingFeatureSourceDefinition.Flag

Added in version 3.36.

OverrideDefaultGeometryCheck: If set, the default geometry check method (as dictated by QgsProcessingContext) will be overridden for this source

Available as QgsProcessingFeatureSourceDefinition.FlagOverrideDefaultGeometryCheck in older QGIS releases.
CreateIndividualOutputPerInputFeature: If set, every feature processed from this source will be placed into its own individually created output destination. Support for this flag depends on how an algorithm is executed.

Available as QgsProcessingFeatureSourceDefinition.FlagCreateIndividualOutputPerInputFeature in older QGIS releases.

class ProcessingFeatureSourceDefinitionFlags¶
class ProcessingFeatureSourceDefinitionFlags(f: Qgis.ProcessingFeatureSourceDefinitionFlags | Qgis.ProcessingFeatureSourceDefinitionFlag)
class ProcessingFeatureSourceDefinitionFlags(a0: Qgis.ProcessingFeatureSourceDefinitionFlags): Bases: object

class ProcessingFeatureSourceFlag(*values)¶

Bases: IntEnum

Flags which control how QgsProcessingFeatureSource fetches features.

Note

Prior to QGIS 3.36 this was available as QgsProcessingFeatureSource.Flag

Added in version 3.36.

SkipGeometryValidityChecks: Invalid geometry checks should always be skipped. This flag can be useful for algorithms which always require invalid geometries, regardless of any user settings (e.g. “repair geometry” type algorithms).

Available as QgsProcessingFeatureSource.FlagSkipGeometryValidityChecks in older QGIS releases.

class ProcessingFeatureSourceFlags¶
class ProcessingFeatureSourceFlags(f: Qgis.ProcessingFeatureSourceFlags | Qgis.ProcessingFeatureSourceFlag)
class ProcessingFeatureSourceFlags(a0: Qgis.ProcessingFeatureSourceFlags): Bases: object

class ProcessingFieldParameterDataType(*values)¶

Bases: IntEnum

Processing field parameter data types.

Note

Prior to QGIS 3.36 this was available as QgsProcessingParameterField.DataType

Added in version 3.36.

Any: Accepts any field
Numeric: Accepts numeric fields
String: Accepts string fields
DateTime: Accepts datetime fields
Binary: Accepts binary fields, since QGIS 3.34
Boolean: Accepts boolean fields, since QGIS 3.34

class ProcessingFileParameterBehavior(*values)¶

Bases: IntEnum

Flags which dictate the behavior of QgsProcessingParameterFile.

Note

Prior to QGIS 3.36 this was available as QgsProcessingParameterFile.Behavior

Added in version 3.36.

File: Parameter is a single file
Folder: Parameter is a folder

class ProcessingLogLevel(*values)¶

Bases: IntEnum

Logging level for algorithms to use when pushing feedback messages.

Note

Prior to QGIS 3.36 this was available as QgsProcessingContext.LogLevel

Added in version 3.36.

DefaultLevel: Default logging level
Verbose: Verbose logging
ModelDebug: Model debug level logging. Includes verbose logging and other outputs useful for debugging models

Added in version 3.34.

class ProcessingModelChildAlgorithmExecutionStatus(*values)¶

Bases: IntEnum

Reflects the status of a child algorithm in a Processing model.

Added in version 3.38.

NotExecuted: Child has not been executed
Success: Child was successfully executed
Failed: Child encountered an error while executing

Failed = 2¶

NotExecuted = 0¶

Success = 1¶

class ProcessingModelChildParameterSource(*values)¶

Bases: IntEnum

Processing model child parameter sources.

Added in version 3.34.

ModelParameter: Parameter value is taken from a parent model parameter
ChildOutput: Parameter value is taken from an output generated by a child algorithm
StaticValue: Parameter value is a static value
Expression: Parameter value is taken from an expression, evaluated just before the algorithm runs
ExpressionText: Parameter value is taken from a text with expressions, evaluated just before the algorithm runs
ModelOutput: Parameter value is linked to an output parameter for the model

ChildOutput = 1¶

Expression = 3¶

ExpressionText = 4¶

ModelOutput = 5¶

ModelParameter = 0¶

StaticValue = 2¶

class ProcessingNumberParameterType(*values)¶

Bases: IntEnum

Processing numeric parameter data types.

Note

Prior to QGIS 3.36 this was available as QgsProcessingParameterNumber.Type

Added in version 3.36.

Integer: Integer values
Double: Double/float values

class ProcessingParameterFlag(*values)¶

Bases: IntEnum

Flags which dictate the behavior of Processing parameters.

Note

Prior to QGIS 3.36 this was available as QgsProcessingParameterDefinition.Flag

Added in version 3.36.

Advanced: Parameter is an advanced parameter which should be hidden from users by default

Available as QgsProcessingParameterDefinition.FlagAdvanced in older QGIS releases.
Hidden: Parameter is hidden and should not be shown to users

Available as QgsProcessingParameterDefinition.FlagHidden in older QGIS releases.
Optional: Parameter is optional

Available as QgsProcessingParameterDefinition.FlagOptional in older QGIS releases.
IsModelOutput: Destination parameter is final output. The parameter name will be used.

Available as QgsProcessingParameterDefinition.FlagIsModelOutput in older QGIS releases.

class ProcessingParameterFlags¶
class ProcessingParameterFlags(f: Qgis.ProcessingParameterFlags | Qgis.ProcessingParameterFlag)
class ProcessingParameterFlags(a0: Qgis.ProcessingParameterFlags): Bases: object

class ProcessingParameterTypeFlag(*values)¶

Bases: IntEnum

Flags which dictate the behavior of Processing parameter types.

Each parameter type can offer a number of additional flags to fine tune its behavior and capabilities.

Note

Prior to QGIS 3.36 this was available as QgsProcessingParameterType.ParameterFlag

Added in version 3.36.

ExposeToModeler: Is this parameter available in the modeler. Is set to on by default.

class ProcessingParameterTypeFlags¶
class ProcessingParameterTypeFlags(f: Qgis.ProcessingParameterTypeFlags | Qgis.ProcessingParameterTypeFlag)
class ProcessingParameterTypeFlags(a0: Qgis.ProcessingParameterTypeFlags): Bases: object

class ProcessingPropertyAvailability(*values)¶

Bases: IntEnum

Property availability, used for QgsProcessingAlgorithm.VectorProperties in order to determine if properties are available or not.

Note

Prior to QGIS 3.36 this was available as QgsProcessingAlgorithm.PropertyAvailability

Added in version 3.36.

NotAvailable: Properties are not available
Available: Properties are available

class ProcessingProviderFlag(*values)¶

Bases: IntEnum

Flags indicating how and when an processing provider operates and should be exposed to users.

Note

Prior to QGIS 3.36 this was available as QgsProcessingProvider.Flag

Added in version 3.36.

DeemphasiseSearchResults: Algorithms should be de-emphasised in the search results when searching for algorithms. Use for low-priority providers or those with substantial known issues.

Available as QgsProcessingProvider.FlagDeemphasiseSearchResults in older QGIS releases.
CompatibleWithVirtualRaster: The processing provider’s algorithms can work with QGIS virtualraster data provider

Added in version 3.36.

Available as QgsProcessingProvider.FlagCompatibleWithVirtualRaster in older QGIS releases.

class ProcessingProviderFlags¶
class ProcessingProviderFlags(f: Qgis.ProcessingProviderFlags | Qgis.ProcessingProviderFlag)
class ProcessingProviderFlags(a0: Qgis.ProcessingProviderFlags): Bases: object

class ProcessingSourceType(*values)¶

Bases: IntEnum

Processing data source types.

Note

Prior to QGIS 3.36 this was available as QgsProcessing.SourceType

Added in version 3.36.

MapLayer: Any map layer type (raster, vector, mesh, point cloud, annotation or plugin layer)

Available as QgsProcessing.TypeMapLayer in older QGIS releases.
VectorAnyGeometry: Any vector layer with geometry

Available as QgsProcessing.TypeVectorAnyGeometry in older QGIS releases.
VectorPoint: Vector point layers

Available as QgsProcessing.TypeVectorPoint in older QGIS releases.
VectorLine: Vector line layers

Available as QgsProcessing.TypeVectorLine in older QGIS releases.
VectorPolygon: Vector polygon layers

Available as QgsProcessing.TypeVectorPolygon in older QGIS releases.
Raster: Raster layers

Available as QgsProcessing.TypeRaster in older QGIS releases.
File: Files (i.e. non map layer sources, such as text files)

Available as QgsProcessing.TypeFile in older QGIS releases.
Vector: Tables (i.e. vector layers with or without geometry). When used for a sink this indicates the sink has no geometry.

Available as QgsProcessing.TypeVector in older QGIS releases.
Mesh: Mesh layers

Added in version 3.6.

Available as QgsProcessing.TypeMesh in older QGIS releases.
Plugin: Plugin layers

Added in version 3.22.

Available as QgsProcessing.TypePlugin in older QGIS releases.
PointCloud: Point cloud layers

Added in version 3.22.

Available as QgsProcessing.TypePointCloud in older QGIS releases.
Annotation: Annotation layers

Added in version 3.22.

Available as QgsProcessing.TypeAnnotation in older QGIS releases.
VectorTile: Vector tile layers

Added in version 3.32.

Available as QgsProcessing.TypeVectorTile in older QGIS releases.

class ProcessingTinInputLayerType(*values)¶

Bases: IntEnum

Defines the type of input layer for a Processing TIN input.

Note

Prior to QGIS 3.36 this was available as QgsProcessingParameterTinInputLayers.Type

Added in version 3.36.

Vertices: Input that adds only vertices
StructureLines: Input that adds add structure lines
BreakLines: Input that adds vertices and break lines

class ProfileExportType(*values)¶

Bases: IntEnum

Types of export for elevation profiles.

Added in version 3.32.

Features3D: Export profiles as 3D features, with elevation values stored in exported geometry Z values
Profile2D: Export profiles as 2D profile lines, with elevation stored in exported geometry Y dimension and distance in X dimension
DistanceVsElevationTable: Export profiles as a table of sampled distance vs elevation values

DistanceVsElevationTable = 2¶

Features3D = 0¶

Profile2D = 1¶

class ProfileGeneratorFlag(*values)¶

Bases: IntEnum

Flags that control the way the QgsAbstractProfileGenerator operate.

Added in version 3.26.

RespectsMaximumErrorMapUnit: Generated profile respects the QgsProfileGenerationContext.maximumErrorMapUnits() property.
RespectsDistanceRange: Generated profile respects the QgsProfileGenerationContext.distanceRange() property.
RespectsElevationRange: Generated profile respects the QgsProfileGenerationContext.elevationRange() property.

RespectsDistanceRange = 2¶

RespectsElevationRange = 4¶

RespectsMaximumErrorMapUnit = 1¶

class ProfileGeneratorFlags¶
class ProfileGeneratorFlags(f: Qgis.ProfileGeneratorFlags | Qgis.ProfileGeneratorFlag)
class ProfileGeneratorFlags(a0: Qgis.ProfileGeneratorFlags): Bases: object

class ProfileSurfaceSymbology(*values)¶

Bases: IntEnum

Surface symbology type for elevation profile plots.

Added in version 3.26.

Line: The elevation surface will be rendered using a line symbol
FillBelow: The elevation surface will be rendered using a fill symbol below the surface level
FillAbove: The elevation surface will be rendered using a fill symbol above the surface level

Added in version 3.32.

FillAbove = 2¶

FillBelow = 1¶

Line = 0¶

class ProjectCapabilities¶
class ProjectCapabilities(f: Qgis.ProjectCapabilities | Qgis.ProjectCapability)
class ProjectCapabilities(a0: Qgis.ProjectCapabilities): Bases: object

class ProjectCapability(*values)¶

Bases: IntEnum

Flags which control project capabilities.

These flags are specific upfront on creation of a QgsProject object, and can be used to selectively enable potentially costly functionality for the project.

Added in version 3.26.1.

ProjectStyles: Enable the project embedded style library. Enabling this flag can increase the time required to clear and load projects.

ProjectStyles = 1¶

class ProjectFileFormat(*values)¶

Bases: IntEnum

Flags which control project read behavior.

Note

Prior to QGIS 3.26 this was available as QgsProject.FileFormat

Added in version 3.26.

Qgz: Archive file format, supports auxiliary data
Qgs: Project saved in a clear text, does not support auxiliary data

class ProjectFlag(*values)¶

Bases: IntEnum

Flags which control the behavior of QgsProjects.

Added in version 3.26.

EvaluateDefaultValuesOnProviderSide: If set, default values for fields will be evaluated on the provider side when features from the project are created instead of when they are committed.
TrustStoredLayerStatistics: If set, then layer statistics (such as the layer extent) will be read from values stored in the project instead of requesting updated values from the data provider. Additionally, when this flag is set, primary key unicity is not checked for views and materialized views with Postgres provider.
RememberLayerEditStatusBetweenSessions: If set, then any layers set to be editable will be stored in the project and immediately made editable whenever that project is restored
RememberAttributeTableWindowsBetweenSessions: If set, then any open attribute tables will be stored in the project and immediately reopened when the project is restored

EvaluateDefaultValuesOnProviderSide = 1¶

RememberAttributeTableWindowsBetweenSessions = 8¶

RememberLayerEditStatusBetweenSessions = 4¶

TrustStoredLayerStatistics = 2¶

class ProjectFlags¶
class ProjectFlags(f: Qgis.ProjectFlags | Qgis.ProjectFlag)
class ProjectFlags(a0: Qgis.ProjectFlags): Bases: object

class ProjectReadFlag(*values)¶

Bases: IntEnum

Flags which control project read behavior.

Note

Prior to QGIS 3.26 this was available as QgsProject.ReadFlag

Added in version 3.26.

DontResolveLayers: Don’t resolve layer paths (i.e. don’t load any layer content). Dramatically improves project read time if the actual data from the layers is not required.

Available as QgsProject.FlagDontResolveLayers in older QGIS releases.
DontLoadLayouts: Don’t load print layouts. Improves project read time if layouts are not required, and allows projects to be safely read in background threads (since print layouts are not thread safe).

Available as QgsProject.FlagDontLoadLayouts in older QGIS releases.
TrustLayerMetadata: Trust layer metadata. Improves project read time. Do not use it if layers’ extent is not fixed during the project’s use by QGIS and QGIS Server.

Available as QgsProject.FlagTrustLayerMetadata in older QGIS releases.
DontStoreOriginalStyles: Skip the initial XML style storage for layers. Useful for minimising project load times in non-interactive contexts.

Available as QgsProject.FlagDontStoreOriginalStyles in older QGIS releases.
DontLoad3DViews: Skip loading 3D views

Added in version 3.26.

Available as QgsProject.FlagDontLoad3DViews in older QGIS releases.
DontLoadProjectStyles: Skip loading project style databases (deprecated – use ProjectCapability.ProjectStyles flag instead)
ForceReadOnlyLayers: Open layers in a read-only mode.

Added in version 3.28.
DontUpgradeAnnotations: Don’t upgrade old annotation items to QgsAnnotationItem

Added in version 3.40.

class ProjectReadFlags¶
class ProjectReadFlags(f: Qgis.ProjectReadFlags | Qgis.ProjectReadFlag)
class ProjectReadFlags(a0: Qgis.ProjectReadFlags): Bases: object

class PropertyType(*values)¶

Bases: IntEnum

Property types

Note

Prior to QGIS 3.36 this was available as QgsProperty.Type

Added in version 3.36.

Invalid: Invalid (not set) property

Available as QgsProperty.InvalidProperty in older QGIS releases.
Static: Static property

Available as QgsProperty.StaticProperty in older QGIS releases.
Field: Field based property

Available as QgsProperty.FieldBasedProperty in older QGIS releases.
Expression: Expression based property

Available as QgsProperty.ExpressionBasedProperty in older QGIS releases.

class ProviderStyleStorageCapabilities¶
class ProviderStyleStorageCapabilities(f: Qgis.ProviderStyleStorageCapabilities | Qgis.ProviderStyleStorageCapability)
class ProviderStyleStorageCapabilities(a0: Qgis.ProviderStyleStorageCapabilities): Bases: object

class ProviderStyleStorageCapability(*values)¶

Bases: IntEnum

The StorageCapability enum represents the style storage operations supported by the provider.

Added in version 3.34.

SaveToDatabase:
LoadFromDatabase:
DeleteFromDatabase:

DeleteFromDatabase = 8¶

LoadFromDatabase = 4¶

SaveToDatabase = 2¶

class PythonEmbeddedMode(*values)¶

Bases: IntEnum

Authorisation to run Python Embedded in projects

Added in version 3.40.

Never: Python embedded never run
Ask: User is prompt before running
SessionOnly: Only during this session
Always: Python embedded is always run
NotForThisSession: Python embedded will not be run for this session

class PythonEmbeddedType(*values)¶

Bases: IntEnum

Type of Python Embedded in projects

Added in version 3.40.

Macro:
ExpressionFunction:

ExpressionFunction = 1¶

Macro = 0¶

PythonMacroMode¶: alias of PythonEmbeddedMode

QGIS_DEV_VERSION = 'df059ed19c8'¶: The development version

QGIS_RELEASE_NAME = 'Bratislava'¶

QGIS_VERSION = '3.40.11-Bratislava'¶

QGIS_VERSION_INT = 34011¶

class RangeLimits(*values)¶

Bases: IntEnum

Describes how the limits of a range are handled.

Added in version 3.38.

IncludeBoth: Both lower and upper values are included in the range
IncludeLowerExcludeUpper: Lower value is included in the range, upper value is excluded
ExcludeLowerIncludeUpper: Lower value is excluded from the range, upper value in inccluded
ExcludeBoth: Both lower and upper values are excluded from the range

ExcludeBoth = 3¶

ExcludeLowerIncludeUpper = 2¶

IncludeBoth = 0¶

IncludeLowerExcludeUpper = 1¶

class RasterAttributeTableFieldUsage(*values)¶

Bases: IntEnum

The RasterAttributeTableFieldUsage enum represents the usage of a Raster Attribute Table field.

Note

Directly mapped from GDALRATFieldUsage enum values.

Added in version 3.30.

Generic: Field usage Generic
PixelCount: Field usage PixelCount
Name: Field usage Name
Min: Field usage Min
Max: Field usage Max
MinMax: Field usage MinMax
Red: Field usage Red
Green: Field usage Green
Blue: Field usage Blue
Alpha: Field usage Alpha
RedMin: Field usage RedMin
GreenMin: Field usage GreenMin
BlueMin: Field usage BlueMin
AlphaMin: Field usage AlphaMin
RedMax: Field usage RedMax
GreenMax: Field usage GreenMax
BlueMax: Field usage BlueMax
AlphaMax: Field usage AlphaMax
MaxCount: Not used by QGIS: GDAL Maximum GFU value (equals to GFU_AlphaMax+1 currently)

Alpha = 9¶

AlphaMax = 17¶

AlphaMin = 13¶

Blue = 8¶

BlueMax = 16¶

BlueMin = 12¶

Generic = 0¶

Green = 7¶

GreenMax = 15¶

GreenMin = 11¶

Max = 4¶

MaxCount = 18¶

Min = 3¶

MinMax = 5¶

Name = 2¶

PixelCount = 1¶

Red = 6¶

RedMax = 14¶

RedMin = 10¶

class RasterAttributeTableType(*values)¶

Bases: IntEnum

The RasterAttributeTableType enum represents the type of RAT. note Directly mapped from GDALRATTableType enum values.

Added in version 3.30.

Thematic:
Athematic:

Athematic = 1¶

Thematic = 0¶

class RasterBandStatistic(*values)¶

Bases: IntEnum

Available raster band statistics.

Added in version 3.36..

NoStatistic: No statistic
Min: Minimum
Max: Maximum
Range: Range
Sum: Sum
Mean: Mean
StdDev: Standard deviation
SumOfSquares: Sum of squares
All: All available statistics

class RasterBandStatistics¶
class RasterBandStatistics(f: Qgis.RasterBandStatistics | Qgis.RasterBandStatistic)
class RasterBandStatistics(a0: Qgis.RasterBandStatistics): Bases: object

class RasterBuildPyramidOption(*values)¶

Bases: IntEnum

Raster pyramid building options.

Note

Prior to QGIS 3.30 this was available as QgsRaster.RasterBuildPyramids

Added in version 3.30.

No: Never

Available as QgsRaster.PyramidsFlagNo in older QGIS releases.
Yes: Yes

Available as QgsRaster.PyramidsFlagYes in older QGIS releases.
CopyExisting: Copy existing

Available as QgsRaster.PyramidsCopyExisting in older QGIS releases.

class RasterColorInterpretation(*values)¶

Bases: IntEnum

Raster color interpretation.

This is a modified copy of the GDAL GDALColorInterp enum.

Note

Prior to QGIS 3.30 this was available as QgsRaster.ColorInterpretation

Added in version 3.30.

Undefined: Undefined

Available as QgsRaster.UndefinedColorInterpretation in older QGIS releases.
GrayIndex: Grayscale
PaletteIndex: Paletted (see associated color table)
RedBand: Red band of RGBA image, or red spectral band [0.62 - 0.69 um]
GreenBand: Green band of RGBA image, or green spectral band [0.51 - 0.60 um]
BlueBand: Blue band of RGBA image, or blue spectral band [0.45 - 0.53 um]
AlphaBand: Alpha (0=transparent, 255=opaque)
HueBand: Hue band of HLS image
SaturationBand: Saturation band of HLS image
LightnessBand: Lightness band of HLS image
CyanBand: Cyan band of CMYK image
MagentaBand: Magenta band of CMYK image
YellowBand: Yellow band of CMYK image, or yellow spectral band [0.58 - 0.62 um]
BlackBand: Black band of CMLY image
YCbCr_YBand: Y Luminance
YCbCr_CbBand: Cb Chroma
YCbCr_CrBand: Cr Chroma
ContinuousPalette: Continuous palette, QGIS addition, GRASS
PanBand: Panchromatic band [0.40 - 1.00 um]

Added in version 3.40.
CoastalBand: Coastal band [0.40 - 0.45 um]

Added in version 3.40.
RedEdgeBand: Red-edge band [0.69 - 0.79 um]

Added in version 3.40.
NIRBand: Near-InfraRed (NIR) band [0.75 - 1.40 um]

Added in version 3.40.
SWIRBand: Short-Wavelength InfraRed (SWIR) band [1.40 - 3.00 um]

Added in version 3.40.
MWIRBand: Mid-Wavelength InfraRed (MWIR) band [3.00 - 8.00 um]

Added in version 3.40.
LWIRBand: Long-Wavelength InfraRed (LWIR) band [8.00 - 15 um]

Added in version 3.40.
TIRBand: Thermal InfraRed (TIR) band (MWIR or LWIR) [3 - 15 um]

Added in version 3.40.
OtherIRBand: Other infrared band [0.75 - 1000 um]

Added in version 3.40.
SAR_Ka_Band: Synthetic Aperture Radar (SAR) Ka band [0.8 - 1.1 cm / 27 - 40 GHz]

Added in version 3.40.
SAR_K_Band: Synthetic Aperture Radar (SAR) K band [1.1 - 1.7 cm / 18 - 27 GHz]

Added in version 3.40.
SAR_Ku_Band: Synthetic Aperture Radar (SAR) Ku band [1.7 - 2.4 cm / 12 - 18 GHz]

Added in version 3.40.
SAR_X_Band: Synthetic Aperture Radar (SAR) X band [2.4 - 3.8 cm / 8 - 12 GHz]

Added in version 3.40.
SAR_C_Band: Synthetic Aperture Radar (SAR) C band [3.8 - 7.5 cm / 4 - 8 GHz]

Added in version 3.40.
SAR_S_Band: Synthetic Aperture Radar (SAR) S band [7.5 - 15 cm / 2 - 4 GHz]

Added in version 3.40.
SAR_L_Band: Synthetic Aperture Radar (SAR) L band [15 - 30 cm / 1 - 2 GHz]

Added in version 3.40.
SAR_P_Band: Synthetic Aperture Radar (SAR) P band [30 - 100 cm / 0.3 - 1 GHz]

Added in version 3.40.

class RasterDrawingStyle(*values)¶

Bases: IntEnum

Raster drawing styles.

Note

Prior to QGIS 3.30 this was available as QgsRaster.DrawingStyle

Added in version 3.30.

Undefined: Undefined

Available as QgsRaster.UndefinedDrawingStyle in older QGIS releases.
SingleBandGray: A single band image drawn as a range of gray colors
SingleBandPseudoColor: A single band image drawn using a pseudocolor algorithm
PalettedColor: A “Palette” image drawn using color table
PalettedSingleBandGray: A “Palette” layer drawn in gray scale
PalettedSingleBandPseudoColor: A “Palette” layerdrawn using a pseudocolor algorithm
PalettedMultiBandColor: Currently not supported
MultiBandSingleBandGray: A layer containing 2 or more bands, but a single band drawn as a range of gray colors
MultiBandSingleBandPseudoColor: A layer containing 2 or more bands, but a single band drawn using a pseudocolor algorithm
MultiBandColor: A layer containing 2 or more bands, mapped to RGB color space. In the case of a multiband with only two bands, one band will be mapped to more than one color.
SingleBandColorData: ARGB values rendered directly

Available as QgsRaster.SingleBandColorDataStyle in older QGIS releases.

class RasterElevationMode(*values)¶

Bases: IntEnum

Raster layer elevation modes.

Added in version 3.38.

FixedElevationRange: Layer has a fixed elevation range
RepresentsElevationSurface: Pixel values represent an elevation surface
FixedRangePerBand: Layer has a fixed (manually specified) elevation range per band
DynamicRangePerBand: Layer has a elevation range per band, calculated dynamically from an expression

DynamicRangePerBand = 3¶

FixedElevationRange = 0¶

FixedRangePerBand = 2¶

RepresentsElevationSurface = 1¶

class RasterExportType(*values)¶

Bases: IntEnum

Raster file export types.

Prior to QGIS 3.32 this was available as QgsRasterFileWriter.Mode

Added in version 3.32.

Raw: Raw data
RenderedImage: Rendered image

Available as QgsRasterFileWriter.Image in older QGIS releases.

class RasterFileWriterResult(*values)¶

Bases: IntEnum

Raster file export results.

Prior to QGIS 3.32 this was available as QgsRasterFileWriter.WriterError

Added in version 3.32.

Success: Successful export

Available as QgsRasterFileWriter.NoError in older QGIS releases.
SourceProviderError: Source data provider error
DestinationProviderError: Destination data provider error

Available as QgsRasterFileWriter.DestProviderError in older QGIS releases.
CreateDatasourceError: Data source creation error
WriteError: Write error
NoDataConflict: Internal error if a value used for ‘no data’ was found in input
Canceled: Writing was manually canceled

Available as QgsRasterFileWriter.WriteCanceled in older QGIS releases.

class RasterIdentifyFormat(*values)¶

Bases: IntEnum

Raster identify formats.

Note

Prior to QGIS 3.30 this was available as QgsRaster.IdentifyFormat

Added in version 3.30.

Undefined: Undefined

Available as QgsRaster.IdentifyFormatUndefined in older QGIS releases.
Value: Numerical pixel value

Available as QgsRaster.IdentifyFormatValue in older QGIS releases.
Text: WMS text

Available as QgsRaster.IdentifyFormatText in older QGIS releases.
Html: WMS HTML

Available as QgsRaster.IdentifyFormatHtml in older QGIS releases.
Feature: WMS GML/JSON -> feature

Available as QgsRaster.IdentifyFormatFeature in older QGIS releases.

class RasterInterfaceCapabilities¶
class RasterInterfaceCapabilities(f: Qgis.RasterInterfaceCapabilities | Qgis.RasterInterfaceCapability)
class RasterInterfaceCapabilities(a0: Qgis.RasterInterfaceCapabilities): Bases: object

class RasterInterfaceCapability(*values)¶

Bases: IntEnum

Raster interface capabilities.

Note

Prior to QGIS 3.38 this was available as QgsRasterInterface.Capability

Added in version 3.38.

NoCapabilities: No capabilities
Size: Original data source size (and thus resolution) is known, it is not always available, for example for WMS
Create: Create new datasets (Unused and deprecated – will be removed in QGIS 4)
Remove: Delete datasets (Unused and deprecated – will be removed in QGIS 4)
BuildPyramids: Supports building of pyramids (overviews) (Deprecated since QGIS 3.38 – use RasterProviderCapability.BuildPyramids instead)
Identify: At least one identify format supported
IdentifyValue: Numerical values
IdentifyText: WMS text
IdentifyHtml: WMS HTML
IdentifyFeature: WMS GML -> feature
Prefetch: Allow prefetching of out-of-view images

class RasterLayerType(*values)¶

Bases: IntEnum

Raster layer types.

Note

Prior to QGIS 3.30 this was available as QgsRasterLayer.LayerType

Added in version 3.30.

GrayOrUndefined: Gray or undefined
Palette: Palette
MultiBand: Multi band

Available as QgsRasterLayer.Multiband in older QGIS releases.
SingleBandColorData: Single band containing color data

Available as QgsRasterLayer.ColorLayer in older QGIS releases.

class RasterPipeInterfaceRole(*values)¶

Bases: IntEnum

Raster pipe interface roles.

Added in version 3.22.

Unknown: Unknown role

Available as QgsRasterPipe.UnknownRole in older QGIS releases.
Provider: Data provider role

Available as QgsRasterPipe.ProviderRole in older QGIS releases.
Renderer: Raster renderer role

Available as QgsRasterPipe.RendererRole in older QGIS releases.
Brightness: Brightness filter role

Available as QgsRasterPipe.BrightnessRole in older QGIS releases.
Resampler: Resampler role

Available as QgsRasterPipe.ResamplerRole in older QGIS releases.
Projector: Projector role

Available as QgsRasterPipe.ProjectorRole in older QGIS releases.
Nuller: Raster nuller role

Available as QgsRasterPipe.NullerRole in older QGIS releases.
HueSaturation: Hue/saturation filter role (also applies grayscale/color inversion)

Available as QgsRasterPipe.HueSaturationRole in older QGIS releases.

class RasterProviderCapabilities¶
class RasterProviderCapabilities(f: Qgis.RasterProviderCapabilities | Qgis.RasterProviderCapability)
class RasterProviderCapabilities(a0: Qgis.RasterProviderCapabilities): Bases: object

class RasterProviderCapability(*values)¶

Bases: IntEnum

Raster data provider capabilities.

Note

Prior to QGIS 3.38 this was available as QgsRasterDataProvider.ProviderCapability

Added in version 3.38.

NoProviderCapabilities: Provider has no capabilities
ReadLayerMetadata: Provider can read layer metadata from data store. Since QGIS 3.0. See QgsDataProvider.layerMetadata()
WriteLayerMetadata: Provider can write layer metadata to the data store. Since QGIS 3.0. See QgsDataProvider.writeLayerMetadata()
ProviderHintBenefitsFromResampling: Provider benefits from resampling and should apply user default resampling settings

Added in version 3.10.
ProviderHintCanPerformProviderResampling: Provider can perform resampling (to be opposed to post rendering resampling)

Added in version 3.16.
ReloadData: Is able to force reload data / clear local caches. Since QGIS 3.18, see QgsDataProvider.reloadProviderData()
DpiDependentData: Provider’s rendering is dependent on requested pixel size of the viewport

Added in version 3.20.
NativeRasterAttributeTable: Indicates that the provider supports native raster attribute table

Added in version 3.30.
BuildPyramids: Supports building of pyramids (overviews) (since QGIS 3.38 – this is a replacement for RasterInterfaceCapability.BuildPyramids)

class RasterPyramidFormat(*values)¶

Bases: IntEnum

Raster pyramid formats.

Note

Prior to QGIS 3.30 this was available as QgsRaster.RasterPyramidsFormat

Added in version 3.30.

GeoTiff: Geotiff .ovr (external)

Available as QgsRaster.PyramidsGTiff in older QGIS releases.
Internal: Internal

Available as QgsRaster.PyramidsInternal in older QGIS releases.
Erdas: Erdas Image .aux (external)

Available as QgsRaster.PyramidsErdas in older QGIS releases.

class RasterRendererCapabilities¶
class RasterRendererCapabilities(f: Qgis.RasterRendererCapabilities | Qgis.RasterRendererCapability)
class RasterRendererCapabilities(a0: Qgis.RasterRendererCapabilities): Bases: object

class RasterRendererCapability(*values)¶

Bases: IntEnum

Raster renderer capabilities.

Added in version 3.48.

UsesMultipleBands: The renderer utilizes multiple raster bands for color data (note that alpha bands are not considered for this capability)

UsesMultipleBands = 1¶

class RasterRendererFlag(*values)¶

Bases: IntEnum

Flags which control behavior of raster renderers.

Added in version 3.28.

InternalLayerOpacityHandling: The renderer internally handles the raster layer’s opacity, so the default layer level opacity handling should not be applied.
UseNoDataForOutOfRangePixels: Out of range pixels (eg those values outside of the rendered map’s z range filter) should be set using additional nodata values instead of additional transparency values

Added in version 3.38.

InternalLayerOpacityHandling = 1¶

UseNoDataForOutOfRangePixels = 2¶

class RasterRendererFlags¶
class RasterRendererFlags(f: Qgis.RasterRendererFlags | Qgis.RasterRendererFlag)
class RasterRendererFlags(a0: Qgis.RasterRendererFlags): Bases: object

class RasterResamplingStage(*values)¶

Bases: IntEnum

Stage at which raster resampling occurs.

Added in version 3.22.

ResampleFilter:
Provider:

class RasterTemporalCapabilityFlag(*values)¶

Bases: IntEnum

Flags for raster layer temporal capabilities.

Added in version 3.28.

RequestedTimesMustExactlyMatchAllAvailableTemporalRanges: If present, indicates that the provider must only request temporal values which are exact matches for the values present in QgsRasterDataProviderTemporalCapabilities.allAvailableTemporalRanges().

RequestedTimesMustExactlyMatchAllAvailableTemporalRanges = 1¶

class RasterTemporalCapabilityFlags¶
class RasterTemporalCapabilityFlags(f: Qgis.RasterTemporalCapabilityFlags | Qgis.RasterTemporalCapabilityFlag)
class RasterTemporalCapabilityFlags(a0: Qgis.RasterTemporalCapabilityFlags): Bases: object

class RasterTemporalMode(*values)¶

Bases: IntEnum

Raster layer temporal modes

Added in version 3.22.

FixedTemporalRange: Mode when temporal properties have fixed start and end datetimes.

Available as QgsRasterLayerTemporalProperties.ModeFixedTemporalRange in older QGIS releases.
TemporalRangeFromDataProvider: Mode when raster layer delegates temporal range handling to the dataprovider.

Available as QgsRasterLayerTemporalProperties.ModeTemporalRangeFromDataProvider in older QGIS releases.
RedrawLayerOnly: Redraw the layer when temporal range changes, but don’t apply any filtering. Useful when raster symbology expressions depend on the time range.

Added in version 3.22.

Available as QgsRasterLayerTemporalProperties.ModeRedrawLayerOnly in older QGIS releases.
FixedRangePerBand: Layer has a fixed temporal range per band

Added in version 3.38.
RepresentsTemporalValues: Pixel values represent an datetime

class RelationshipCapabilities¶
class RelationshipCapabilities(f: Qgis.RelationshipCapabilities | Qgis.RelationshipCapability)
class RelationshipCapabilities(a0: Qgis.RelationshipCapabilities): Bases: object

class RelationshipCapability(*values)¶

Bases: IntEnum

Relationship capabilities.

Added in version 3.30.

MultipleFieldKeys: Supports multiple field keys (as opposed to a singular field)
ForwardPathLabel: Supports forward path labels
BackwardPathLabel: Supports backward path labels

BackwardPathLabel = 4¶

ForwardPathLabel = 2¶

MultipleFieldKeys = 1¶

class RelationshipCardinality(*values)¶

Bases: IntEnum

Relationship cardinality.

Added in version 3.28.

OneToOne: One to one relationship
OneToMany: One to many relationship
ManyToOne: Many to one relationship
ManyToMany: Many to many relationship

ManyToMany = 3¶

ManyToOne = 2¶

OneToMany = 1¶

OneToOne = 0¶

class RelationshipStrength(*values)¶

Bases: IntEnum

Relationship strength.

Note

Prior to QGIS 3.28 this was available as QgsRelation.RelationStrength.

Added in version 3.28.

Association: Loose relation, related elements are not part of the parent and a parent copy will not copy any children.
Composition: Fix relation, related elements are part of the parent and a parent copy will copy any children or delete of parent will delete children

class RelationshipType(*values)¶

Bases: IntEnum

Relationship types.

Note

Prior to QGIS 3.28 this was available as QgsRelation.RelationType.

Added in version 3.28.

Normal: A normal relation
Generated: A generated relation is a child of a polymorphic relation

class RenderContextFlag(*values)¶

Bases: IntEnum

Flags which affect rendering operations.

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

Added in version 3.24.
HighQualityImageTransforms: Enable high quality image transformations, which results in better appearance of scaled or rotated raster components of a map

Added in version 3.24.
SkipSymbolRendering: Disable symbol rendering while still drawing labels if enabled

Added in version 3.24.
RecordProfile: Enable run-time profiling while rendering

Added in version 3.34.
AlwaysUseGlobalMasks: When applying clipping paths for selective masking, always use global (“entire map”) paths, instead of calculating local clipping paths per rendered feature. This results in considerably more complex vector exports in all current Qt versions. This flag only applies to vector map exports.

Added in version 3.38.
DisableSymbolClippingToExtent: Force symbol clipping to map extent to be disabled in all situations. This will result in slower rendering, and should only be used in situations where the feature clipping is always undesirable.

Added in version 3.40.
RenderLayerTree: The render is for a layer tree display where map based properties are not available and where avoidance of long rendering freeze is crucial

Added in version 3.44.

class RenderContextFlags¶
class RenderContextFlags(f: Qgis.RenderContextFlags | Qgis.RenderContextFlag)
class RenderContextFlags(a0: Qgis.RenderContextFlags): Bases: object

class RenderSubcomponentProperty(*values)¶

Bases: IntEnum

Rendering subcomponent properties.

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

class RenderUnit(*values)¶

Bases: IntEnum

Rendering size units

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes.RenderUnit.

Added in version 3.30.

Millimeters: Millimeters

Available as QgsUnitTypes.RenderMillimeters in older QGIS releases.
MapUnits: Map units

Available as QgsUnitTypes.RenderMapUnits in older QGIS releases.
Pixels: Pixels

Available as QgsUnitTypes.RenderPixels in older QGIS releases.
Percentage: Percentage of another measurement (e.g., canvas size, feature size)

Available as QgsUnitTypes.RenderPercentage in older QGIS releases.
Points: Points (e.g., for font sizes)

Available as QgsUnitTypes.RenderPoints in older QGIS releases.
Inches: Inches

Available as QgsUnitTypes.RenderInches in older QGIS releases.
Unknown: Mixed or unknown units

Available as QgsUnitTypes.RenderUnknownUnit in older QGIS releases.
MetersInMapUnits: Meters value as Map units

Available as QgsUnitTypes.RenderMetersInMapUnits in older QGIS releases.

class RendererUsage(*values)¶

Bases: IntEnum

Usage of the renderer.

Added in version 3.24.

View: Renderer used for displaying on screen
Export: Renderer used for printing or exporting to a file
Unknown: Renderer used for unknown usage

Export = 1¶

Unknown = 2¶

View = 0¶

SCALE_PRECISION = 0.9999999999¶: Fudge factor used to compare two scales. The code is often going from scale to scale denominator. So it looses precision and, when a limit is inclusive, can lead to errors. To avoid that, use this factor instead of using <= or >=.

Deprecated since version 3.40: No longer used by QGIS and will be removed in QGIS 4.0.

class ScaleBarAlignment(*values)¶

Bases: IntEnum

Scalebar alignment.

Note

Prior to QGIS 3.40 this was available as QgsScaleBarSettings.Alignment.

Added in version 3.40.

Left: Left aligned

Available as QgsScaleBarSettings.AlignLeft in older QGIS releases.
Middle: Center aligned

Available as QgsScaleBarSettings.AlignMiddle in older QGIS releases.
Right: Right aligned

Available as QgsScaleBarSettings.AlignRight in older QGIS releases.

class ScaleBarDistanceLabelHorizontalPlacement(*values)¶

Bases: IntEnum

Scale bar distance label horizontal placement.

Note

Prior to QGIS 3.40 this was available as QgsScaleBarSettings.LabelHorizontalPlacement.

Added in version 3.40.

CenteredEdge: Labels are drawn centered relative to segment’s edge

Available as QgsScaleBarSettings.LabelCenteredEdge in older QGIS releases.
CenteredSegment: Labels are drawn centered relative to segment

Available as QgsScaleBarSettings.LabelCenteredSegment in older QGIS releases.

class ScaleBarDistanceLabelVerticalPlacement(*values)¶

Bases: IntEnum

Scale bar distance label vertical placement.

Note

Prior to QGIS 3.40 this was available as QgsScaleBarSettings.LabelVerticalPlacement.

Added in version 3.40.

AboveSegment: Labels are drawn above the scalebar

Available as QgsScaleBarSettings.LabelAboveSegment in older QGIS releases.
BelowSegment: Labels are drawn below the scalebar

Available as QgsScaleBarSettings.LabelBelowSegment in older QGIS releases.

class ScaleBarSegmentSizeMode(*values)¶

Bases: IntEnum

Modes for setting size for scale bar segments.

Note

Prior to QGIS 3.40 this was available as QgsScaleBarSettings.SegmentSizeMode.

Added in version 3.40.

Fixed: Scale bar segment size is fixed to a map unit

Available as QgsScaleBarSettings.SegmentSizeFixed in older QGIS releases.
FitWidth: Scale bar segment size is calculated to fit a size range

Available as QgsScaleBarSettings.SegmentSizeFitWidth in older QGIS releases.

class ScaleCalculationMethod(*values)¶

Bases: IntEnum

Scale calculation logic.

Added in version 3.40.

HorizontalTop: Calculate horizontally, across top of map
HorizontalMiddle: Calculate horizontally, across midle of map
HorizontalBottom: Calculate horizontally, across bottom of map
HorizontalAverage: Calculate horizontally, using the average of the top, middle and bottom scales

HorizontalAverage = 3¶

HorizontalBottom = 2¶

HorizontalMiddle = 1¶

HorizontalTop = 0¶

class ScaleMethod(*values)¶

Bases: IntEnum

Scale methods

Added in version 3.20.

ScaleArea: Calculate scale by the area
ScaleDiameter: Calculate scale by the diameter

class ScaleToTileZoomLevelMethod(*values)¶

Bases: IntEnum

Available methods for converting map scales to tile zoom levels.

Added in version 3.26.

MapBox: Uses a scale doubling approach to account for hi-DPI tiles, and rounds to the nearest tile level for the map scale
Esri: No scale doubling, always rounds down when matching to available tile levels

Esri = 1¶

MapBox = 0¶

class ScriptLanguage(*values)¶

Bases: IntEnum

Scripting languages.

Added in version 3.30.

Css: CSS
QgisExpression: QGIS expressions
Html: HTML
JavaScript: JavaScript
Json: JSON
Python: Python
R: R Stats
Sql: SQL
Batch: Windows batch files
Bash: Bash scripts
Unknown: Unknown/other language

Bash = 9¶

Batch = 8¶

Css = 0¶

Html = 2¶

JavaScript = 3¶

Json = 4¶

Python = 5¶

QgisExpression = 1¶

R = 6¶

Sql = 7¶

Unknown = 10¶

class ScriptLanguageCapabilities¶
class ScriptLanguageCapabilities(f: Qgis.ScriptLanguageCapabilities | Qgis.ScriptLanguageCapability)
class ScriptLanguageCapabilities(a0: Qgis.ScriptLanguageCapabilities): Bases: object

class ScriptLanguageCapability(*values)¶

Bases: IntEnum

Script language capabilities.

The flags reflect the support capabilities of a scripting language.

Added in version 3.32.

Reformat: Language supports automatic code reformatting
CheckSyntax: Language supports syntax checking
ToggleComment: Language supports comment toggling

CheckSyntax = 2¶

Reformat = 1¶

ToggleComment = 4¶

class SelectBehavior(*values)¶

Bases: IntEnum

Specifies how a selection should be applied.

Added 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

class SelectGeometryRelationship(*values)¶

Bases: IntEnum

Geometry relationship test to apply for selecting features.

Added in version 3.28.

Intersect: Select where features intersect the reference geometry
Within: Select where features are within the reference geometry

Intersect = 0¶

Within = 1¶

class SelectionFlag(*values)¶

Bases: IntEnum

Flags which control feature selection behavior.

Added in version 3.28.

SingleFeatureSelection: Select only a single feature, picking the “best” match for the selection geometry
ToggleSelection: Enables a “toggle” selection mode, where previously selected matching features will be deselected and previously deselected features will be selected. This flag works only when the SingleFeatureSelection flag is also set.

SingleFeatureSelection = 1¶

ToggleSelection = 2¶

class SelectionFlags¶
class SelectionFlags(f: Qgis.SelectionFlags | Qgis.SelectionFlag)
class SelectionFlags(a0: Qgis.SelectionFlags): Bases: object

class SelectionRenderingMode(*values)¶

Bases: IntEnum

Specifies how a selection should be rendered.

Added in version 3.34.

Default: Use default symbol and selection colors
CustomColor: Use default symbol with a custom selection color
CustomSymbol: Use a custom symbol

CustomColor = 1¶

CustomSymbol = 2¶

Default = 0¶

class SensorThingsEntity(*values)¶

Bases: IntEnum

OGC SensorThings API entity types.

Added in version 3.36.

Invalid: An invalid/unknown entity
Thing: A Thing is an object of the physical world (physical things) or the information world (virtual things) that is capable of being identified and integrated into communication networks
Location: A Location entity locates the Thing or the Things it associated with. A Thing’s Location entity is defined as the last known location of the Thing
HistoricalLocation: A Thing’s HistoricalLocation entity set provides the times of the current (i.e., last known) and previous locations of the Thing
Datastream: A Datastream groups a collection of Observations measuring the same ObservedProperty and produced by the same Sensor
Sensor: A Sensor is an instrument that observes a property or phenomenon with the goal of producing an estimate of the value of the property
ObservedProperty: An ObservedProperty specifies the phenomenon of an Observation
Observation: An Observation is the act of measuring or otherwise determining the value of a property
FeatureOfInterest: In the context of the Internet of Things, many Observations’ FeatureOfInterest can be the Location of the Thing. For example, the FeatureOfInterest of a wifi-connect thermostat can be the Location of the thermostat (i.e., the living room where the thermostat is located in). In the case of remote sensing, the FeatureOfInterest can be the geographical area or volume that is being sensed
MultiDatastream: A MultiDatastream groups a collection of Observations and the Observations in a MultiDatastream have a complex result type. Implemented in the SensorThings version 1.1 “MultiDatastream extension”.

Added in version 3.38.

Datastream = 4¶

FeatureOfInterest = 8¶

HistoricalLocation = 3¶

Invalid = 0¶

Location = 2¶

MultiDatastream = 9¶

Observation = 7¶

ObservedProperty = 6¶

Sensor = 5¶

Thing = 1¶

class SettingsOption(*values)¶

Bases: IntEnum

Settings options

Added in version 3.26.

SaveFormerValue: Save the former value of the settings
SaveEnumFlagAsInt: The enum/flag will be saved as an integer value instead of text

SaveEnumFlagAsInt = 4¶

SaveFormerValue = 2¶

class SettingsOptions¶
class SettingsOptions(f: Qgis.SettingsOptions | Qgis.SettingsOption)
class SettingsOptions(a0: Qgis.SettingsOptions): Bases: object

class SettingsOrigin(*values)¶

Bases: IntEnum

The setting origin describes where a setting is stored.

Added in version 3.30.

Any: From any origin
Global: Global settings are stored in qgis_global_settings.ini
Local: Local settings are stored in the user profile

Any = 0¶

Global = 1¶

Local = 2¶

class SettingsTreeNodeOption(*values)¶

Bases: IntEnum

Options for named list nodes

Added in version 3.30.

NamedListSelectedItemSetting: Creates a setting to store which is the current item

NamedListSelectedItemSetting = 1¶

class SettingsTreeNodeOptions¶
class SettingsTreeNodeOptions(f: Qgis.SettingsTreeNodeOptions | Qgis.SettingsTreeNodeOption)
class SettingsTreeNodeOptions(a0: Qgis.SettingsTreeNodeOptions): Bases: object

class SettingsTreeNodeType(*values)¶

Bases: IntEnum

Type of tree node

Added in version 3.30.

Root: Root Node
Standard: Normal Node
NamedList: Named List Node

NamedList = 2¶

Root = 0¶

Standard = 1¶

class SettingsType(*values)¶

Bases: IntEnum

Types of settings entries

Added in version 3.26.

Custom: Custom implementation
Variant: Generic variant
String: String
StringList: List of strings
VariantMap: Map of strings
Bool: Boolean
Integer: Integer
Double: Double precision number
EnumFlag: Enum or Flag
Color: Color

class ShaderClassificationMethod(*values)¶

Bases: IntEnum

Color ramp shader classification methods.

Note

Prior to QGIS 3.38 this was available as QgsColorRampShader.ClassificationMode

Added in version 3.38.

Continuous: Uses breaks from color palette
EqualInterval: Uses equal interval
Quantile: Uses quantile (i.e. equal pixel) count

class ShaderInterpolationMethod(*values)¶

Bases: IntEnum

Color ramp shader interpolation methods.

Note

Prior to QGIS 3.38 this was available as QgsColorRampShader.Type

Added in version 3.38.

Linear: Interpolates the color between two class breaks linearly

Available as QgsColorRampShader.Interpolated in older QGIS releases.
Discrete: Assigns the color of the higher class for every pixel between two class breaks
Exact: Assigns the color of the exact matching value in the color ramp item list

class SldExportOption(*values)¶

Bases: IntEnum

SLD export options

Added in version 3.30.

NoOptions: Default SLD export
Svg: Export complex styles to separate SVG files for better compatibility with OGC servers
Png: Export complex styles to separate PNG files for better compatibility with OGC servers

NoOptions = 0¶

Png = 2¶

Svg = 1¶

class SldExportOptions¶
class SldExportOptions(f: Qgis.SldExportOptions | Qgis.SldExportOption)
class SldExportOptions(a0: Qgis.SldExportOptions): Bases: object

class SldExportVendorExtension(*values)¶

Bases: IntEnum

SLD export vendor extensions, allow the use of vendor extensions when exporting to SLD.

Added in version 3.30.

NoVendorExtension: No vendor extensions
GeoServerVendorExtension: Use GeoServer vendor extensions when required
DeegreeVendorExtension: Use Deegree vendor extensions when required

DeegreeVendorExtension = 4¶

GeoServerVendorExtension = 2¶

NoVendorExtension = 0¶

class SnappingMode(*values)¶

Bases: IntEnum

SnappingMode defines on which layer the snapping is performed

Added in version 3.26.

ActiveLayer: On the active layer
AllLayers: On all vector layers
AdvancedConfiguration: On a per layer configuration basis

class SnappingType(*values)¶

Bases: IntEnum

SnappingTypeFlag defines on what object the snapping is performed

Added in version 3.26.

NoSnap: No snapping

Available as QgsSnappingConfig.NoSnapFlag in older QGIS releases.
Vertex: On vertices

Available as QgsSnappingConfig.VertexFlag in older QGIS releases.
Segment: On segments

Available as QgsSnappingConfig.SegmentFlag in older QGIS releases.
Area: On Area

Available as QgsSnappingConfig.AreaFlag in older QGIS releases.
Centroid: On centroid

Available as QgsSnappingConfig.CentroidFlag in older QGIS releases.
MiddleOfSegment: On Middle segment

Available as QgsSnappingConfig.MiddleOfSegmentFlag in older QGIS releases.
LineEndpoint: Start or end points of lines, or first vertex in polygon rings only

Added in version 3.20.

Available as QgsSnappingConfig.LineEndpointFlag in older QGIS releases.

class SnappingTypes¶
class SnappingTypes(f: Qgis.SnappingTypes | Qgis.SnappingType)
class SnappingTypes(a0: Qgis.SnappingTypes): Bases: object

class SpatialFilterType(*values)¶

Bases: IntEnum

Feature request spatial filter types.

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

class SpatialIndexPresence(*values)¶

Bases: IntEnum

Enumeration of spatial index presence states.

Note

Prior to QGIS 3.36 this was available as QgsFeatureSource.SpatialIndexPresence

Added in version 3.36.

Unknown: Spatial index presence cannot be determined, index may or may not exist

Available as QgsFeatureSource.SpatialIndexUnknown in older QGIS releases.
NotPresent: No spatial index exists for the source

Available as QgsFeatureSource.SpatialIndexNotPresent in older QGIS releases.
Present: A valid spatial index exists for the source

Available as QgsFeatureSource.SpatialIndexPresent in older QGIS releases.

class SqlKeywordCategory(*values)¶

Bases: 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.

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

class SqlLayerDefinitionCapabilities¶
class SqlLayerDefinitionCapabilities(f: Qgis.SqlLayerDefinitionCapabilities | Qgis.SqlLayerDefinitionCapability)
class SqlLayerDefinitionCapabilities(a0: Qgis.SqlLayerDefinitionCapabilities): Bases: object

class SqlLayerDefinitionCapability(*values)¶

Bases: IntEnum

SqlLayerDefinitionCapability enum lists the arguments supported by the provider when creating SQL query layers.

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

class Statistic(*values)¶

Bases: IntEnum

Available generic statistics.

Added in version 3.36..

Count: Count
CountMissing: Number of missing (null) values
Sum: Sum of values
Mean: Mean of values
Median: Median of values
StDev: Standard deviation of values
StDevSample: Sample standard deviation of values
Min: Min of values
Max: Max of values
Range: Range of values (max - min)
Minority: Minority of values
Majority: Majority of values
Variety: Variety (count of distinct) values
FirstQuartile: First quartile
ThirdQuartile: Third quartile
InterQuartileRange: Inter quartile range (IQR)
First: First value

Added in version 3.6.
Last: Last value

Added in version 3.6.
All: All statistics

class Statistics¶
class Statistics(f: Qgis.Statistics | Qgis.Statistic)
class Statistics(a0: Qgis.Statistics): Bases: object

class StringStatistic(*values)¶

Bases: IntEnum

Available string statistics.

Added in version 3.36..

Count: Count
CountDistinct: Number of distinct string values
CountMissing: Number of missing (null) values
Min: Minimum string value
Max: Maximum string value
MinimumLength: Minimum length of string
MaximumLength: Maximum length of string
MeanLength: Mean length of strings
Minority: Minority of strings
Majority: Majority of strings
All: All statistics

class StringStatistics¶
class StringStatistics(f: Qgis.StringStatistics | Qgis.StringStatistic)
class StringStatistics(a0: Qgis.StringStatistics): Bases: object

class SublayerFlag(*values)¶

Bases: IntEnum

Flags which reflect the properties of sublayers in a dataset.

Added in version 3.22.

SystemTable: Sublayer is a system or internal table, which should be hidden by default

SystemTable = 1¶

class SublayerFlags¶
class SublayerFlags(f: Qgis.SublayerFlags | Qgis.SublayerFlag)
class SublayerFlags(a0: Qgis.SublayerFlags): Bases: object

class SublayerPromptMode(*values)¶

Bases: IntEnum

Specifies how to handle layer sources with multiple sublayers.

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

class SublayerQueryFlag(*values)¶

Bases: IntEnum

Flags which control how data providers will scan for sublayers in a dataset.

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

class SublayerQueryFlags¶
class SublayerQueryFlags(f: Qgis.SublayerQueryFlags | Qgis.SublayerQueryFlag)
class SublayerQueryFlags(a0: Qgis.SublayerQueryFlags): Bases: object

Success = 3¶

class SymbolCoordinateReference(*values)¶

Bases: IntEnum

Symbol coordinate reference modes.

Note

Prior to QGIS 3.24 this was available as QgsGradientFillSymbolLayer.GradientCoordinateMode

Added in version 3.24.

Feature: Relative to feature/shape being rendered
Viewport: Relative to the whole viewport/output device

class SymbolFlag(*values)¶

Bases: IntEnum

Flags controlling behavior of symbols

Added in version 3.20.

RendererShouldUseSymbolLevels: If present, indicates that a QgsFeatureRenderer using the symbol should use symbol levels for best results
AffectsLabeling: If present, indicates that the symbol will participate in the map labeling problem

Added in version 3.40.

AffectsLabeling = 2¶

RendererShouldUseSymbolLevels = 1¶

class SymbolFlags¶
class SymbolFlags(f: Qgis.SymbolFlags | Qgis.SymbolFlag)
class SymbolFlags(a0: Qgis.SymbolFlags): Bases: object

class SymbolLayerFlag(*values)¶

Bases: IntEnum

Flags controlling behavior of symbol layers

Note

These differ from Qgis.SymbolLayerUserFlag in that Qgis.SymbolLayerFlag flags are used to reflect the inbuilt properties of a symbol layer type, whereas Qgis.SymbolLayerUserFlag are optional, user controlled flags which can be toggled for a symbol layer.

Added in version 3.22.

DisableFeatureClipping: If present, indicates that features should never be clipped to the map extent during rendering
CanCalculateMaskGeometryPerFeature: If present, indicates that mask geometry can safely be calculated per feature for the symbol layer. This avoids using the entire symbol layer’s mask geometry for every feature rendered, considerably simplifying vector exports and resulting in much smaller file sizes.

Added in version 3.38.
AffectsLabeling: If present, indicates that the symbol layer will participate in the map labeling problem

Added in version 3.40.

AffectsLabeling = 4¶

CanCalculateMaskGeometryPerFeature = 2¶

DisableFeatureClipping = 1¶

class SymbolLayerFlags¶
class SymbolLayerFlags(f: Qgis.SymbolLayerFlags | Qgis.SymbolLayerFlag)
class SymbolLayerFlags(a0: Qgis.SymbolLayerFlags): Bases: object

class SymbolLayerUserFlag(*values)¶

Bases: IntEnum

User-specified flags controlling behavior of symbol layers.

Note

These differ from Qgis.SymbolLayerFlag in that Qgis.SymbolLayerFlag flags are used to reflect the inbuilt properties of a symbol layer type, whereas Qgis.SymbolLayerUserFlag are optional, user controlled flags which can be toggled for a symbol layer.

Added in version 3.34.

DisableSelectionRecoloring: If present, indicates that the symbol layer should not be recolored when rendering selected features

DisableSelectionRecoloring = 1¶

class SymbolLayerUserFlags¶
class SymbolLayerUserFlags(f: Qgis.SymbolLayerUserFlags | Qgis.SymbolLayerUserFlag)
class SymbolLayerUserFlags(a0: Qgis.SymbolLayerUserFlags): Bases: object

class SymbolPreviewFlag(*values)¶

Bases: IntEnum

Flags for controlling how symbol preview images are generated.

Added in version 3.20.

FlagIncludeCrosshairsForMarkerSymbols: Include a crosshairs reference image in the background of marker symbol previews

class SymbolPreviewFlags¶
class SymbolPreviewFlags(f: Qgis.SymbolPreviewFlags | Qgis.SymbolPreviewFlag)
class SymbolPreviewFlags(a0: Qgis.SymbolPreviewFlags): Bases: object

class SymbolRenderHint(*values)¶

Bases: IntEnum

Flags controlling behavior of symbols during rendering

Added in version 3.20.

DynamicRotation: Rotation of symbol may be changed during rendering and symbol should not be cached
IsSymbolLayerSubSymbol: Symbol is being rendered as a sub-symbol of a QgsSymbolLayer

Added in version 3.38.
ForceVectorRendering: Symbol must be rendered using vector methods, and optimisations like pre-rendered images must be disabled

Added in version 3.40.
ExcludeSymbolBuffers: Do not render symbol buffers.

Added in version 3.40.

class SymbolRenderHints¶
class SymbolRenderHints(f: Qgis.SymbolRenderHints | Qgis.SymbolRenderHint)
class SymbolRenderHints(a0: Qgis.SymbolRenderHints): Bases: object

class SymbolRotationMode(*values)¶

Bases: IntEnum

Modes for handling how symbol and text entity rotation is handled when maps are rotated.

Added in version 3.32.

RespectMapRotation: Entity is rotated along with the map
IgnoreMapRotation: Entity ignores map rotation

IgnoreMapRotation = 1¶

RespectMapRotation = 0¶

class SymbolType(*values)¶

Bases: IntEnum

Symbol types

Added in version 3.20.

Marker: Marker symbol
Line: Line symbol
Fill: Fill symbol
Hybrid: Hybrid symbol

class SystemOfMeasurement(*values)¶

Bases: IntEnum

Systems of unit measurement.

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes.SystemOfMeasurement.

Added in version 3.30.

Unknown: Unknown system of measurement

Available as QgsUnitTypes.UnknownSystem in older QGIS releases.
Metric: International System of Units (SI)

Available as QgsUnitTypes.MetricSystem in older QGIS releases.
Imperial: British Imperial

Available as QgsUnitTypes.ImperialSystem in older QGIS releases.
USCS: United States customary system

Available as QgsUnitTypes.USCSSystem in older QGIS releases.

class TemporalIntervalMatchMethod(*values)¶

Bases: IntEnum

Method to use when resolving a temporal range to a data provider layer or band.

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

class TemporalNavigationMode(*values)¶

Bases: IntEnum

Temporal navigation modes.

Note

Prior to QGIS 3.36 this was available as QgsTemporalNavigationObject.NavigationMode

Added in version 3.36.

Disabled: Temporal navigation is disabled

Available as QgsTemporalNavigationObject.NavigationOff in older QGIS releases.
Animated: Temporal navigation relies on frames within a datetime range
FixedRange: Temporal navigation relies on a fixed datetime range
Movie: Movie mode – behaves like a video player, with a fixed frame duration and no temporal range

Added in version 3.36.

class TemporalUnit(*values)¶

Bases: IntEnum

Temporal units.

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes.TemporalUnit.

Added in version 3.30.

Milliseconds: Milliseconds

Available as QgsUnitTypes.TemporalMilliseconds in older QGIS releases.
Seconds: Seconds

Available as QgsUnitTypes.TemporalSeconds in older QGIS releases.
Minutes: Minutes

Available as QgsUnitTypes.TemporalMinutes in older QGIS releases.
Hours: Hours

Available as QgsUnitTypes.TemporalHours in older QGIS releases.
Days: Days

Available as QgsUnitTypes.TemporalDays in older QGIS releases.
Weeks: Weeks

Available as QgsUnitTypes.TemporalWeeks in older QGIS releases.
Months: Months

Available as QgsUnitTypes.TemporalMonths in older QGIS releases.
Years: Years

Available as QgsUnitTypes.TemporalYears in older QGIS releases.
Decades: Decades

Available as QgsUnitTypes.TemporalDecades in older QGIS releases.
Centuries: Centuries

Available as QgsUnitTypes.TemporalCenturies in older QGIS releases.
IrregularStep: Special ‘irregular step’ time unit, used for temporal data which uses irregular, non-real-world unit steps

Added in version 3.20.

Available as QgsUnitTypes.TemporalIrregularStep in older QGIS releases.
Unknown: Unknown time unit

Available as QgsUnitTypes.TemporalUnknownUnit in older QGIS releases.

class TextCharacterVerticalAlignment(*values)¶

Bases: IntEnum

Text vertical alignment for characters.

This enum controls vertical alignment of individual characters within a block of text.

Added in version 3.30.

Normal: Adjacent characters are positioned in the standard way for text in the writing system in use
SuperScript: Characters are placed above the base line for normal text.
SubScript: Characters are placed below the base line for normal text.

Normal = 0¶

SubScript = 2¶

SuperScript = 1¶

class TextComponent(*values)¶

Bases: IntEnum

Text components.

Note

Prior to QGIS 3.28 this was available as QgsTextRenderer.TextPart

Added in version 3.28.

Text: Text component
Buffer: Buffer component
Background: Background shape
Shadow: Drop shadow

class TextHorizontalAlignment(*values)¶

Bases: IntEnum

Text horizontal alignment.

Note

Prior to QGIS 3.28 this was available as QgsTextRenderer.HAlignment

Added in version 3.28.

Left: Left align

Available as QgsTextRenderer.AlignLeft in older QGIS releases.
Center: Center align

Available as QgsTextRenderer.AlignCenter in older QGIS releases.
Right: Right align

Available as QgsTextRenderer.AlignRight in older QGIS releases.
Justify: Justify align

Available as QgsTextRenderer.AlignJustify in older QGIS releases.

class TextLayoutMode(*values)¶

Bases: IntEnum

Text layout modes.

Note

Prior to QGIS 3.28 this was available as QgsTextRenderer.DrawMode

Added in version 3.28.

Rectangle: Text within rectangle layout mode

Available as QgsTextRenderer.Rect in older QGIS releases.
Point: Text at point of origin layout mode
Labeling: Labeling-specific layout mode

Available as QgsTextRenderer.Label in older QGIS releases.
RectangleCapHeightBased: Similar to Rectangle mode, but uses cap height only when calculating font heights for the first line of text, and cap height + descent for subsequent lines of text

Added in version 3.30.
RectangleAscentBased: Similar to Rectangle mode, but uses ascents only when calculating font and line heights.

Added in version 3.30.

class TextOrientation(*values)¶

Bases: IntEnum

Text orientations.

Note

Prior to QGIS 3.28 this was available as QgsTextFormat.TextOrientation

Added in version 3.28.

Horizontal: Horizontally oriented text

Available as QgsTextFormat.HorizontalOrientation in older QGIS releases.
Vertical: Vertically oriented text

Available as QgsTextFormat.VerticalOrientation in older QGIS releases.
RotationBased: Horizontally or vertically oriented text based on rotation (only available for map labeling)

Available as QgsTextFormat.RotationBasedOrientation in older QGIS releases.

class TextRenderFormat(*values)¶

Bases: IntEnum

Options for rendering text.

Added in version 3.22.

AlwaysOutlines: 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.

Available as QgsRenderContext.TextFormatAlwaysOutlines in older QGIS releases.
AlwaysText: 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).

Available as QgsRenderContext.TextFormatAlwaysText in older QGIS releases.
PreferText: Render text as text objects, unless doing so results in rendering artifacts or poor quality rendering (depending on text format settings). 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).

Added in version 3.40.

class TextRendererFlag(*values)¶

Bases: IntEnum

Flags which control the behavior of rendering text.

Added in version 3.24.

WrapLines: Automatically wrap long lines of text

WrapLines = 1¶

class TextRendererFlags¶
class TextRendererFlags(f: Qgis.TextRendererFlags | Qgis.TextRendererFlag)
class TextRendererFlags(a0: Qgis.TextRendererFlags): Bases: object

class TextVerticalAlignment(*values)¶

Bases: IntEnum

Text vertical alignment.

This enum controls vertical alignment of text in a predefined rectangular bounding box. See also Qgis.TextCharacterVerticalAlignment.

Note

Prior to QGIS 3.28 this was available as QgsTextRenderer.VAlignment

Added in version 3.28.

Top: Align to top

Available as QgsTextRenderer.AlignTop in older QGIS releases.
VerticalCenter: Center align

Available as QgsTextRenderer.AlignVCenter in older QGIS releases.
Bottom: Align to bottom

Available as QgsTextRenderer.AlignBottom in older QGIS releases.

class TileAvailability(*values)¶

Bases: IntEnum

Possible availability states for a tile within a tile matrix.

Added in version 3.32.

Available: Tile is available within the matrix
NotAvailable: Tile is not available within the matrix, e.g. there is no content for the tile
AvailableNoChildren: Tile is available within the matrix, and is known to have no children (ie no higher zoom level tiles exist covering this tile’s region)
UseLowerZoomLevelTile: Tile is not available at the requested zoom level, it should be replaced by a tile from a lower zoom level instead182

Available = 0¶

AvailableNoChildren = 2¶

NotAvailable = 1¶

UseLowerZoomLevelTile = 3¶

class TileChildrenAvailability(*values)¶

Bases: IntEnum

Possible availability states for a tile’s children.

Added in version 3.34.

NoChildren: Tile is known to have no children
Available: Tile children are already available
NeedFetching: Tile has children, but they are not yet available and must be fetched

Available = 1¶

NeedFetching = 2¶

NoChildren = 0¶

class TilePixelRatio(*values)¶

Bases: IntEnum

DpiMode enum

Added in version 3.30.

Undefined: Undefined (not scale)
StandardDpi: Standard (96 DPI)
HighDpi: High (192 DPI)

HighDpi = 2¶

StandardDpi = 1¶

Undefined = 0¶

class TileRefinementProcess(*values)¶

Bases: IntEnum

Tiled scene tile refinement processes.

Refinement determines the process by which a lower resolution parent tile renders when its higher resolution children are selected to be rendered.

Added in version 3.34.

Replacement: When tile is refined then its children should be used in place of itself.
Additive: When tile is refined its content should be used alongside its children simultaneously.

Additive = 1¶

Replacement = 0¶

class TiledSceneBoundingVolumeType(*values)¶

Bases: IntEnum

Tiled scene bounding volume types.

Added in version 3.34.

Region: Region type
OrientedBox: Oriented bounding box (rotated box)
Sphere: Sphere

OrientedBox = 1¶

Region = 0¶

Sphere = 2¶

class TiledSceneProviderCapabilities¶
class TiledSceneProviderCapabilities(f: Qgis.TiledSceneProviderCapabilities | Qgis.TiledSceneProviderCapability)
class TiledSceneProviderCapabilities(a0: Qgis.TiledSceneProviderCapabilities): Bases: object

class TiledSceneProviderCapability(*values)¶

Bases: IntEnum

Tiled scene data provider capabilities.

Added in version 3.34.

ReadLayerMetadata: Provider can read layer metadata from data store. See QgsDataProvider.layerMetadata()

ReadLayerMetadata = 2¶

class TiledSceneRendererFlag(*values)¶

Bases: IntEnum

Flags which control how tiled scene 2D renderers behave.

Added in version 3.34.

RequiresTextures: Renderer requires textures
ForceRasterRender: Layer should always be rendered as a raster image
RendersTriangles: Renderer can render triangle primitives
RendersLines: Renderer can render line primitives

ForceRasterRender = 2¶

RendersLines = 8¶

RendersTriangles = 4¶

RequiresTextures = 1¶

class TiledSceneRendererFlags¶
class TiledSceneRendererFlags(f: Qgis.TiledSceneRendererFlags | Qgis.TiledSceneRendererFlag)
class TiledSceneRendererFlags(a0: Qgis.TiledSceneRendererFlags): Bases: object

class TiledSceneRequestFlag(*values)¶

Bases: IntEnum

Flags which control how tiled scene requests behave.

Added in version 3.34.

NoHierarchyFetch: Do not allow hierarchy fetching when hierarchy is not currently available. Avoids network requests, but may result in an incomplete tile set. If set, then callers will need to manually perform hierarchy fetches as required.

NoHierarchyFetch = 1¶

class TiledSceneRequestFlags¶
class TiledSceneRequestFlags(f: Qgis.TiledSceneRequestFlags | Qgis.TiledSceneRequestFlag)
class TiledSceneRequestFlags(a0: Qgis.TiledSceneRequestFlags): Bases: object

class TransactionMode(*values)¶

Bases: IntEnum

Transaction mode.

Added in version 3.26.

Disabled: Edits are buffered locally and sent to the provider when toggling layer editing mode.
AutomaticGroups: Automatic transactional editing means that on supported datasources (postgres and geopackage databases) the edit state of all tables that originate from the same database are synchronized and executed in a server side transaction.
BufferedGroups: Buffered transactional editing means that all editable layers in the buffered transaction group are toggled synchronously and all edits are saved in a local edit buffer. Saving changes is executed within a single transaction on all layers (per provider).

AutomaticGroups = 1¶

BufferedGroups = 2¶

Disabled = 0¶

class TransformDirection(*values)¶

Bases: IntEnum

Indicates the direction (forward or inverse) of a transform.

Added in version 3.22.

Forward: Forward transform (from source to destination)

Available as QgsCoordinateTransform.ForwardTransform in older QGIS releases.
Reverse: Reverse/inverse transform (from destination to source)

Available as QgsCoordinateTransform.ReverseTransform in older QGIS releases.

UI_SCALE_FACTOR = 1.0¶: UI scaling factor. This should be applied to all widget sizes obtained from font metrics, to account for differences in the default font sizes across different platforms.

class UnitType(*values)¶

Bases: IntEnum

Unit types.

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes.UnitType.

Added in version 3.30.

Distance: Distance unit

Available as QgsUnitTypes.TypeDistance in older QGIS releases.
Area: Area unit

Available as QgsUnitTypes.TypeArea in older QGIS releases.
Volume: Volume unit

Available as QgsUnitTypes.TypeVolume in older QGIS releases.
Unknown: Unknown unit type

Available as QgsUnitTypes.TypeUnknown in older QGIS releases.
Temporal: Temporal unit

Available as QgsUnitTypes.TypeTemporal in older QGIS releases.

class UnplacedLabelVisibility(*values)¶

Bases: IntEnum

Unplaced label visibility.

Added in version 3.20.

FollowEngineSetting: Respect the label engine setting
NeverShow: Never show unplaced labels, regardless of the engine setting

FollowEngineSetting = 0¶

NeverShow = 1¶

class UpsideDownLabelHandling(*values)¶

Bases: IntEnum

Handling techniques for upside down labels.

Note

Prior to QGIS 3.26 this was available as QgsPalLayerSettings.UpsideDownLabels

Added in version 3.26.

FlipUpsideDownLabels: Upside-down labels (90 <= angle < 270) are shown upright

Available as QgsPalLayerSettings.Upright in older QGIS releases.
AllowUpsideDownWhenRotationIsDefined: Show upside down when rotation is layer- or data-defined

Available as QgsPalLayerSettings.ShowDefined in older QGIS releases.
AlwaysAllowUpsideDown: Show upside down for all labels, including dynamic ones

Available as QgsPalLayerSettings.ShowAll in older QGIS releases.

class UriCleaningFlag(*values)¶

Bases: IntEnum

Flags for cleaning layer URIs.

Added in version 3.42.

RemoveCredentials: Completely remove credentials (eg passwords) from the URI. This flag is not compatible with the RedactCredentials flag.
RedactCredentials: Replace the value of credentials (eg passwords) with ‘xxxxxxxx’. This flag is not compatible with the RemoveCredentials flag.

RedactCredentials = 2¶

RemoveCredentials = 1¶

class UriCleaningFlags¶
class UriCleaningFlags(f: Qgis.UriCleaningFlags | Qgis.UriCleaningFlag)
class UriCleaningFlags(a0: Qgis.UriCleaningFlags): Bases: object

class UserProfileSelectionPolicy(*values)¶

Bases: IntEnum

User profile selection policy.

Added in version 3.32.

LastProfile: Open the last closed profile (only mode supported prior to QGIS 3.32)
DefaultProfile: Open a specific profile
AskUser: Let the user choose which profile to open

AskUser = 2¶

DefaultProfile = 1¶

LastProfile = 0¶

class VectorDataProviderAttributeEditCapabilities¶
class VectorDataProviderAttributeEditCapabilities(f: Qgis.VectorDataProviderAttributeEditCapabilities | Qgis.VectorDataProviderAttributeEditCapability)
class VectorDataProviderAttributeEditCapabilities(a0: Qgis.VectorDataProviderAttributeEditCapabilities): Bases: object

class VectorDataProviderAttributeEditCapability(*values)¶

Bases: IntEnum

Attribute editing capabilities which may be supported by vector data providers.

Added in version 3.32.

EditAlias: Allows editing aliases
EditComment: Allows editing comments

EditAlias = 1¶

EditComment = 2¶

class VectorDataProviderTemporalMode(*values)¶

Bases: IntEnum

Vector data provider temporal handling modes.

Added in version 3.22.

HasFixedTemporalRange: Entire dataset from provider has a fixed start and end datetime.

Available as QgsVectorDataProviderTemporalCapabilities.ProviderHasFixedTemporalRange in older QGIS releases.
StoresFeatureDateTimeInstantInField: Dataset has feature datetime instants stored in a single field

Available as QgsVectorDataProviderTemporalCapabilities.ProviderStoresFeatureDateTimeInstantInField in older QGIS releases.
StoresFeatureDateTimeStartAndEndInSeparateFields: Dataset stores feature start and end datetimes in separate fields

Available as QgsVectorDataProviderTemporalCapabilities.ProviderStoresFeatureDateTimeStartAndEndInSeparateFields in older QGIS releases.

class VectorEditResult(*values)¶

Bases: IntEnum

Specifies the result of a vector layer edit operation

Added 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

class VectorExportResult(*values)¶

Bases: IntEnum

Vector layer export result codes.

Added in version 3.20.

Success: No errors were encountered

Available as QgsVectorLayerExporter.NoError in older QGIS releases.
ErrorCreatingDataSource: Could not create the destination data source

Available as QgsVectorLayerExporter.ErrCreateDataSource in older QGIS releases.
ErrorCreatingLayer: Could not create destination layer

Available as QgsVectorLayerExporter.ErrCreateLayer in older QGIS releases.
ErrorAttributeTypeUnsupported: Source layer has an attribute type which could not be handled by destination

Available as QgsVectorLayerExporter.ErrAttributeTypeUnsupported in older QGIS releases.
ErrorAttributeCreationFailed: Destination provider was unable to create an attribute

Available as QgsVectorLayerExporter.ErrAttributeCreationFailed in older QGIS releases.
ErrorProjectingFeatures: An error occurred while reprojecting features to destination CRS

Available as QgsVectorLayerExporter.ErrProjection in older QGIS releases.
ErrorFeatureWriteFailed: An error occurred while writing a feature to the destination

Available as QgsVectorLayerExporter.ErrFeatureWriteFailed in older QGIS releases.
ErrorInvalidLayer: Could not access newly created destination layer

Available as QgsVectorLayerExporter.ErrInvalidLayer in older QGIS releases.
ErrorInvalidProvider: Could not find a matching provider key

Available as QgsVectorLayerExporter.ErrInvalidProvider in older QGIS releases.
ErrorProviderUnsupportedFeature: Provider does not support creation of empty layers

Available as QgsVectorLayerExporter.ErrProviderUnsupportedFeature in older QGIS releases.
ErrorConnectionFailed: Could not connect to destination

Available as QgsVectorLayerExporter.ErrConnectionFailed in older QGIS releases.
UserCanceled: User canceled the export

Available as QgsVectorLayerExporter.ErrUserCanceled in older QGIS releases.

class VectorFileWriterCapabilities¶
class VectorFileWriterCapabilities(f: Qgis.VectorFileWriterCapabilities | Qgis.VectorFileWriterCapability)
class VectorFileWriterCapabilities(a0: Qgis.VectorFileWriterCapabilities): Bases: object

class VectorFileWriterCapability(*values)¶

Bases: IntEnum

Capabilities supported by a QgsVectorFileWriter object.

Added in version 3.32.

FieldAliases: Writer can support field aliases
FieldComments: Writer can support field comments

FieldAliases = 1¶

FieldComments = 4¶

class VectorLayerTypeFlag(*values)¶

Bases: IntEnum

Vector layer type flags.

Added in version 3.24.

SqlQuery: SQL query layer

SqlQuery = 1¶

class VectorLayerTypeFlags¶
class VectorLayerTypeFlags(f: Qgis.VectorLayerTypeFlags | Qgis.VectorLayerTypeFlag)
class VectorLayerTypeFlags(a0: Qgis.VectorLayerTypeFlags): Bases: object

class VectorProfileType(*values)¶

Bases: IntEnum

Types of elevation profiles to generate for vector sources.

Added in version 3.26.

IndividualFeatures: Treat each feature as an individual object (eg buildings)
ContinuousSurface: The features should be treated as representing values on a continuous surface (eg contour lines)

ContinuousSurface = 1¶

IndividualFeatures = 0¶

class VectorProviderCapabilities¶
class VectorProviderCapabilities(f: Qgis.VectorProviderCapabilities | Qgis.VectorProviderCapability)
class VectorProviderCapabilities(a0: Qgis.VectorProviderCapabilities): Bases: object

class VectorProviderCapability(*values)¶

Bases: IntEnum

Vector data provider capabilities.

Note

Prior to QGIS 3.40 this was available as QgsVectorDataProvider.Capability

Added in version 3.40.

NoCapabilities: Provider has no capabilities
AddFeatures: Allows adding features
DeleteFeatures: Allows deletion of features
ChangeAttributeValues: Allows modification of attribute values
AddAttributes: Allows addition of new attributes (fields)
DeleteAttributes: Allows deletion of attributes (fields)
CreateSpatialIndex: Allows creation of spatial index
SelectAtId: Fast access to features using their ID
ChangeGeometries: Allows modifications of geometries
SelectEncoding: Allows user to select encoding
CreateAttributeIndex: Can create indexes on provider’s fields
SimplifyGeometries: Supports simplification of geometries on provider side according to a distance tolerance
SimplifyGeometriesWithTopologicalValidation: Supports topological simplification of geometries on provider side according to a distance tolerance
TransactionSupport: Supports transactions
CircularGeometries: Supports circular geometry types (circularstring, compoundcurve, curvepolygon)
ChangeFeatures: Supports joint updates for attributes and geometry. Providers supporting this should still define ChangeGeometries | ChangeAttributeValues.
RenameAttributes: Supports renaming attributes (fields)

Added in version 2.16.
FastTruncate: Supports fast truncation of the layer (removing all features)

Added in version 3.0.
ReadLayerMetadata: Provider can read layer metadata from data store. Since QGIS 3.0. See QgsDataProvider.layerMetadata()
WriteLayerMetadata: Provider can write layer metadata to the data store. Since QGIS 3.0. See QgsDataProvider.writeLayerMetadata()
CancelSupport: Supports interruption of pending queries from a separated thread

Added in version 3.2.
CreateRenderer: Provider can create feature renderers using backend-specific formatting information. Since QGIS 3.2. See QgsVectorDataProvider.createRenderer().
CreateLabeling: Provider can set labeling settings using backend-specific formatting information. Since QGIS 3.6. See QgsVectorDataProvider.createLabeling().
ReloadData: Provider is able to force reload data
FeatureSymbology: Provider is able retrieve embedded symbology associated with individual features

Added in version 3.20.
EditingCapabilities: Bitmask of all editing capabilities

class VectorRenderingSimplificationFlag(*values)¶

Bases: IntEnum

Simplification flags for vector feature rendering.

Note

Prior to QGIS 3.38 this was available as QgsVectorSimplifyMethod.SimplifyHint

Added in version 3.38.

NoSimplification: No simplification can be applied
GeometrySimplification: The geometries can be simplified using the current map2pixel context state
AntialiasingSimplification: The geometries can be rendered with ‘AntiAliasing’ disabled because of it is ‘1-pixel size’
FullSimplification: All simplification hints can be applied ( Geometry + AA-disabling )

class VectorRenderingSimplificationFlags¶
class VectorRenderingSimplificationFlags(f: Qgis.VectorRenderingSimplificationFlags | Qgis.VectorRenderingSimplificationFlag)
class VectorRenderingSimplificationFlags(a0: Qgis.VectorRenderingSimplificationFlags): Bases: object

class VectorSimplificationAlgorithm(*values)¶

Bases: IntEnum

Simplification algorithms for vector features.

Note

Prior to QGIS 3.38 this was available as QgsVectorSimplifyMethod.SimplifyAlgorithm

Added in version 3.38.

Distance: The simplification uses the distance between points to remove duplicate points
SnapToGrid: The simplification uses a grid (similar to ST_SnapToGrid) to remove duplicate points
Visvalingam: The simplification gives each point in a line an importance weighting, so that least important points are removed first
SnappedToGridGlobal: Snap to a global grid based on the tolerance. Good for consistent results for incoming vertices, regardless of their feature

class VectorTemporalLimitMode(*values)¶

Bases: IntEnum

Mode for the handling of the limits of the filtering timeframe for vector features

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

class VectorTemporalMode(*values)¶

Bases: IntEnum

Vector layer temporal feature modes

Added in version 3.22.

FixedTemporalRange: Mode when temporal properties have fixed start and end datetimes.

Available as QgsVectorLayerTemporalProperties.ModeFixedTemporalRange in older QGIS releases.
FeatureDateTimeInstantFromField: Mode when features have a datetime instant taken from a single field

Available as QgsVectorLayerTemporalProperties.ModeFeatureDateTimeInstantFromField in older QGIS releases.
FeatureDateTimeStartAndEndFromFields: Mode when features have separate fields for start and end times

Available as QgsVectorLayerTemporalProperties.ModeFeatureDateTimeStartAndEndFromFields in older QGIS releases.
FeatureDateTimeStartAndDurationFromFields: Mode when features have a field for start time and a field for event duration

Available as QgsVectorLayerTemporalProperties.ModeFeatureDateTimeStartAndDurationFromFields in older QGIS releases.
FeatureDateTimeStartAndEndFromExpressions: Mode when features use expressions for start and end times

Available as QgsVectorLayerTemporalProperties.ModeFeatureDateTimeStartAndEndFromExpressions in older QGIS releases.
RedrawLayerOnly: 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.

Available as QgsVectorLayerTemporalProperties.ModeRedrawLayerOnly in older QGIS releases.

class VectorTileProviderCapabilities¶
class VectorTileProviderCapabilities(f: Qgis.VectorTileProviderCapabilities | Qgis.VectorTileProviderCapability)
class VectorTileProviderCapabilities(a0: Qgis.VectorTileProviderCapabilities): Bases: object

class VectorTileProviderCapability(*values)¶

Bases: IntEnum

Enumeration with capabilities that vector tile data providers might implement.

Added in version 3.32.

ReadLayerMetadata: Provider can read layer metadata from data store. See QgsDataProvider.layerMetadata()

ReadLayerMetadata = 2¶

class VectorTileProviderFlag(*values)¶

Bases: IntEnum

Flags for vector tile data providers.

Added in version 3.32.

AlwaysUseTileMatrixSetFromProvider: Vector tile layer must always use the tile matrix set from the data provider, and should never store, restore or override the definition of this matrix set.

AlwaysUseTileMatrixSetFromProvider = 2¶

class VectorTileProviderFlags¶
class VectorTileProviderFlags(f: Qgis.VectorTileProviderFlags | Qgis.VectorTileProviderFlag)
class VectorTileProviderFlags(a0: Qgis.VectorTileProviderFlags): Bases: object

class VertexMarkerType(*values)¶

Bases: IntEnum

Editing vertex markers, used for showing vertices during a edit operation.

Added in version 3.22.

SemiTransparentCircle: Semi-transparent circle marker
Cross: Cross marker
NoMarker: No marker

class VertexType(*values)¶

Bases: IntEnum

Types of vertex.

Added in version 3.22.

Segment: The actual start or end point of a segment

Available as QgsVertexId.SegmentVertex in older QGIS releases.
Curve: An intermediate point on a segment defining the curvature of the segment

Available as QgsVertexId.CurveVertex in older QGIS releases.

class VerticalAxisInversion(*values)¶

Bases: IntEnum

Vertical axis inversion options for 3D views.

Added in version 3.30.

Never: Never invert vertical axis movements
WhenDragging: Invert vertical axis movements when dragging in first person modes
Always: Always invert vertical axis movements

Always = 2¶

Never = 0¶

WhenDragging = 1¶

class ViewSyncModeFlag(*values)¶

Bases: IntEnum

Synchronization of 2D map canvas and 3D view

Added in version 3.26.

Sync3DTo2D: Synchronize 3D view camera to the main map canvas extent
Sync2DTo3D: Update the 2D main canvas extent to include the viewed area from the 3D view

Sync2DTo3D = 2¶

Sync3DTo2D = 1¶

class ViewSyncModeFlags¶
class ViewSyncModeFlags(f: Qgis.ViewSyncModeFlags | Qgis.ViewSyncModeFlag)
class ViewSyncModeFlags(a0: Qgis.ViewSyncModeFlags): Bases: object

class VolumeUnit(*values)¶

Bases: IntEnum

Units of volume.

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes.VolumeUnit.

Added in version 3.30.

CubicMeters: Cubic meters

Available as QgsUnitTypes.VolumeCubicMeters in older QGIS releases.
CubicFeet: Cubic feet

Available as QgsUnitTypes.VolumeCubicFeet in older QGIS releases.
CubicYards: Cubic yards

Available as QgsUnitTypes.VolumeCubicYards in older QGIS releases.
Barrel: Barrels

Available as QgsUnitTypes.VolumeBarrel in older QGIS releases.
CubicDecimeter: Cubic decimeters

Available as QgsUnitTypes.VolumeCubicDecimeter in older QGIS releases.
Liters: Litres

Available as QgsUnitTypes.VolumeLiters in older QGIS releases.
GallonUS: US Gallons

Available as QgsUnitTypes.VolumeGallonUS in older QGIS releases.
CubicInch: Cubic inches

Available as QgsUnitTypes.VolumeCubicInch in older QGIS releases.
CubicCentimeter: Cubic Centimeters

Available as QgsUnitTypes.VolumeCubicCentimeter in older QGIS releases.
CubicDegrees: Cubic degrees, for planar geographic CRS volume measurements

Available as QgsUnitTypes.VolumeCubicDegrees in older QGIS releases.
Unknown: Unknown volume unit

Available as QgsUnitTypes.VolumeUnknownUnit in older QGIS releases.

class VsiHandlerType(*values)¶

Bases: IntEnum

GDAL VSI handler types.

Added in version 3.40.

Invalid: Invalid type, i.e. not a valid VSI handler
Archive: File archive type (e.g. vsizip)
Network: Generic network types (e.g. vsicurl)
Cloud: Specific cloud provider types (e.g. vsis3)
Memory: In-memory types (e.g. vsimem)
Other: All other types

Archive = 1¶

Cloud = 3¶

Invalid = 0¶

Memory = 4¶

Network = 2¶

Other = 5¶

Warning = 1¶

class WkbType(*values)¶

Bases: IntEnum

The WKB type describes the number of dimensions a geometry has

Point
LineString
Polygon

as well as the number of dimensions for each individual vertex

X (always)
Y (always)
Z (optional)
M (measurement value, optional)

it also has values for multi types, collections, unknown geometry, null geometry, no geometry and curve support.

These classes of geometry are often used for data sources to communicate what kind of geometry should be expected for a given geometry field. It is also used for tools or algorithms to decide if they should be available for a given geometry type or act in a different mode.

Note

Prior to 3.30 this was available as QgsWkbTypes.Type.

Added in version 3.30.

Unknown: Unknown
Point: Point
LineString: LineString
Polygon: Polygon
Triangle: Triangle
MultiPoint: MultiPoint
MultiLineString: MultiLineString
MultiPolygon: MultiPolygon
GeometryCollection: GeometryCollection
CircularString: CircularString
CompoundCurve: CompoundCurve
CurvePolygon: CurvePolygon
MultiCurve: MultiCurve
MultiSurface: MultiSurface
PolyhedralSurface: PolyhedralSurface

Added in version 3.40.
TIN: TIN

Added in version 3.40.
NoGeometry: No geometry
PointZ: PointZ
LineStringZ: LineStringZ
PolygonZ: PolygonZ
TriangleZ: TriangleZ
MultiPointZ: MultiPointZ
MultiLineStringZ: MultiLineStringZ
MultiPolygonZ: MultiPolygonZ
GeometryCollectionZ: GeometryCollectionZ
CircularStringZ: CircularStringZ
CompoundCurveZ: CompoundCurveZ
CurvePolygonZ: CurvePolygonZ
MultiCurveZ: MultiCurveZ
MultiSurfaceZ: MultiSurfaceZ
PolyhedralSurfaceZ: PolyhedralSurfaceZ
TINZ: TINZ
PointM: PointM
LineStringM: LineStringM
PolygonM: PolygonM
TriangleM: TriangleM
MultiPointM: MultiPointM
MultiLineStringM: MultiLineStringM
MultiPolygonM: MultiPolygonM
GeometryCollectionM: GeometryCollectionM
CircularStringM: CircularStringM
CompoundCurveM: CompoundCurveM
CurvePolygonM: CurvePolygonM
MultiCurveM: MultiCurveM
MultiSurfaceM: MultiSurfaceM
PolyhedralSurfaceM: PolyhedralSurfaceM
TINM: TINM
PointZM: PointZM
LineStringZM: LineStringZM
PolygonZM: PolygonZM
MultiPointZM: MultiPointZM
MultiLineStringZM: MultiLineStringZM
MultiPolygonZM: MultiPolygonZM
GeometryCollectionZM: GeometryCollectionZM
CircularStringZM: CircularStringZM
CompoundCurveZM: CompoundCurveZM
CurvePolygonZM: CurvePolygonZM
MultiCurveZM: MultiCurveZM
MultiSurfaceZM: MultiSurfaceZM
PolyhedralSurfaceZM: PolyhedralSurfaceM
TINZM: TINZM
TriangleZM: TriangleZM
Point25D: Point25D
LineString25D: LineString25D
Polygon25D: Polygon25D
MultiPoint25D: MultiPoint25D
MultiLineString25D: MultiLineString25D
MultiPolygon25D: MultiPolygon25D

class ZonalStatistic(*values)¶

Bases: IntEnum

Statistics to be calculated during a zonal statistics operation.

Added in version 3.36..

Count: Pixel count
Sum: Sum of pixel values
Mean: Mean of pixel values
Median: Median of pixel values
StDev: Standard deviation of pixel values
Min: Min of pixel values
Max: Max of pixel values
Range: Range of pixel values (max - min)
Minority: Minority of pixel values
Majority: Majority of pixel values
Variety: Variety (count of distinct) pixel values
Variance: Variance of pixel values
All: All statistics
Default: Default statistics

class ZonalStatisticResult(*values)¶

Bases: IntEnum

Zonal statistics result codes.

Added in version 3.36..

Success: Success
LayerTypeWrong: Layer is not a polygon layer
LayerInvalid: Layer is invalid
RasterInvalid: Raster layer is invalid
RasterBandInvalid: The raster band does not exist on the raster layer
FailedToCreateField: Output fields could not be created
Canceled: Algorithm was canceled

class ZonalStatistics¶
class ZonalStatistics(f: Qgis.ZonalStatistics | Qgis.ZonalStatistic)
class ZonalStatistics(a0: Qgis.ZonalStatistics): Bases: object

static defaultProjectScales() → str[source]¶

A string with default project scales.

Added in version 3.12.

Return type:: str

static devVersion() → str[source]¶

The development version

Added in version 3.12.

Return type:: str

static geosVersion() → str[source]¶

GEOS string version linked

Added in version 3.20.

Return type:: str

static geosVersionInt() → int[source]¶

GEOS version number linked

Added in version 3.20.

Return type:: int

static geosVersionMajor() → int[source]¶

GEOS Major version number linked

Added in version 3.20.

Return type:: int

static geosVersionMinor() → int[source]¶

GEOS Minor version number linked

Added in version 3.20.

Return type:: int

static geosVersionPatch() → int[source]¶

GEOS Patch version number linked

Added in version 3.20.

Return type:: int

static releaseName() → str[source]¶

Release name

Added in version 3.12.

Return type:: str

static version() → str[source]¶

Version string.

Added in version 3.12.

Return type:: str

static versionInt() → int[source]¶

Version number used for comparing versions using the “Check QGIS Version” function

Added in version 3.12.

Return type:: int