Class: Qgis¶

Provides global constants and enumerations 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.
`DatabaseProviderTableImportCapability`	Represents capabilities of a database provider connection when importing table data.
`DateTimeStatistic`	Available date/time statistics.
`DeviceConnectionStatus`	GPS connection status.
`DistanceUnit`	Units of distance
`DistanceUnitType`	Types of distance units
`DocumentationApi`	Documentation API
`DocumentationBrowser`	Documentation API browser
`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.
`HorizontalAnchorPoint`	Marker symbol horizontal anchor points.
`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
`LayoutRenderFlag`	Flags for controlling how a layout is rendered.
`LayoutUnit`	Layout measurement units
`LayoutUnitType`	Types of layout units
`LegendComponent`	Component of legends which can be styled.
`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.
`MeshRangeExtent`	Describes the extent used to compute mesh ranges (min/max values).
`MeshRangeLimit`	Describes the limits used to compute mesh ranges (min/max values).
`MetadataDateType`	Date types for metadata.
`MouseHandlesAction`	Action to be performed by the mouse handles
`NavigationMode`	The navigation mode used by 3D cameras.
`PaintEffectFlag`	Flags which control how paint effects behave.
`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.
`PointCloudAccessType`	The access type of the data, local is for local files and remote for remote files (over HTTP).
`PointCloudDrawOrder`	Pointcloud rendering order for 2d views
`PointCloudSymbol`	Rendering symbols for point cloud points.
`PointCloudZoomOutRenderBehavior`	Point cloud zoom out options
`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.
`ProcessingMode`	Types of modes which Processing widgets can be created for.
`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`
`QueryStorageBackend`	Stored query storage backends.
`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.
`RasterRangeAccuracy`	Describes the accuracy used to compute raster ranges (min/max values).
`RasterRangeExtent`	Describes the extent used to compute raster ranges (min/max values).
`RasterRangeLimit`	Describes the limits used to compute raster ranges (min/max values).
`RasterRendererCapability`	Raster renderer capabilities.
`RasterRendererFlag`	Flags which control behavior of raster renderers.
`RasterResamplingMethod`	Resampling method for raster provider-level resampling.
`RasterResamplingStage`	Stage at which raster resampling occurs.
`RasterTemporalCapabilityFlag`	Flags for raster layer temporal capabilities.
`RasterTemporalMode`	Raster layer temporal modes
`RasterizedRenderingPolicy`	Policies controlling when rasterisation of content during renders is permitted.
`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.
`SceneMode`	The 3D scene mode used in 3D map views.
`ScriptLanguage`	Scripting languages.
`ScriptLanguageCapability`	Script language capabilities.
`SegmentCalculationMethod`	brief Method used to calculate the number of segments for circle approximation
`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.
`StacObjectType`	Available types of stac objects
`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.
`VerticalAnchorPoint`	Marker symbol vertical anchor points.
`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
`geoNone`	Constant that holds the string representation for "No ellipse/No CRS".
`geoProj4`	PROJ4 string that represents a geographic coord system.
`geoWkt`	WKT string that represents a geographic coord system
`geographicCrsAuthId`	Geographic coordinate system auth:id string for a default geographic CRS (EPSG:4326).
`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_LINE_WIDTH`	The default width (in millimeters) for line symbols
`DEFAULT_MAPTOPIXEL_THRESHOLD`	Default threshold between map coordinates and device coordinates for map2pixel simplification
`DEFAULT_M_COORDINATE`	Default M coordinate value.
`DEFAULT_POINT_SIZE`	The default size (in millimeters) for point marker symbols
`DEFAULT_SEARCH_RADIUS_MM`	Identify search radius in mm
`DEFAULT_SEGMENT_EPSILON`	Default snapping tolerance for segments
`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.
`USER_CRS_START_ID`	Minimum ID number for a user-defined projection.
`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: float = 0.5¶: Default highlight buffer in mm.

DEFAULT_HIGHLIGHT_COLOR: QColor = <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: float = 1.0¶: Default highlight line/stroke minimum width in mm.

DEFAULT_LINE_WIDTH: float = 0.26¶: The default width (in millimeters) for line symbols

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

DEFAULT_M_COORDINATE: float = 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_POINT_SIZE: float = 2.0¶: The default size (in millimeters) for point marker symbols

DEFAULT_SEARCH_RADIUS_MM: float = 2.0¶: Identify search radius in mm

DEFAULT_SEGMENT_EPSILON: float = 1e-08¶: Default snapping tolerance for segments

DEFAULT_SNAP_TOLERANCE: float = 12.0¶: Default snapping distance tolerance.

DEFAULT_Z_COORDINATE: float = 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.
Is3DBasemapSource: Associated source should be considered a ‘3D basemap’ layer. See Qgis.MapLayerProperty.Is3DBasemapLayer.

