Class: Qgis

class qgis.core.Qgis

Bases: sip.wrapper

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

Enums

ActionStart

Bases: enum.IntEnum

ActionType

Bases: enum.IntEnum

Aggregate

Bases: enum.IntEnum

AltitudeBinding

Bases: enum.IntEnum

AltitudeClamping

Bases: enum.IntEnum

AngleUnit

Bases: enum.IntEnum

AngularDirection

Bases: enum.IntEnum

AnimationState

Bases: enum.IntEnum

AnnotationItemEditOperationResult

Bases: enum.IntEnum

AnnotationItemFlag

Bases: enum.IntEnum

AnnotationItemGuiFlag

Bases: enum.IntEnum

AnnotationItemNodeType

Bases: enum.IntEnum

ArcGisRestServiceType

Bases: enum.IntEnum

AreaUnit

Bases: enum.IntEnum

AttributeActionType

Bases: enum.IntEnum

AttributeEditorContainerType

Bases: enum.IntEnum

AttributeEditorType

Bases: enum.IntEnum

AttributeFormLayout

Bases: enum.IntEnum

AttributeFormPythonInitCodeSource

Bases: enum.IntEnum

AttributeFormSuppression

Bases: enum.IntEnum

AutoRefreshMode

Bases: enum.IntEnum

AvoidIntersectionsMode

Bases: enum.IntEnum

Axis

Bases: enum.IntEnum

BabelCommandFlag

Bases: enum.IntEnum

BabelFormatCapability

Bases: enum.IntEnum

BetweenLineConstraint

Bases: enum.IntEnum

BlendMode

Bases: enum.IntEnum

BrowserDirectoryMonitoring

Bases: enum.IntEnum

BrowserItemCapability

Bases: enum.IntEnum

BrowserItemState

Bases: enum.IntEnum

BrowserItemType

Bases: enum.IntEnum

BrowserLayerType

Bases: enum.IntEnum

BufferSide

Bases: enum.IntEnum

CadConstraintType

Bases: enum.IntEnum

Capitalization

Bases: enum.IntEnum

CaptureTechnique

Bases: enum.IntEnum

ContentStatus

Bases: enum.IntEnum

CoordinateDisplayType

Bases: enum.IntEnum

CoordinateOrder

Bases: enum.IntEnum

CoordinateTransformationFlag

Bases: enum.IntEnum

CoverageValidityResult

Bases: enum.IntEnum

CrsAxisDirection

Bases: enum.IntEnum

CrsDefinitionFormat

Bases: enum.IntEnum

CrsIdentifierType

Bases: enum.IntEnum

CrsType

Bases: enum.IntEnum

CrsWktVariant

Bases: enum.IntEnum

DashPatternLineEndingRule

Bases: enum.IntEnum

DashPatternSizeAdjustment

Bases: enum.IntEnum

DataItemProviderCapability

Bases: enum.IntEnum

DataProviderFlag

Bases: enum.IntEnum

DataType

Bases: enum.IntEnum

DatabaseProviderConnectionCapability2

Bases: enum.IntEnum

DateTimeStatistic

Bases: enum.IntEnum

DeviceConnectionStatus

Bases: enum.IntEnum

DistanceUnit

Bases: enum.IntEnum

DistanceUnitType

Bases: enum.IntEnum

DpiMode

Bases: enum.IntEnum

DriveType

Bases: enum.IntEnum

ElevationMapCombineMethod

Bases: enum.IntEnum

EndCapStyle

Bases: enum.IntEnum

ExpressionType

Bases: enum.IntEnum

FeatureAvailability

Bases: enum.IntEnum

FeatureCountState

Bases: enum.IntEnum

FeatureRequestFilterType

Bases: enum.IntEnum

FeatureRequestFlag

Bases: enum.IntEnum

FeatureSymbologyExport

Bases: enum.IntEnum

FieldConfigurationFlag

Bases: enum.IntEnum

FieldDomainMergePolicy

Bases: enum.IntEnum

FieldDomainSplitPolicy

Bases: enum.IntEnum

FieldDomainType

Bases: enum.IntEnum

FieldMetadataProperty

Bases: enum.IntEnum

FileFilterType

Bases: enum.IntEnum

FileOperationFlag

Bases: enum.IntEnum

FilePathType

Bases: enum.IntEnum

GdalResampleAlgorithm

Bases: enum.IntEnum

GeometryOperationResult

Bases: enum.IntEnum

GeometryType

Bases: enum.IntEnum

GeometryValidationEngine

Bases: enum.IntEnum

GeometryValidityFlag

Bases: enum.IntEnum

GnssConstellation

Bases: enum.IntEnum

GpsConnectionStatus

alias of DeviceConnectionStatus

GpsConnectionType

Bases: enum.IntEnum

GpsFeatureType

Bases: enum.IntEnum

GpsFixStatus

Bases: enum.IntEnum

GpsInformationComponent

Bases: enum.IntEnum

GpsQualityIndicator

Bases: enum.IntEnum

GradientColorSource

Bases: enum.IntEnum

GradientSpread

Bases: enum.IntEnum

GradientType

Bases: enum.IntEnum

GraduatedMethod

Bases: enum.IntEnum

HistoryProviderBackend

Bases: enum.IntEnum

HttpMethod

Bases: enum.IntEnum

InputControllerType

Bases: enum.IntEnum

InvalidGeometryCheck

Bases: enum.IntEnum

JoinStyle

Bases: enum.IntEnum

LabelLinePlacementFlag

Bases: enum.IntEnum

LabelMultiLineAlignment

Bases: enum.IntEnum

LabelOffsetType

Bases: enum.IntEnum

LabelOverlapHandling

Bases: enum.IntEnum

LabelPlacement

Bases: enum.IntEnum

LabelPlacementEngineVersion

Bases: enum.IntEnum

LabelPolygonPlacementFlag

Bases: enum.IntEnum

LabelPredefinedPointPosition

Bases: enum.IntEnum

LabelQuadrantPosition

Bases: enum.IntEnum

LabelingFlag

Bases: enum.IntEnum

LayerFilter

Bases: enum.IntEnum

LayerTreeFilterFlag

Bases: enum.IntEnum

LayerTreeInsertionMethod

Bases: enum.IntEnum

LayerType

Bases: enum.IntEnum

LayoutUnit

Bases: enum.IntEnum

LayoutUnitType

Bases: enum.IntEnum

LegendJsonRenderFlag

Bases: enum.IntEnum

LightSourceType

Bases: enum.IntEnum

LineClipMode

Bases: enum.IntEnum

LineExtensionSide

Bases: enum.IntEnum

MakeValidMethod

Bases: enum.IntEnum

MapBoxGlStyleSourceType

Bases: enum.IntEnum

MapLayerActionFlag

Bases: enum.IntEnum

MapLayerActionTarget

Bases: enum.IntEnum

MapLayerProperty

Bases: enum.IntEnum

MapLayerRendererFlag

Bases: enum.IntEnum

MapRecenteringMode