Added in version 3.44.

FastExtent2D = 4¶

FastExtent3D = 8¶

Is3DBasemapSource = 16¶

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()
SetTableComment: Can set comments for tables via setTableComment()

Added in version 3.44.

SetFieldAlias = 2¶

SetFieldComment = 1¶

SetTableComment = 4¶

class DatabaseProviderTableImportCapabilities¶
class DatabaseProviderTableImportCapabilities(f: Qgis.DatabaseProviderTableImportCapabilities | Qgis.DatabaseProviderTableImportCapability)
class DatabaseProviderTableImportCapabilities(a0: Qgis.DatabaseProviderTableImportCapabilities): Bases: object

class DatabaseProviderTableImportCapability(*values)¶

Bases: IntEnum

Represents capabilities of a database provider connection when importing table data.

Added in version 3.44.

SetGeometryColumnName: Can set the name of the geometry column
SetPrimaryKeyName: Can set the name of the primary key column

SetGeometryColumnName = 1¶

SetPrimaryKeyName = 2¶

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 DocumentationApi(*values)¶

Bases: IntEnum

Documentation API

Added in version 3.42.

PyQgis: PyQgis API documentation
PyQgisSearch: Search in PyQgis API documentation
CppQgis: C++ QGIS API documentation
Qt: Qt API documentation

CppQgis = 2¶

PyQgis = 0¶

PyQgisSearch = 1¶

Qt = 3¶

class DocumentationBrowser(*values)¶

Bases: IntEnum

Documentation API browser

Added in version 3.42.

DeveloperToolsPanel: Embedded webview in the DevTools panel
SystemWebBrowser: Default system web browser

DeveloperToolsPanel = 0¶

SystemWebBrowser = 1¶

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
UnsetField: Clears the field value so that the data provider backend will populate using any backend triggers or similar logic

Added in version 3.44.
LargestGeometry: Use value from the feature with the largest geometry

Added in version 3.44.
MinimumValue: Use the minimum value from the features-to-be-merged

Added in version 3.44.
MaximumValue: Use the maximum value from the features-to-be-merged

Added in version 3.44.
SetToNull: Use a null value

Added in version 3.44.

DefaultValue = 0¶

GeometryWeighted = 2¶

LargestGeometry = 4¶

MaximumValue = 6¶

MinimumValue = 5¶

SetToNull = 7¶

Sum = 1¶

UnsetField = 3¶

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 HorizontalAnchorPoint(*values)¶

Bases: IntEnum

Marker symbol horizontal anchor points.

Note

Prior to QGIS 3.44 this was available as QgsMarkerSymbolLayer.HorizontalAnchorPoint

Added in version 3.44.

Left: Align to left side of symbol
Center: Align to horizontal center of symbol

Available as QgsMarkerSymbolLayer.HCenter in older QGIS releases.
Right: Align to right side of symbol

class HttpMethod(*values)¶

Bases: IntEnum

Different methods of HTTP requests

Added in version 3.22.

Get: GET method
Post: POST method
Head: HEAD method.

Added in version 3.44.
Put: PUT method.

Added in version 3.44.
Delete: DELETE method.

Added in version 3.44.

Delete = 4¶

Get = 0¶

Head = 2¶

Post = 1¶

Put = 3¶

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: Below right

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 LayoutRenderFlag(*values)¶

Bases: IntEnum

Flags for controlling how a layout is rendered.

Note

Prior to QGIS 3.44 this was available as QgsLayoutRenderContext.Flag

Added in version 3.44.

Debug: Debug/testing mode, items are drawn as solid rectangles.

Available as QgsLayoutRenderContext.FlagDebug in older QGIS releases.
OutlineOnly: Render items as outlines only.

Available as QgsLayoutRenderContext.FlagOutlineOnly in older QGIS releases.
Antialiasing: Use antialiasing when drawing items.

Available as QgsLayoutRenderContext.FlagAntialiasing in older QGIS releases.
UseAdvancedEffects: Enable advanced effects such as blend modes.

Deprecated since version 3.44.: Use rasterizedRenderingPolicy() instead.

Available as QgsLayoutRenderContext.FlagUseAdvancedEffects in older QGIS releases.
ForceVectorOutput: Force output in vector format where possible, even if items require rasterization to keep their correct appearance.

Deprecated since version 3.44.: Use rasterizedRenderingPolicy() instead.

Available as QgsLayoutRenderContext.FlagForceVectorOutput in older QGIS releases.
HideCoverageLayer: Hide coverage layer in outputs

Available as QgsLayoutRenderContext.FlagHideCoverageLayer in older QGIS releases.
DrawSelection: Draw selection

Available as QgsLayoutRenderContext.FlagDrawSelection in older QGIS releases.
DisableTiledRasterLayerRenders: If set, then raster layers will not be drawn as separate tiles. This may improve the appearance in exported files, at the cost of much higher memory usage during exports.