Bases: enum.IntEnum

MapSettingsFlag

Bases: enum.IntEnum

MapToolUnit

Bases: enum.IntEnum

MarkerClipMode

Bases: enum.IntEnum

MarkerLinePlacement

Bases: enum.IntEnum

MarkerShape

Bases: enum.IntEnum

MeshEditingErrorType

Bases: enum.IntEnum

MetadataDateType

Bases: enum.IntEnum

NavigationMode

Bases: enum.IntEnum

PlaybackOperation

Bases: enum.IntEnum

PlotAxisSuffixPlacement

Bases: enum.IntEnum

PlotToolFlag

Bases: enum.IntEnum

Point3DShape

Bases: enum.IntEnum

PointCloudDrawOrder

Bases: enum.IntEnum

PointCloudSymbol

Bases: enum.IntEnum

PointCountMethod

Bases: enum.IntEnum

PostgresRelKind

Bases: enum.IntEnum

ProcessingAlgorithmFlag

Bases: enum.IntEnum

ProcessingDateTimeParameterDataType

Bases: enum.IntEnum

ProcessingFeatureSourceDefinitionFlag

Bases: enum.IntEnum

ProcessingFeatureSourceFlag

Bases: enum.IntEnum

ProcessingFieldParameterDataType

Bases: enum.IntEnum

ProcessingFileParameterBehavior

Bases: enum.IntEnum

ProcessingLogLevel

Bases: enum.IntEnum

ProcessingModelChildParameterSource

Bases: enum.IntEnum

ProcessingNumberParameterType

Bases: enum.IntEnum

ProcessingParameterFlag

Bases: enum.IntEnum

ProcessingParameterTypeFlag

Bases: enum.IntEnum

ProcessingPropertyAvailability

Bases: enum.IntEnum

ProcessingProviderFlag

Bases: enum.IntEnum

ProcessingSourceType

Bases: enum.IntEnum

ProcessingTinInputLayerType

Bases: enum.IntEnum

ProfileExportType

Bases: enum.IntEnum

ProfileGeneratorFlag

Bases: enum.IntEnum

ProfileSurfaceSymbology

Bases: enum.IntEnum

ProjectCapability

Bases: enum.IntEnum

ProjectFileFormat

Bases: enum.IntEnum

ProjectFlag

Bases: enum.IntEnum

ProjectReadFlag

Bases: enum.IntEnum

PropertyType

Bases: enum.IntEnum

ProviderStyleStorageCapability

Bases: enum.IntEnum

PythonMacroMode

Bases: enum.IntEnum

RasterAttributeTableFieldUsage

Bases: enum.IntEnum

RasterAttributeTableType

Bases: enum.IntEnum

RasterBandStatistic

Bases: enum.IntEnum

RasterBuildPyramidOption

Bases: enum.IntEnum

RasterColorInterpretation

Bases: enum.IntEnum

RasterDrawingStyle

Bases: enum.IntEnum

RasterExportType

Bases: enum.IntEnum

RasterFileWriterResult

Bases: enum.IntEnum

RasterIdentifyFormat

Bases: enum.IntEnum

RasterLayerType

Bases: enum.IntEnum

RasterPipeInterfaceRole

Bases: enum.IntEnum

RasterPyramidFormat

Bases: enum.IntEnum

RasterRendererFlag

Bases: enum.IntEnum

RasterResamplingStage

Bases: enum.IntEnum

RasterTemporalCapabilityFlag

Bases: enum.IntEnum

RasterTemporalMode

Bases: enum.IntEnum

RelationshipCapability

Bases: enum.IntEnum

RelationshipCardinality

Bases: enum.IntEnum

RelationshipStrength

Bases: enum.IntEnum

RelationshipType

Bases: enum.IntEnum

RenderContextFlag

Bases: enum.IntEnum

RenderSubcomponentProperty

Bases: enum.IntEnum

RenderUnit

Bases: enum.IntEnum

RendererUsage

Bases: enum.IntEnum

ScaleMethod

Bases: enum.IntEnum

ScaleToTileZoomLevelMethod

Bases: enum.IntEnum

ScriptLanguage

Bases: enum.IntEnum

ScriptLanguageCapability

Bases: enum.IntEnum

SelectBehavior

Bases: enum.IntEnum

SelectGeometryRelationship

Bases: enum.IntEnum

SelectionFlag

Bases: enum.IntEnum

SelectionRenderingMode

Bases: enum.IntEnum

SensorThingsEntity

Bases: enum.IntEnum

SettingsOption

Bases: enum.IntEnum

SettingsOrigin

Bases: enum.IntEnum

SettingsTreeNodeOption

Bases: enum.IntEnum

SettingsTreeNodeType

Bases: enum.IntEnum

SettingsType

Bases: enum.IntEnum

SldExportOption

Bases: enum.IntEnum

SldExportVendorExtension

Bases: enum.IntEnum

SnappingMode

Bases: enum.IntEnum

SnappingType

Bases: enum.IntEnum

SpatialFilterType

Bases: enum.IntEnum

SpatialIndexPresence

Bases: enum.IntEnum

SqlKeywordCategory

Bases: enum.IntEnum

SqlLayerDefinitionCapability

Bases: enum.IntEnum

Statistic

Bases: enum.IntEnum

StringStatistic

Bases: enum.IntEnum

SublayerFlag

Bases: enum.IntEnum

SublayerPromptMode

Bases: enum.IntEnum

SublayerQueryFlag

Bases: enum.IntEnum

SymbolCoordinateReference

Bases: enum.IntEnum

SymbolFlag

Bases: enum.IntEnum

SymbolLayerFlag

Bases: enum.IntEnum

SymbolLayerUserFlag

Bases: enum.IntEnum

SymbolPreviewFlag

Bases: enum.IntEnum

SymbolRenderHint

Bases: enum.IntEnum

SymbolRotationMode

Bases: enum.IntEnum

SymbolType

Bases: enum.IntEnum

SystemOfMeasurement

Bases: enum.IntEnum

TemporalIntervalMatchMethod

Bases: enum.IntEnum

TemporalNavigationMode

Bases: enum.IntEnum

TemporalUnit

Bases: enum.IntEnum

TextCharacterVerticalAlignment

Bases: enum.IntEnum

TextComponent

Bases: enum.IntEnum

TextHorizontalAlignment

Bases: enum.IntEnum

TextLayoutMode

Bases: enum.IntEnum

TextOrientation

Bases: enum.IntEnum

TextRenderFormat

Bases: enum.IntEnum

TextRendererFlag

Bases: enum.IntEnum

TextVerticalAlignment

Bases: enum.IntEnum

TileAvailability

Bases: enum.IntEnum

TileChildrenAvailability

Bases: enum.IntEnum

TilePixelRatio

Bases: enum.IntEnum

TileRefinementProcess

Bases: enum.IntEnum

TiledSceneBoundingVolumeType

Bases: enum.IntEnum

TiledSceneProviderCapability

Bases: enum.IntEnum

TiledSceneRendererFlag

Bases: enum.IntEnum

TiledSceneRequestFlag

Bases: enum.IntEnum

TransactionMode

Bases: enum.IntEnum

TransformDirection

Bases: enum.IntEnum

UnitType

Bases: enum.IntEnum

UnplacedLabelVisibility

Bases: enum.IntEnum

UpsideDownLabelHandling

Bases: enum.IntEnum

UserProfileSelectionPolicy

Bases: enum.IntEnum

VectorDataProviderAttributeEditCapability

Bases: enum.IntEnum

VectorDataProviderTemporalMode

Bases: enum.IntEnum

VectorEditResult

Bases: enum.IntEnum

VectorExportResult

Bases: enum.IntEnum

VectorFileWriterCapability

Bases: enum.IntEnum

VectorLayerTypeFlag

Bases: enum.IntEnum

VectorProfileType

Bases: enum.IntEnum

VectorTemporalLimitMode

Bases: enum.IntEnum

VectorTemporalMode

Bases: enum.IntEnum

VectorTileProviderCapability

Bases: enum.IntEnum

VectorTileProviderFlag

Bases: enum.IntEnum

VertexMarkerType

Bases: enum.IntEnum

VertexType

Bases: enum.IntEnum

VerticalAxisInversion

Bases: enum.IntEnum

ViewSyncModeFlag

Bases: enum.IntEnum

VolumeUnit

Bases: enum.IntEnum

WkbType

Bases: enum.IntEnum

ZonalStatistic

Bases: enum.IntEnum

ZonalStatisticResult

Bases: enum.IntEnum

Methods

defaultProjectScales

A string with default project scales.

devVersion

The development version

geosVersion

GEOS string version linked

geosVersionInt

GEOS version number linked

geosVersionMajor

GEOS Major version number linked

geosVersionMinor

GEOS Minor version number linked

geosVersionPatch

GEOS Patch version number linked

releaseName

Release name

version

Version string.

versionInt

Version number used for comparing versions using the "Check QGIS Version" function

Attributes

Critical

DEFAULT_HIGHLIGHT_BUFFER_MM

DEFAULT_HIGHLIGHT_COLOR

DEFAULT_HIGHLIGHT_MIN_WIDTH_MM

DEFAULT_MAPTOPIXEL_THRESHOLD

DEFAULT_M_COORDINATE

DEFAULT_SEARCH_RADIUS_MM

DEFAULT_SNAP_TOLERANCE

DEFAULT_Z_COORDINATE

Info

NoLevel

QGIS_DEV_VERSION

QGIS_RELEASE_NAME

QGIS_VERSION

QGIS_VERSION_INT

SCALE_PRECISION

Success

UI_SCALE_FACTOR

Warning

staticMetaObject