Available as QgsLayoutRenderContext.FlagDisableTiledRasterLayerRenders in older QGIS releases.
RenderLabelsByMapLayer: When rendering map items to multi-layered exports, render labels belonging to different layers into separate export layers

Available as QgsLayoutRenderContext.FlagRenderLabelsByMapLayer in older QGIS releases.
LosslessImageRendering: Render images losslessly whenever possible, instead of the default lossy jpeg rendering used for some destination devices (e.g. PDF).

Available as QgsLayoutRenderContext.FlagLosslessImageRendering in older QGIS releases.
SynchronousLegendGraphics: Query legend graphics synchronously.

Available as QgsLayoutRenderContext.FlagSynchronousLegendGraphics in older QGIS releases.
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 layout exports in all current Qt versions. This flag only applies to vector layout exports.

Added in version 3.38.

Available as QgsLayoutRenderContext.FlagAlwaysUseGlobalMasks in older QGIS releases.

class LayoutRenderFlags¶
class LayoutRenderFlags(f: Qgis.LayoutRenderFlags | Qgis.LayoutRenderFlag)
class LayoutRenderFlags(a0: Qgis.LayoutRenderFlags): Bases: object

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 LegendComponent(*values)¶

Bases: IntEnum

Component of legends which can be styled.

Prior to QGIS 3.42 this was available as QgsLegendStyle.Style

Added in version 3.42.

Undefined: Should not happen, only if corrupted project file
Hidden: Special style, item is hidden including margins around
Title: Legend title
Group: Legend group title
Subgroup: Legend subgroup title
Symbol: Symbol icon (excluding label)
SymbolLabel: Symbol label (excluding icon)

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.
Is3DBasemapLayer: Layer is considered a ‘3D basemap’ layer. This flag is similar to IsBasemapLayer, but reserved for layers which contain 3D data

Added in version 3.44.

Is3DBasemapLayer = 4¶

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.

Deprecated since version 3.44.: Use Qgis.RasterizedRenderingPolicy instead.
UseAdvancedEffects: Enable layer opacity and blending effects

Deprecated since version 3.44.: Use Qgis.RasterizedRenderingPolicy instead.
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 MeshRangeExtent(*values)¶

Bases: IntEnum

Describes the extent used to compute mesh ranges (min/max values).

Added in version 3.42.

WholeMesh: Whole mesh is used to compute statistics
FixedCanvas: Current extent of the canvas (at the time of computation) is used to compute statistics
UpdatedCanvas: Constantly updated extent of the canvas is used to compute statistics

FixedCanvas = 1¶

UpdatedCanvas = 2¶

WholeMesh = 0¶

class MeshRangeLimit(*values)¶

Bases: IntEnum

Describes the limits used to compute mesh ranges (min/max values).

Added in version 3.42.

NotSet: User defined
MinimumMaximum: Real min-max values

MinimumMaximum = 1¶

NotSet = 0¶

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 MouseHandlesAction(*values)¶

Bases: IntEnum

Action to be performed by the mouse handles

Added in version 3.42.

MoveItem: Move item
ResizeUp: Resize up (Top handle)
ResizeDown: Resize down (Bottom handle)
ResizeLeft: Resize left (Left handle)
ResizeRight: Resize right (Right handle)
ResizeLeftUp: Resize left up (Top left handle)
ResizeRightUp: Resize right up (Top right handle)
ResizeLeftDown: Resize left down (Bottom left handle)
ResizeRightDown: Resize right down (Bottom right handle)
SelectItem: Select item
NoAction: No action

MoveItem = 0¶

NoAction = 10¶

ResizeDown = 2¶

ResizeLeft = 3¶

ResizeLeftDown = 7¶

ResizeLeftUp = 5¶

ResizeRight = 4¶

ResizeRightDown = 8¶

ResizeRightUp = 6¶

ResizeUp = 1¶

SelectItem = 9¶

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
GlobeTerrainBased: Navigation similar to TerrainBased, but for use with globe

Added in version 3.44.

GlobeTerrainBased = 2¶

TerrainBased = 0¶

Walk = 1¶

NoLevel = 4¶

class PaintEffectFlag(*values)¶

Bases: IntEnum

Flags which control how paint effects behave.

Added in version 3.44.

RequiresRasterization: The effect requires raster-based rendering.

RequiresRasterization = 1¶

class PaintEffectFlags¶
class PaintEffectFlags(f: Qgis.PaintEffectFlags | Qgis.PaintEffectFlag)
class PaintEffectFlags(a0: Qgis.PaintEffectFlags): Bases: object

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 PointCloudAccessType(*values)¶

Bases: IntEnum

The access type of the data, local is for local files and remote for remote files (over HTTP).