class ActionStart(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Enum to determine when an operation would begin

Added in version 3.22.

  • DownloadLater: Do not start immediately the action

  • DownloadImmediately: Action will start immediately

baseClass

alias of Qgis

class ActionType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

baseClass

alias of Qgis

class Aggregate(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.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().

baseClass

alias of Qgis

class AltitudeBinding(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Altitude binding.

Added in version 3.26.

  • Vertex: Clamp every vertex of feature

  • Centroid: Clamp just centroid of feature

Centroid = 1
Vertex = 0
baseClass

alias of Qgis

class AltitudeClamping(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

Absolute = 0
Relative = 1
Terrain = 2
baseClass

alias of Qgis

class AngleUnit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Units of angles.

Note

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

Added in version 3.30.

  • AngleDegrees: Degrees

  • AngleRadians: Square kilometers

  • AngleGon: Gon/gradian

  • AngleMinutesOfArc: Minutes of arc

  • AngleSecondsOfArc: Seconds of arc

  • AngleTurn: Turn/revolutions

  • AngleMilliradiansSI: Angular milliradians (SI definition, 1/1000 of radian)

  • AngleMilNATO: Angular mil (NATO definition, 6400 mil = 2PI radians)

  • AngleUnknownUnit: Unknown angle unit

baseClass

alias of Qgis

class AngularDirection(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Angular directions.

Added in version 3.24.

  • Clockwise: Clockwise direction

  • CounterClockwise: Counter-clockwise direction

  • NoOrientation: Unknown orientation or sentinel value

baseClass

alias of Qgis

class AnimationState(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

baseClass

alias of Qgis

class AnnotationItemEditOperationResult(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class AnnotationItemFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Flags for annotation items.

Added in version 3.22.

  • ScaleDependentBoundingBox: Item’s bounding box will vary depending on map scale

ScaleDependentBoundingBox = 1
baseClass

alias of Qgis

class AnnotationItemFlags
class AnnotationItemFlags(f: Qgis.AnnotationItemFlags | Qgis.AnnotationItemFlag)
class AnnotationItemFlags(a0: Qgis.AnnotationItemFlags)

Bases: sip.wrapper

baseClass

alias of Qgis

class AnnotationItemGuiFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class AnnotationItemGuiFlags
class AnnotationItemGuiFlags(f: Qgis.AnnotationItemGuiFlags | Qgis.AnnotationItemGuiFlag)
class AnnotationItemGuiFlags(a0: Qgis.AnnotationItemGuiFlags)

Bases: sip.wrapper

baseClass

alias of Qgis

class AnnotationItemNodeType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Annotation item node types.

Added in version 3.22.

  • VertexHandle: Node is a handle for manipulating vertices

VertexHandle = 0
baseClass

alias of Qgis

class ArcGisRestServiceType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Available ArcGIS REST service types.

Note

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

Added in version 3.28.

  • FeatureService: FeatureServer

  • MapService: MapServer

  • ImageService: ImageServer

  • GlobeServer: GlobeServer

  • GPServer: GPServer

  • GeocodeServer: GeocodeServer

  • Unknown: Other unknown/unsupported type

baseClass

alias of Qgis

class AreaUnit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Units of area

Note

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

Added in version 3.30.

  • AreaSquareMeters: Square meters

  • AreaSquareKilometers: Square kilometers

  • AreaSquareFeet: Square feet

  • AreaSquareYards: Square yards

  • AreaSquareMiles: Square miles

  • AreaHectares: Hectares

  • AreaAcres: Acres

  • AreaSquareNauticalMiles: Square nautical miles

  • AreaSquareDegrees: Square degrees, for planar geographic CRS area measurements

  • AreaSquareCentimeters: Square centimeters

  • AreaSquareMillimeters: Square millimeters

  • SquareInches: Square inches (since QGIS 3.32)

  • AreaUnknownUnit: Unknown areal unit

baseClass

alias of Qgis

class AttributeActionType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

baseClass

alias of Qgis

class AttributeEditorContainerType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class AttributeEditorType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Attribute editor types.

Note

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

Added in version 3.32.

  • AeTypeContainer: A container

  • AeTypeField: A field

  • AeTypeRelation: A relation

  • AeTypeQmlElement: A QML element

  • AeTypeHtmlElement: A HTML element

  • AeTypeAction: A layer action element (since QGIS 3.22)

  • AeTypeTextElement: A text element (since QGIS 3.30)

  • AeTypeSpacerElement: A spacer element (since QGIS 3.30)

  • AeTypeInvalid: Invalid

baseClass

alias of Qgis

class AttributeFormLayout(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

  • GeneratedLayout: Autogenerate a simple tabular layout for the form

  • TabLayout: “Drag and drop” layout. Needs to be configured.

  • UiFileLayout: Load a .ui file for the layout. Needs to be configured.

baseClass

alias of Qgis

class AttributeFormPythonInitCodeSource(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

  • CodeSourceNone: Do not use Python code at all

  • CodeSourceFile: Load the Python code from an external file

  • CodeSourceDialog: Use the Python code provided in the dialog

  • CodeSourceEnvironment: Use the Python code available in the Python environment

baseClass

alias of Qgis

class AttributeFormSuppression(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

  • SuppressDefault: Use the application-wide setting.

  • SuppressOn: Always suppress feature form.

  • SuppressOff: Never suppress feature form.

baseClass

alias of Qgis

class AutoRefreshMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class AvoidIntersectionsMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

baseClass

alias of Qgis

class Axis(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Cartesian axes.

Added in version 3.34.

  • X: X-axis

  • Y: Y-axis

  • Z: Z-axis

X = 0
Y = 1
Z = 2
baseClass

alias of Qgis

class BabelCommandFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class BabelCommandFlags
class BabelCommandFlags(f: Qgis.BabelCommandFlags | Qgis.BabelCommandFlag)
class BabelCommandFlags(a0: Qgis.BabelCommandFlags)

Bases: sip.wrapper

baseClass

alias of Qgis

class BabelFormatCapabilities
class BabelFormatCapabilities(f: Qgis.BabelFormatCapabilities | Qgis.BabelFormatCapability)
class BabelFormatCapabilities(a0: Qgis.BabelFormatCapabilities)

Bases: sip.wrapper

baseClass

alias of Qgis

class BabelFormatCapability(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class BetweenLineConstraint(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Between line constraints which can be enabled

Added in version 3.26.

  • NoConstraint: No additional constraint

  • Perpendicular: Perpendicular

  • Parallel: Parallel

baseClass

alias of Qgis

class BlendMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

  • BlendNormal: Normal

  • BlendLighten: Lighten

  • BlendScreen: Screen

  • BlendDodge: Dodge

  • BlendAddition: Addition

  • BlendDarken: Darken

  • BlendMultiply: Multiple

  • BlendBurn: Burn

  • BlendOverlay: Overlay

  • BlendSoftLight: Soft light

  • BlendHardLight: Hard light

  • BlendDifference: Difference

  • BlendSubtract: Subtract

  • BlendSource: Source

  • BlendDestinationOver: Destination over

  • BlendClear: Clear

  • BlendDestination: Destination

  • BlendSourceIn: Source in

  • BlendDestinationIn: Destination in

  • BlendSourceOut: Source out

  • BlendDestinationOut: Destination out

  • BlendSourceAtop: Source atop

  • BlendDestinationAtop: Destination atop

  • BlendXor: XOR

baseClass

alias of Qgis

class BrowserDirectoryMonitoring(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class BrowserItemCapabilities
class BrowserItemCapabilities(f: Qgis.BrowserItemCapabilities | Qgis.BrowserItemCapability)
class BrowserItemCapabilities(a0: Qgis.BrowserItemCapabilities)

Bases: sip.wrapper

baseClass

alias of Qgis

class BrowserItemCapability(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.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 (since QGIS 3.22)

  • RefreshChildrenWhenItemIsRefreshed: When the item is refreshed, all its populated children will also be refreshed in turn (since QGIS 3.26)

baseClass

alias of Qgis

class BrowserItemState(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

baseClass

alias of Qgis

class BrowserItemType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

baseClass

alias of Qgis

class BrowserLayerType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.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 (since QGIS 3.34)

baseClass

alias of Qgis

class BufferSide(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Side of line to buffer.

Added in version 3.22.

  • SideLeft: Buffer to left of line

  • SideRight: Buffer to right of line

baseClass

alias of Qgis

class CadConstraintType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class Capitalization(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.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 (since QGIS 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 (since QGIS 3.24)

baseClass

alias of Qgis

class CaptureTechnique(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

baseClass

alias of Qgis

class ContentStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class CoordinateDisplayType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class CoordinateOrder(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class CoordinateTransformationFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class CoordinateTransformationFlags
class CoordinateTransformationFlags(f: Qgis.CoordinateTransformationFlags | Qgis.CoordinateTransformationFlag)
class CoordinateTransformationFlags(a0: Qgis.CoordinateTransformationFlags)

Bases: sip.wrapper

baseClass

alias of Qgis

class CoverageValidityResult(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

Critical = 2
class CrsAxisDirection(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class CrsDefinitionFormat(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

CRS definition formats.

Added in version 3.24.

  • FormatWkt: WKT format (always recommended over proj string format)

  • FormatProj: Proj string format

baseClass

alias of Qgis

class CrsIdentifierType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

baseClass

alias of Qgis

class CrsType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class CrsWktVariant(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Coordinate reference system WKT formatting variants.

Note

Prior to QGIS 3.36 this was available as QgsCoordinateReferenceSystem.WktVariant

Added in version 3.36.

  • WKT1_GDAL: 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.

  • WKT1_ESRI: WKT1 as traditionally output by ESRI software, deriving from OGC 99-049.

  • WKT2_2015: Full WKT2 string, conforming to ISO 19162:2015(E) / OGC 12-063r5 with all possible nodes and new keyword names.

  • WKT2_2015_SIMPLIFIED: 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.

  • WKT2_2019: Preferred format for conversion of CRS to WKT for use with the GDAL library.

  • WKT2_2019_SIMPLIFIED: Preferred simplified format, matching the most recent WKT ISO standard. Currently an alias to WKT2_2019_SIMPLIFIED, but may change in future versions.

  • WKT_PREFERRED: Preferred format for conversion of CRS to WKT for use with the GDAL library.

  • WKT_PREFERRED_SIMPLIFIED: Preferred simplified format, matching the most recent WKT ISO standard. Currently an alias to WKT2_2019_SIMPLIFIED, but may change in future versions.

  • WKT_PREFERRED_GDAL: Preferred format for conversion of CRS to WKT for use with the GDAL library.

baseClass

alias of Qgis

DEFAULT_HIGHLIGHT_BUFFER_MM = 0.5
DEFAULT_HIGHLIGHT_COLOR = <PyQt5.QtGui.QColor object>
DEFAULT_HIGHLIGHT_MIN_WIDTH_MM = 1.0
DEFAULT_MAPTOPIXEL_THRESHOLD = 1.0
DEFAULT_M_COORDINATE = 0.0
DEFAULT_SEARCH_RADIUS_MM = 2.0
DEFAULT_SNAP_TOLERANCE = 12.0
DEFAULT_Z_COORDINATE = 0.0
class DashPatternLineEndingRule(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class DashPatternSizeAdjustment(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class DataItemProviderCapabilities
class DataItemProviderCapabilities(f: Qgis.DataItemProviderCapabilities | Qgis.DataItemProviderCapability)
class DataItemProviderCapabilities(a0: Qgis.DataItemProviderCapabilities)

Bases: sip.wrapper

baseClass

alias of Qgis

class DataItemProviderCapability(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Capabilities for data item providers.

Note

Prior to QGIS 3.36 this was available as QgsDataProvider.DataCapability

Added in version 3.36.

  • NoDataCapabilities: No capabilities

  • File: Can provides items which corresponds to files

  • Dir: Can provides items which corresponds to directories

  • Database: Can provides items which corresponds to databases

  • Net: Network/internet source

baseClass

alias of Qgis

class DataProviderFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Generic data provider flags.

Added in version 3.26.

  • IsBasemapSource: Associated source should be considered a ‘basemap’ layer. See Qgis.MapLayerProperty.IsBasemapLayer.

IsBasemapSource = 2
baseClass

alias of Qgis

class DataProviderFlags
class DataProviderFlags(f: Qgis.DataProviderFlags | Qgis.DataProviderFlag)
class DataProviderFlags(a0: Qgis.DataProviderFlags)

Bases: sip.wrapper

baseClass

alias of Qgis

class DataType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

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

  • UnknownDataType: Unknown or unspecified type

  • Byte: Eight bit unsigned integer (quint8)

  • 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

baseClass

alias of Qgis

class DatabaseProviderConnectionCapabilities2
class DatabaseProviderConnectionCapabilities2(f: Qgis.DatabaseProviderConnectionCapabilities2 | Qgis.DatabaseProviderConnectionCapability2)
class DatabaseProviderConnectionCapabilities2(a0: Qgis.DatabaseProviderConnectionCapabilities2)

Bases: sip.wrapper

baseClass

alias of Qgis

class DatabaseProviderConnectionCapability2(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

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

Added in version 3.32.

  • SetFieldComment: Can set comments for fields via setFieldComment()

  • SetFieldAlias: Can set aliases for fields via setFieldAlias()

SetFieldAlias = 2
SetFieldComment = 1
baseClass

alias of Qgis

class DateTimeStatistic(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

baseClass

alias of Qgis

class DateTimeStatistics
class DateTimeStatistics(f: Qgis.DateTimeStatistics | Qgis.DateTimeStatistic)
class DateTimeStatistics(a0: Qgis.DateTimeStatistics)

Bases: sip.wrapper

baseClass

alias of Qgis

class DeviceConnectionStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

GPS connection status.

Added in version 3.30.

  • Disconnected: Device is disconnected

  • Connecting: Device is connecting

  • Connected: Device is successfully connected

baseClass

alias of Qgis

class DistanceUnit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Units of distance

Note

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

Added in version 3.30.

  • DistanceMeters: Meters

  • DistanceKilometers: Kilometers

  • DistanceFeet: Imperial feet

  • DistanceNauticalMiles: Nautical miles

  • DistanceYards: Imperial yards

  • DistanceMiles: Terrestrial miles

  • DistanceDegrees: Degrees, for planar geographic CRS distance measurements

  • DistanceCentimeters: Centimeters

  • DistanceMillimeters: Millimeters

  • Inches: Inches (since QGIS 3.32)

  • DistanceUnknownUnit: Unknown distance unit

baseClass

alias of Qgis

class DistanceUnitType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

  • UnknownType: Unknown unit type

baseClass

alias of Qgis

class DpiMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class DriveType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class ElevationMapCombineMethod(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class EndCapStyle(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

End cap styles for buffers.

Added in version 3.22.

  • CapRound: Round cap

  • CapFlat: Flat cap (in line with start/end of line)

  • CapSquare: Square cap (extends past start/end of line by buffer distance)

baseClass

alias of Qgis

class ExpressionType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Expression types

Added in version 3.32.

  • Qgis: Native QGIS expression

  • PointCloud: Point cloud expression

  • RasterCalculator: Raster calculator expression (since QGIS 3.34)

PointCloud = 1
Qgis = 0
RasterCalculator = 2
baseClass

alias of Qgis

class FeatureAvailability(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

baseClass

alias of Qgis

class FeatureCountState(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Enumeration of feature count states

Added in version 3.20.

  • Uncounted: Feature count not yet computed

  • UnknownCount: Provider returned an unknown feature count

baseClass

alias of Qgis

class FeatureRequestFilterType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Types of feature request filters.

Note

Prior to QGIS 3.36 this was available as QgsFeatureRequest.FilterType

Added in version 3.36.

  • FilterNone: No filter is applied

  • FilterFid: Filter using feature ID

  • FilterExpression: Filter using expression

  • FilterFids: Filter using feature IDs

baseClass

alias of Qgis

class FeatureRequestFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.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. (Since QGIS 3.18)

  • EmbeddedSymbols: Retrieve any embedded feature symbology (since QGIS 3.20)

baseClass

alias of Qgis

class FeatureRequestFlags
class FeatureRequestFlags(f: Qgis.FeatureRequestFlags | Qgis.FeatureRequestFlag)
class FeatureRequestFlags(a0: Qgis.FeatureRequestFlags)

Bases: sip.wrapper

baseClass

alias of Qgis

class FeatureSymbologyExport(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

  • FeatureSymbology: Keeps the number of features and export symbology per feature

  • SymbolLayerSymbology: Exports one feature per symbol layer (considering symbol levels)

baseClass

alias of Qgis

class FieldConfigurationFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class FieldConfigurationFlags
class FieldConfigurationFlags(f: Qgis.FieldConfigurationFlags | Qgis.FieldConfigurationFlag)
class FieldConfigurationFlags(a0: Qgis.FieldConfigurationFlags)

Bases: sip.wrapper

baseClass

alias of Qgis

class FieldDomainMergePolicy(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Merge policy for field domains.

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

Added in version 3.26.

  • DefaultValue: Use default field value

  • Sum: Sum of values

  • GeometryWeighted: New values are computed as the weighted average of the source values

DefaultValue = 0
GeometryWeighted = 2
Sum = 1
baseClass

alias of Qgis

class FieldDomainSplitPolicy(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.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 (since QGIS 3.30)

DefaultValue = 0
Duplicate = 1
GeometryRatio = 2
UnsetField = 3
baseClass

alias of Qgis

class FieldDomainType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class FieldMetadataProperty(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class FileFilterType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Type of file filters

Prior to QGIS 3.32 this was available as QgsProviderMetadata.FilterType

Added in version 3.32.

  • FilterVector: Vector layers

  • FilterRaster: Raster layers

  • FilterMesh: Mesh layers

  • FilterMeshDataset: Mesh datasets

  • FilterPointCloud: Point clouds (since QGIS 3.18)

  • VectorTile: Vector tile layers (since QGIS 3.32)

  • TiledScene: Tiled scene layers (since QGIS 3.34)

baseClass

alias of Qgis

class FileOperationFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class FileOperationFlags
class FileOperationFlags(f: Qgis.FileOperationFlags | Qgis.FileOperationFlag)
class FileOperationFlags(a0: Qgis.FileOperationFlags)

Bases: sip.wrapper

baseClass

alias of Qgis

class FilePathType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

File path types.

Added in version 3.22.

  • Absolute: Absolute path

  • Relative: Relative path

Absolute = 0
Relative = 1
baseClass

alias of Qgis

class GdalResampleAlgorithm(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

baseClass

alias of Qgis

class GeometryOperationResult(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

baseClass

alias of Qgis

class GeometryType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

  • PointGeometry: Points

  • LineGeometry: Lines

  • PolygonGeometry: Polygons

  • UnknownGeometry: Unknown types

  • NullGeometry: No geometry

baseClass

alias of Qgis

class GeometryValidationEngine(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Available engines for validating geometries.

Added in version 3.22.

  • ValidatorQgisInternal: Use internal QgsGeometryValidator method

  • ValidatorGeos: Use GEOS validation methods

baseClass

alias of Qgis

class GeometryValidityFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Geometry validity check flags.

Added in version 3.22.

  • FlagAllowSelfTouchingHoles: Indicates that self-touching holes are permitted. OGC validity states that self-touching holes are NOT permitted, whilst other vendor validity checks (e.g. ESRI) permit self-touching holes.

baseClass

alias of Qgis

class GeometryValidityFlags
class GeometryValidityFlags(f: Qgis.GeometryValidityFlags | Qgis.GeometryValidityFlag)
class GeometryValidityFlags(a0: Qgis.GeometryValidityFlags)

Bases: sip.wrapper

baseClass

alias of Qgis

class GnssConstellation(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

GpsConnectionStatus

alias of DeviceConnectionStatus

class GpsConnectionType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class GpsFeatureType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

GPS feature types.

Added in version 3.22.

  • Waypoint: Waypoint

  • Route: Route

  • Track: Track

Route = 1
Track = 2
Waypoint = 0
baseClass

alias of Qgis

class GpsFixStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

baseClass

alias of Qgis

class GpsInformationComponent(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class GpsInformationComponents
class GpsInformationComponents(f: Qgis.GpsInformationComponents | Qgis.GpsInformationComponent)
class GpsInformationComponents(a0: Qgis.GpsInformationComponents)

Bases: sip.wrapper

baseClass

alias of Qgis

class GpsQualityIndicator(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class GradientColorSource(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

baseClass

alias of Qgis

class GradientSpread(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

baseClass

alias of Qgis

class GradientType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

baseClass

alias of Qgis

class GraduatedMethod(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

  • GraduatedColor: Alter color of symbols

  • GraduatedSize: Alter size of symbols

baseClass

alias of Qgis

class HistoryProviderBackend(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

History provider backends.

Added in version 3.24.

  • LocalProfile: Local profile

LocalProfile = 1
baseClass

alias of Qgis

class HistoryProviderBackends
class HistoryProviderBackends(f: Qgis.HistoryProviderBackends | Qgis.HistoryProviderBackend)
class HistoryProviderBackends(a0: Qgis.HistoryProviderBackends)

Bases: sip.wrapper

baseClass

alias of Qgis

class HttpMethod(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Different methods of HTTP requests

Added in version 3.22.

  • Get: GET method

  • Post: POST method

Get = 0
Post = 1
baseClass

alias of Qgis

Info = 0
class InputControllerType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Input controller types.

Added in version 3.34.

  • Map2D: 2D map controller

  • Map3D: 3D map controller

Map2D = 0
Map3D = 1
baseClass

alias of Qgis

class InvalidGeometryCheck(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

  • GeometryNoCheck: No invalid geometry checking

  • GeometrySkipInvalid: Skip any features with invalid geometry. This requires a slow geometry validity check for every feature.

  • GeometryAbortOnInvalid: Close iterator on encountering any features with invalid geometry. This requires a slow geometry validity check for every feature.

baseClass

alias of Qgis

class JoinStyle(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Join styles for buffers.

Added in version 3.22.

  • JoinStyleRound: Use rounded joins

  • JoinStyleMiter: Use mitered joins

  • JoinStyleBevel: Use beveled joins

baseClass

alias of Qgis

class LabelLinePlacementFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

baseClass

alias of Qgis

class LabelLinePlacementFlags
class LabelLinePlacementFlags(f: Qgis.LabelLinePlacementFlags | Qgis.LabelLinePlacementFlag)
class LabelLinePlacementFlags(a0: Qgis.LabelLinePlacementFlags)

Bases: sip.wrapper

baseClass

alias of Qgis

class LabelMultiLineAlignment(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Text alignment for multi-line labels.

Note

Prior to QGIS 3.26 this was available as QgsPalLayerSettings.MultiLineAlign

Added in version 3.26.

  • MultiLeft: Left align

  • MultiCenter: Center align

  • MultiRight: Right align

  • MultiFollowPlacement: Alignment follows placement of label, e.g., labels to the left of a feature will be drawn with right alignment

  • MultiJustify: Justified

baseClass

alias of Qgis

class LabelOffsetType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

baseClass

alias of Qgis

class LabelOverlapHandling(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class LabelPlacement(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.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. Since QGIS 3.14

baseClass

alias of Qgis

class LabelPlacementEngineVersion(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Labeling placement engine version.

Prior to QGIS 3.30 this was available as QgsLabelingEngineSettings.PlacementEngineVersion

Added in version 3.30.

  • PlacementEngineVersion1: Version 1, matches placement from QGIS <= 3.10.1

  • PlacementEngineVersion2: Version 2 (default for new projects since QGIS 3.12)

baseClass

alias of Qgis

class LabelPolygonPlacementFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

baseClass

alias of Qgis

class LabelPolygonPlacementFlags
class LabelPolygonPlacementFlags(f: Qgis.LabelPolygonPlacementFlags | Qgis.LabelPolygonPlacementFlag)
class LabelPolygonPlacementFlags(a0: Qgis.LabelPolygonPlacementFlags)

Bases: sip.wrapper

baseClass

alias of Qgis

class LabelPredefinedPointPosition(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

baseClass

alias of Qgis

class LabelQuadrantPosition(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Label quadrant positions

Note

Prior to QGIS 3.26 this was available as QgsPalLayerSettings.QuadrantPosition

Added in version 3.26.

  • QuadrantAboveLeft: Above left

  • QuadrantAbove: Above center

  • QuadrantAboveRight: Above right

  • QuadrantLeft: Left middle

  • QuadrantOver: Center middle

  • QuadrantRight: Right middle

  • QuadrantBelowLeft: Below left

  • QuadrantBelow: Below center

  • QuadrantBelowRight: BelowRight

baseClass

alias of Qgis

class LabelingFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.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). Since QGIS 3.20

  • DrawLabelMetrics: Whether to render label metric guides (for debugging). Since QGIS 3.30

baseClass

alias of Qgis

class LabelingFlags
class LabelingFlags(f: Qgis.LabelingFlags | Qgis.LabelingFlag)
class LabelingFlags(a0: Qgis.LabelingFlags)

Bases: sip.wrapper

baseClass

alias of Qgis

class LayerFilter(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

Added in version 3.14.

Added in version 3.18.

Added in version 3.22.

Added in version 3.34.

  • All:

  • SpatialLayer: .. versionadded:: 3.24

class LayerFilters
class LayerFilters(f: Qgis.LayerFilters | Qgis.LayerFilter)
class LayerFilters(a0: Qgis.LayerFilters)

Bases: sip.wrapper

baseClass

alias of Qgis

class LayerTreeFilterFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Layer tree filter flags.

Added in version 3.32.

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

SkipVisibilityCheck = 1
baseClass

alias of Qgis

class LayerTreeFilterFlags
class LayerTreeFilterFlags(f: Qgis.LayerTreeFilterFlags | Qgis.LayerTreeFilterFlag)
class LayerTreeFilterFlags(a0: Qgis.LayerTreeFilterFlags)

Bases: sip.wrapper

baseClass

alias of Qgis

class LayerTreeInsertionMethod(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class LayerType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Types of layers that can be added to a map

Added in version 3.30..

  • VectorLayer: Vector layer

  • RasterLayer: Raster layer

  • PluginLayer: Plugin based layer

  • MeshLayer: Mesh layer. Added in QGIS 3.2

  • VectorTileLayer: Vector tile layer. Added in QGIS 3.14

  • AnnotationLayer: Contains freeform, georeferenced annotations. Added in QGIS 3.16

  • PointCloudLayer: Point cloud layer. Added in QGIS 3.18

  • GroupLayer: Composite group layer. Added in QGIS 3.24

  • TiledScene: Tiled scene layer. Added in QGIS 3.34

baseClass

alias of Qgis

class LayoutUnit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Layout measurement units

Note

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

Added in version 3.30.

  • LayoutMillimeters: Millimeters

  • LayoutCentimeters: Centimeters

  • LayoutMeters: Meters

  • LayoutInches: Inches

  • LayoutFeet: Feet

  • LayoutPoints: Typographic points

  • LayoutPicas: Typographic picas

  • LayoutPixels: Pixels

baseClass

alias of Qgis

class LayoutUnitType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Types of layout units

Note

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

Added in version 3.30.

  • LayoutPaperUnits: Unit is a paper based measurement unit

  • LayoutScreenUnits: Unit is a screen based measurement unit

baseClass

alias of Qgis

class LegendJsonRenderFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class LegendJsonRenderFlags
class LegendJsonRenderFlags(f: Qgis.LegendJsonRenderFlags | Qgis.LegendJsonRenderFlag)
class LegendJsonRenderFlags(a0: Qgis.LegendJsonRenderFlags)

Bases: sip.wrapper

baseClass

alias of Qgis

class LightSourceType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Light source types for 3D scenes.

Added in version 3.26.

  • Point: Point light source

  • Directional: Directional light source

Directional = 1
Point = 0
baseClass

alias of Qgis

class LineClipMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class LineExtensionSide(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class MakeValidMethod(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class MapBoxGlStyleSourceType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class MapLayerActionFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

baseClass

alias of Qgis

class MapLayerActionFlags
class MapLayerActionFlags(f: Qgis.MapLayerActionFlags | Qgis.MapLayerActionFlag)
class MapLayerActionFlags(a0: Qgis.MapLayerActionFlags)

Bases: sip.wrapper

baseClass

alias of Qgis

class MapLayerActionTarget(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

baseClass

alias of Qgis

class MapLayerActionTargets
class MapLayerActionTargets(f: Qgis.MapLayerActionTargets | Qgis.MapLayerActionTarget)
class MapLayerActionTargets(a0: Qgis.MapLayerActionTargets)

Bases: sip.wrapper

baseClass

alias of Qgis

class MapLayerProperties
class MapLayerProperties(f: Qgis.MapLayerProperties | Qgis.MapLayerProperty)
class MapLayerProperties(a0: Qgis.MapLayerProperties)

Bases: sip.wrapper

baseClass

alias of Qgis

class MapLayerProperty(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.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. Since QGIS 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. Since QGIS 3.26.

IsBasemapLayer = 2
UsersCannotToggleEditing = 1
baseClass

alias of Qgis

class MapLayerRendererFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

RenderPartialOutputOverPreviousCachedImage = 2
RenderPartialOutputs = 1
baseClass

alias of Qgis

class MapLayerRendererFlags
class MapLayerRendererFlags(f: Qgis.MapLayerRendererFlags | Qgis.MapLayerRendererFlag)
class MapLayerRendererFlags(a0: Qgis.MapLayerRendererFlags)

Bases: sip.wrapper

baseClass

alias of Qgis

class MapRecenteringMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class MapSettingsFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Flags which adjust the way maps are rendered.

Added in version 3.22.

  • Antialiasing: Enable anti-aliasing for map rendering

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

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

  • UseAdvancedEffects: Enable layer opacity and blending effects

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

  • UseRenderingOptimization: Enable vector simplification and other rendering optimizations

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

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

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

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

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

  • RenderBlocking: Render and load remote sources in the same thread to ensure rendering remote sources (svg and images). WARNING: this flag must NEVER be used from GUI based applications (like the main QGIS application) or crashes will result. Only for use in external scripts or QGIS server.

  • LosslessImageRendering: Render images losslessly whenever possible, instead of the default lossy jpeg rendering used for some destination devices (e.g. PDF). This flag only works with builds based on Qt 5.13 or later.

  • Render3DMap: Render is for a 3D map

  • HighQualityImageTransforms: Enable high quality image transformations, which results in better appearance of scaled or rotated raster components of a map (since QGIS 3.24)

  • SkipSymbolRendering: Disable symbol rendering while still drawing labels if enabled (since QGIS 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. (since QGIS 3.26.1)

  • RecordProfile: Enable run-time profiling while rendering (since QGIS 3.34)

baseClass

alias of Qgis

class MapSettingsFlags
class MapSettingsFlags(f: Qgis.MapSettingsFlags | Qgis.MapSettingsFlag)
class MapSettingsFlags(a0: Qgis.MapSettingsFlags)

Bases: sip.wrapper

baseClass

alias of Qgis

class MapToolUnit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

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

Added in version 3.32.

  • LayerUnits: Layer unit value

  • Pixels: Pixels unit of tolerance

  • ProjectUnits: Map (project) units

baseClass

alias of Qgis

class MarkerClipMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class MarkerLinePlacement(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.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) (since QGIS 3.24)

baseClass

alias of Qgis

class MarkerLinePlacements
class MarkerLinePlacements(f: Qgis.MarkerLinePlacements | Qgis.MarkerLinePlacement)
class MarkerLinePlacements(a0: Qgis.MarkerLinePlacements)

Bases: sip.wrapper

baseClass

alias of Qgis

class MarkerShape(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.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 (since QGIS 3.18)

  • SquareWithCorners: A square with diagonal corners (since QGIS 3.18)

  • AsteriskFill: A filled asterisk shape (since QGIS 3.18)

  • HalfArc: A line-only half arc (since QGIS 3.20)

  • ThirdArc: A line-only one third arc (since QGIS 3.20)

  • QuarterArc: A line-only one quarter arc (since QGIS 3.20)

  • ParallelogramRight: Parallelogram that slants right (since QGIS 3.28)

  • ParallelogramLeft: Parallelogram that slants left (since QGIS 3.28)

  • Trapezoid: Trapezoid (since QGIS 3.28)

  • Shield: A shape consisting of a triangle attached to a rectangle (since QGIS 3.28)

  • DiamondStar: A 4-sided star (since QGIS 3.28)

  • Heart: Heart (since QGIS 3.28)

  • Decagon: Decagon (since QGIS 3.28)

  • RoundedSquare: A square with rounded corners (since QGIS 3.28)

baseClass

alias of Qgis

class MeshEditingErrorType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class MessageLevel

Bases: int

baseClass

alias of Qgis

class MetadataDateType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class NavigationMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

The navigation mode used by 3D cameras.

Added in version 3.30.

  • TerrainBased: The default navigation based on the terrain

  • Walk: Uses WASD keys or arrows to navigate in walking (first person) manner

TerrainBased = 0
Walk = 1
baseClass

alias of Qgis

NoLevel = 4
class PlaybackOperation(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class PlotAxisSuffixPlacement(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class PlotToolFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

alias of Qgis

class PlotToolFlags
class PlotToolFlags(f: Qgis.PlotToolFlags | Qgis.PlotToolFlag)
class PlotToolFlags(a0: Qgis.PlotToolFlags)

Bases: sip.wrapper

baseClass

alias of Qgis

class Point3DShape(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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

Billboard = 8
Cone = 2
Cube = 3
Cylinder = 0
ExtrudedText = 6
Model = 7
Plane = 5
Sphere = 1
Torus = 4
baseClass

alias of Qgis

class PointCloudDrawOrder(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Pointcloud rendering order for 2d views

/since QGIS 3.26

  • Default: Draw points in the order they are stored

  • BottomToTop: Draw points with larger Z values last

  • TopToBottom: Draw points with larger Z values first

baseClass

alias of Qgis

class PointCloudSymbol(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Rendering symbols for point cloud points.

Added in version 3.26.

  • Square: Renders points as squares

  • Circle: Renders points as circles

baseClass

alias of Qgis

class PointCountMethod(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

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

Note

Prior to QGIS 3.24 this was available as QgsRandomMarkerFillSymbolLayer.CountMethod

Added in version 3.24.

  • AbsoluteCount: The point count is used as an absolute count of markers

  • DensityBasedCount: The point count is part of a marker density count

baseClass

alias of Qgis

class PostgresRelKind(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Postgres database relkind options.

Added in version 3.32.

  • NotSet: Not set

  • Unknown: Unknown

  • OrdinaryTable: Ordinary table

  • Index: Index

  • Sequence: Sequence

  • View: View

  • MaterializedView: Materialized view

  • CompositeType: Composition type

  • ToastTable: TOAST table

  • ForeignTable: Foreign table

  • PartitionedTable: Partitioned table

CompositeType = 7
ForeignTable = 9
Index = 3
MaterializedView = 6
NotSet = 0
OrdinaryTable = 2
PartitionedTable = 10
Sequence = 4
ToastTable = 8
Unknown = 1
View = 5
baseClass

alias of Qgis

class ProcessingAlgorithmFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

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

Note

Prior to QGIS 3.36 this was available as QgsProcessingAlgorithm.Flag

Added in version 3.36.

  • FlagHideFromToolbox: Algorithm should be hidden from the toolbox

  • FlagHideFromModeler: Algorithm should be hidden from the modeler

  • FlagSupportsBatch: Algorithm supports batch mode

  • FlagCanCancel: Algorithm can be canceled

  • FlagRequiresMatchingCrs: Algorithm requires that all input layers have matching coordinate reference systems

  • FlagNoThreading: Algorithm is not thread safe and cannot be run in a background thread, e.g. for algorithms which manipulate the current project, layer selections, or with external dependencies which are not thread-safe.

  • FlagDisplayNameIsLiteral: Algorithm’s display name is a static literal string, and should not be translated or automatically formatted. For use with algorithms named after commands, e.g. GRASS ‘v.in.ogr’.

  • FlagSupportsInPlaceEdits: Algorithm supports in-place editing

  • FlagKnownIssues: Algorithm has known issues

  • FlagCustomException: Algorithm raises custom exception notices, don’t use the standard ones

  • FlagPruneModelBranchesBasedOnAlgorithmResults: Algorithm results will cause remaining model branches to be pruned based on the results of running the algorithm

  • FlagSkipGenericModelLogging: When running as part of a model, the generic algorithm setup and results logging should be skipped

  • FlagNotAvailableInStandaloneTool: Algorithm should not be available from the standalone “qgis_process” tool. Used to flag algorithms which make no sense outside of the QGIS application, such as “select by…” style algorithms.

  • FlagRequiresProject: The algorithm requires that a valid QgsProject is available from the processing context in order to execute

  • FlagDeprecated: Algorithm is deprecated

baseClass

alias of Qgis

class ProcessingAlgorithmFlags
class ProcessingAlgorithmFlags(f: Qgis.ProcessingAlgorithmFlags | Qgis.ProcessingAlgorithmFlag)
class ProcessingAlgorithmFlags(a0: Qgis.ProcessingAlgorithmFlags)

Bases: sip.wrapper

baseClass

alias of Qgis

class ProcessingDateTimeParameterDataType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Processing date time parameter data types.

Note

Prior to QGIS 3.36 this was available as QgsProcessingParameterDateTime.Type

Added in version 3.36.

  • DateTime: Datetime values

  • Date: Date values

  • Time: Time values

baseClass

alias of Qgis

class ProcessingFeatureSourceDefinitionFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Flags which control behavior for a Processing feature source.

Note

Prior to QGIS 3.36 this was available as QgsProcessingFeatureSourceDefinition.Flag

Added in version 3.36.

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

  • FlagCreateIndividualOutputPerInputFeature: If set, every feature processed from this source will be placed into its own individually created output destination. Support for this flag depends on how an algorithm is executed.

baseClass

alias of Qgis

class ProcessingFeatureSourceDefinitionFlags
class ProcessingFeatureSourceDefinitionFlags(f: Qgis.ProcessingFeatureSourceDefinitionFlags | Qgis.ProcessingFeatureSourceDefinitionFlag)
class ProcessingFeatureSourceDefinitionFlags(a0: Qgis.ProcessingFeatureSourceDefinitionFlags)

Bases: sip.wrapper

baseClass

alias of Qgis

class ProcessingFeatureSourceFlag(value, names=<not given>, *values, module=None, qualname=None, type=No