Class: Qgis¶
- class qgis.core.Qgis¶
Bases:
sip.wrapper
The
Qgis
class provides global constants for use throughout the application.Enums
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
alias of
DeviceConnectionStatus
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Bases:
enum.IntEnum
Methods
A string with default project scales.
The development version
GEOS string version linked
GEOS version number linked
GEOS Major version number linked
GEOS Minor version number linked
GEOS Patch version number linked
Release name
Version string.
Version number used for comparing versions using the "Check QGIS Version" function
Signals
Attributes
- 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 actionDownloadImmediately
: Action will start immediately
- 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
.ActionTypeAdded in version 3.30.
Invalid
: InvalidMapLayerAction
: Standard actions (defined by core or plugins), corresponds toQgsMapLayerAction
class.AttributeAction
: Custom actions (manually defined in layer properties), corresponds toQgsAction
class.
- 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 featureCentroid
: Clamp just centroid of feature
- Centroid = 1¶
- Vertex = 0¶
- 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¶
- 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
: DegreesAngleRadians
: Square kilometersAngleGon
: Gon/gradianAngleMinutesOfArc
: Minutes of arcAngleSecondsOfArc
: Seconds of arcAngleTurn
: Turn/revolutionsAngleMilliradiansSI
: Angular milliradians (SI definition, 1/1000 of radian)AngleMilNATO
: Angular mil (NATO definition, 6400 mil = 2PI radians)AngleUnknownUnit
: Unknown angle unit
- 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 directionCounterClockwise
: Counter-clockwise direction
- 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 successfullyInvalid
: Operation has invalid parameters for the item, no change occurredItemCleared
: The operation results in the item being cleared, and the item should be removed from the layer as a result
- Invalid = 1¶
- ItemCleared = 2¶
- Success = 0¶
- 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¶
- class AnnotationItemFlags¶
- class AnnotationItemFlags(f: Qgis.AnnotationItemFlags | Qgis.AnnotationItemFlag)
- class AnnotationItemFlags(a0: Qgis.AnnotationItemFlags)
Bases:
sip.wrapper
- 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¶
- class AnnotationItemGuiFlags¶
- class AnnotationItemGuiFlags(f: Qgis.AnnotationItemGuiFlags | Qgis.AnnotationItemGuiFlag)
- class AnnotationItemGuiFlags(a0: Qgis.AnnotationItemGuiFlags)
Bases:
sip.wrapper
- 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¶
- 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
: FeatureServerMapService
: MapServerImageService
: ImageServerGlobeServer
: GlobeServerGPServer
: GPServerGeocodeServer
: GeocodeServerUnknown
: Other unknown/unsupported type
- 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 metersAreaSquareKilometers
: Square kilometersAreaSquareFeet
: Square feetAreaSquareYards
: Square yardsAreaSquareMiles
: Square milesAreaHectares
: HectaresAreaAcres
: AcresAreaSquareNauticalMiles
: Square nautical milesAreaSquareDegrees
: Square degrees, for planar geographic CRS area measurementsAreaSquareCentimeters
: Square centimetersAreaSquareMillimeters
: Square millimetersSquareInches
: Square inches (since QGIS 3.32)AreaUnknownUnit
: Unknown areal unit
- 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
.ActionTypeAdded in version 3.30.
Generic
: GenericGenericPython
: PythonMac
: MacOS specificWindows
: Windows specificUnix
: Unix specificOpenUrl
: Open URL actionSubmitUrlEncoded
: POST data to an URL, using “application/x-www-form-urlencoded” or “application/json” if the body is valid JSON
Added in version 3.24.
SubmitUrlMultipart
: POST data to an URL using “multipart/form-data”
Added in version 3.24.
- class AttributeEditorContainerType(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 boxTab
: A tab widgetRow
: A row of editors (horizontal layout)
- GroupBox = 0¶
- Row = 2¶
- Tab = 1¶
- 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 containerAeTypeField
: A fieldAeTypeRelation
: A relationAeTypeQmlElement
: A QML elementAeTypeHtmlElement
: A HTML elementAeTypeAction
: 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
- 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 formTabLayout
: “Drag and drop” layout. Needs to be configured.UiFileLayout
: Load a .ui file for the layout. Needs to be configured.
- 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 allCodeSourceFile
: Load the Python code from an external fileCodeSourceDialog
: Use the Python code provided in the dialogCodeSourceEnvironment
: Use the Python code available in the Python environment
- 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.
- 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 disabledReloadData
: Reload data (and draw the new data)RedrawOnly
: Redraw current data only
- Disabled = 0¶
- RedrawOnly = 2¶
- ReloadData = 1¶
- 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
.AvoidIntersectionsModeAdded in version 3.26.
AllowIntersections
: Overlap with any feature allowed when digitizing new featuresAvoidIntersectionsCurrentLayer
: Overlap with features from the active layer when digitizing new features not allowedAvoidIntersectionsLayers
: Overlap with features from a specified list of layers when digitizing new features not allowed
- 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-axisY
: Y-axisZ
: Z-axis
- X = 0¶
- Y = 1¶
- Z = 2¶
- 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¶
- class BabelCommandFlags¶
- class BabelCommandFlags(f: Qgis.BabelCommandFlags | Qgis.BabelCommandFlag)
- class BabelCommandFlags(a0: Qgis.BabelCommandFlags)
Bases:
sip.wrapper
- class BabelFormatCapabilities¶
- class BabelFormatCapabilities(f: Qgis.BabelFormatCapabilities | Qgis.BabelFormatCapability)
- class BabelFormatCapabilities(a0: Qgis.BabelFormatCapabilities)
Bases:
sip.wrapper
- 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 importingExport
: Format supports exportingWaypoints
: Format supports waypointsRoutes
: Format supports routesTracks
: Format supports tracks
- Export = 2¶
- Import = 1¶
- Routes = 8¶
- Tracks = 16¶
- Waypoints = 4¶
- 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 constraintPerpendicular
: PerpendicularParallel
: Parallel
- 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
: NormalBlendLighten
: LightenBlendScreen
: ScreenBlendDodge
: DodgeBlendAddition
: AdditionBlendDarken
: DarkenBlendMultiply
: MultipleBlendBurn
: BurnBlendOverlay
: OverlayBlendSoftLight
: Soft lightBlendHardLight
: Hard lightBlendDifference
: DifferenceBlendSubtract
: SubtractBlendSource
: SourceBlendDestinationOver
: Destination overBlendClear
: ClearBlendDestination
: DestinationBlendSourceIn
: Source inBlendDestinationIn
: Destination inBlendSourceOut
: Source outBlendDestinationOut
: Destination outBlendSourceAtop
: Source atopBlendDestinationAtop
: Destination atopBlendXor
: XOR
- 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 monitoredNeverMonitor
: Never monitor the directory, regardless of the default logicAlwaysMonitor
: Always monitor the directory, regardless of the default logic
- AlwaysMonitor = 2¶
- Default = 0¶
- NeverMonitor = 1¶
- class BrowserItemCapabilities¶
- class BrowserItemCapabilities(f: Qgis.BrowserItemCapabilities | Qgis.BrowserItemCapability)
- class BrowserItemCapabilities(a0: Qgis.BrowserItemCapabilities)
Bases:
sip.wrapper
- 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 capabilitiesSetCrs
: Can set CRS on layer or group of layers. deprecated since QGIS 3.6 – no longer used by QGIS and will be removed in QGIS 4.0Fertile
: Can create children. Even items without this capability may have children, but cannot create them, it means that children are created by item ancestors.Fast
: CreateChildren() is fast enough to be run in main thread when refreshing items, most root items (wms,wfs,wcs,postgres…) are considered fast because they are reading data only from QgsSettingsCollapse
: The collapse/expand status for this items children should be ignored in order to avoid undesired network connections (wms etc.)Rename
: Item can be renamedDelete
: Item can be deletedItemRepresentsFile
: Item’s path() directly represents a file on disk (since QGIS 3.22)RefreshChildrenWhenItemIsRefreshed
: When the item is refreshed, all its populated children will also be refreshed in turn (since QGIS 3.26)
- 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 createdPopulating
: Creating children in separate thread (populating or refreshing)Populated
: Children created
- 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 itemsDirectory
: Represents a file directoryLayer
: Represents a map layerError
: Contains an error messageFavorites
: Represents a favorite itemProject
: Represents a QGIS projectCustom
: Custom item typeFields
: Collection of fieldsField
: Vector layer field
- 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 typeVector
: Generic vector layerRaster
: Raster layerPoint
: Vector point layerLine
: Vector line layerPolygon
: Vector polygon layerTableLayer
: Vector non-spatial layerDatabase
: Database layerTable
: Database tablePlugin
: Plugin based layerMesh
: Mesh layerVectorTile
: Vector tile layerPointCloud
: Point cloud layerTiledScene
: Tiled scene layer (since QGIS 3.34)
- 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 lineSideRight
: Buffer to right of line
- 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 valueAngle
: Angle valueDistance
: Distance valueXCoordinate
: X Coordinate valueYCoordinate
: Y Coordinate valueZValue
: Z valueMValue
: M value
- Angle = 1¶
- Distance = 2¶
- Generic = 0¶
- MValue = 6¶
- XCoordinate = 3¶
- YCoordinate = 4¶
- ZValue = 5¶
- 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
.CapitalizationAdded in version 3.24.
MixedCase
: Mixed case, ie no changeAllUppercase
: Convert all characters to uppercaseAllLowercase
: Convert all characters to lowercaseForceFirstLetterToCapital
: Convert just the first letter of each word to uppercase, leave the rest untouchedSmallCaps
: 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)
- 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 segmentsCircularString
: Capture in circular stringsStreaming
: Streaming points digitizing mode (points are automatically added as the mouse cursor moves).Shape
: Digitize shapes.
- 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 yetRunning
: Content fetching/storing is in progressFinished
: Content fetching/storing is finished and successfulFailed
: Content fetching/storing has failedCanceled
: Content fetching/storing has been canceled
- Canceled = 4¶
- Failed = 3¶
- Finished = 2¶
- NotStarted = 0¶
- Running = 1¶
- 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 CRSMapGeographic
: Map Geographic CRS equivalent (stays unchanged if the map CRS is geographic)CustomCrs
: Custom CRS
- CustomCrs = 2¶
- MapCrs = 0¶
- MapGeographic = 1¶
- 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 parametersXY
: Easting/Northing (or Longitude/Latitude for geographic CRS)YX
: Northing/Easting (or Latitude/Longitude for geographic CRS)
- Default = 0¶
- XY = 1¶
- YX = 2¶
- class CoordinateTransformationFlag(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¶
- class CoordinateTransformationFlags¶
- class CoordinateTransformationFlags(f: Qgis.CoordinateTransformationFlags | Qgis.CoordinateTransformationFlag)
- class CoordinateTransformationFlags(a0: Qgis.CoordinateTransformationFlags)
Bases:
sip.wrapper
- 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
: NorthNorthNorthEast
: North North EastNorthEast
: North EastEastNorthEast
: East North EastEast
: EastEastSouthEast
: East South EastSouthEast
: South EastSouthSouthEast
: South South EastSouth
: SouthSouthSouthWest
: South South WestSouthWest
: South WestWestSouthWest
: West South WestWest
: WestWestNorthWest
: West North WestNorthWest
: North WestNorthNorthWest
: North North WestGeocentricX
: Geocentric (X)GeocentricY
: Geocentric (Y)GeocentricZ
: Geocentric (Z)Up
: UpDown
: DownForward
: ForwardAft
: AftPort
: PortStarboard
: StarboardClockwise
: ClockwiseCounterClockwise
: Counter clockwiseColumnPositive
: Column positiveColumnNegative
: Column negativeRowPositive
: Row positiveRowNegative
: Row negativeDisplayRight
: Display rightDisplayLeft
: Display leftDisplayUp
: Display upDisplayDown
: Display downFuture
: FuturePast
: PastTowards
: TowardsAwayFrom
: Away fromUnspecified
: Unspecified
- Aft = 22¶
- AwayFrom = 38¶
- Clockwise = 25¶
- ColumnNegative = 28¶
- ColumnPositive = 27¶
- CounterClockwise = 26¶
- DisplayDown = 34¶
- DisplayLeft = 32¶
- DisplayRight = 31¶
- DisplayUp = 33¶
- Down = 20¶
- East = 4¶
- EastNorthEast = 3¶
- EastSouthEast = 5¶
- Forward = 21¶
- Future = 35¶
- GeocentricX = 16¶
- GeocentricY = 17¶
- GeocentricZ = 18¶
- North = 0¶
- NorthEast = 2¶
- NorthNorthEast = 1¶
- NorthNorthWest = 15¶
- NorthWest = 14¶
- Past = 36¶
- Port = 23¶
- RowNegative = 30¶
- RowPositive = 29¶
- South = 8¶
- SouthEast = 6¶
- SouthSouthEast = 7¶
- SouthSouthWest = 9¶
- SouthWest = 10¶
- Starboard = 24¶
- Towards = 37¶
- Unspecified = 39¶
- Up = 19¶
- West = 12¶
- WestNorthWest = 13¶
- WestSouthWest = 11¶
- class CrsDefinitionFormat(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
- 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 typeGeodetic
: Geodetic CRSGeocentric
: Geocentric CRSGeographic2d
: 2D geographic CRSGeographic3d
: 3D geopraphic CRSVertical
: Vertical CRSProjected
: Projected CRSCompound
: Compound (horizontal + vertical) CRSTemporal
: Temporal CRSEngineering
: Engineering CRSBound
: Bound CRSOther
: Other typeDerivedProjected
: 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¶
- 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 ruleFullDash
: Start or finish the pattern with a full dashHalfDash
: Start or finish the pattern with a half length dashFullGap
: Start or finish the pattern with a full gapHalfGap
: Start or finish the pattern with a half length gap
- FullDash = 1¶
- FullGap = 3¶
- HalfDash = 2¶
- HalfGap = 4¶
- NoRule = 0¶
- 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 equallyScaleDashOnly
: Only dash lengths are adjustedScaleGapOnly
: Only gap lengths are adjusted
- ScaleBothDashAndGap = 0¶
- ScaleDashOnly = 1¶
- ScaleGapOnly = 2¶
- 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¶
- class DataProviderFlags¶
- class DataProviderFlags(f: Qgis.DataProviderFlags | Qgis.DataProviderFlag)
- class DataProviderFlags(a0: Qgis.DataProviderFlags)
Bases:
sip.wrapper
- 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 typeByte
: 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 Int16CInt32
: Complex Int32CFloat32
: Complex Float32CFloat64
: Complex Float64ARGB32
: Color, alpha, red, green, blue, 4 bytes the same as QImage.Format_ARGB32ARGB32_Premultiplied
: Color, alpha, red, green, blue, 4 bytes the same as QImage.Format_ARGB32_Premultiplied
- class DatabaseProviderConnectionCapabilities2¶
- class DatabaseProviderConnectionCapabilities2(f: Qgis.DatabaseProviderConnectionCapabilities2 | Qgis.DatabaseProviderConnectionCapability2)
- class DatabaseProviderConnectionCapabilities2(a0: Qgis.DatabaseProviderConnectionCapabilities2)
Bases:
sip.wrapper
- 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¶
- 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 disconnectedConnecting
: Device is connectingConnected
: Device is successfully connected
- 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
: MetersDistanceKilometers
: KilometersDistanceFeet
: Imperial feetDistanceNauticalMiles
: Nautical milesDistanceYards
: Imperial yardsDistanceMiles
: Terrestrial milesDistanceDegrees
: Degrees, for planar geographic CRS distance measurementsDistanceCentimeters
: CentimetersDistanceMillimeters
: MillimetersInches
: Inches (since QGIS 3.32)DistanceUnknownUnit
: Unknown distance unit
- 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 unitGeographic
: Unit is a geographic (e.g., degree based) unitUnknownType
: Unknown unit type
- 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
: AllOff
: OffQGIS
: QGISUMN
: UMNGeoServer
: GeoServer
- All = 7¶
- GeoServer = 4¶
- Off = 0¶
- QGIS = 1¶
- UMN = 2¶
- 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 typeInvalid
: Invalid pathRemovable
: Removable driveFixed
: Fixed driveRemote
: Remote driveCdRom
: CD-ROMRamDisk
: RAM diskCloud
: Cloud storage – files may be remote or locally stored, depending on user configuration
- CdRom = 5¶
- Cloud = 7¶
- Fixed = 3¶
- Invalid = 1¶
- RamDisk = 6¶
- Remote = 4¶
- Removable = 2¶
- Unknown = 0¶
- class ElevationMapCombineMethod(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 nullNewerElevation
: Keep the new elevation regardless of its value if it is not null
- HighestElevation = 0¶
- NewerElevation = 1¶
- 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 capCapFlat
: Flat cap (in line with start/end of line)CapSquare
: Square cap (extends past start/end of line by buffer distance)
- 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 expressionPointCloud
: Point cloud expressionRasterCalculator
: Raster calculator expression (since QGIS 3.34)
- PointCloud = 1¶
- Qgis = 0¶
- RasterCalculator = 2¶
- 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 computedUnknownCount
: Provider returned an unknown feature count
- 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 dataFeatureSymbology
: Keeps the number of features and export symbology per featureSymbolLayerSymbology
: Exports one feature per symbol layer (considering symbol levels)
- 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 definedNotSearchable
: 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 serverHideFromWfs
: Field is not available if layer is served as WFS from QGIS server
- HideFromWfs = 8¶
- HideFromWms = 4¶
- NoFlag = 0¶
- NotSearchable = 2¶
- class FieldConfigurationFlags¶
- class FieldConfigurationFlags(f: Qgis.FieldConfigurationFlags | Qgis.FieldConfigurationFlag)
- class FieldConfigurationFlags(a0: Qgis.FieldConfigurationFlags)
Bases:
sip.wrapper
- 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 valueSum
: Sum of valuesGeometryWeighted
: New values are computed as the weighted average of the source values
- DefaultValue = 0¶
- GeometryWeighted = 2¶
- Sum = 1¶
- 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 valueDuplicate
: Duplicate original valueGeometryRatio
: New values are computed by the ratio of their area/length compared to the area/length of the original featureUnsetField
: 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¶
- 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 domainRange
: Numeric range field domain (min/max)Glob
: Glob string pattern field domain
- Coded = 0¶
- Glob = 2¶
- Range = 1¶
- 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 aQgsCoordinateReferenceSystem
value)GeometryWkbType
: Available for geometry field types which accept geometries of a specific WKB type only (as a QgsWkbTypes.Type value)CustomProperty
: Starting point for custom user set properties
- CustomProperty = 1048576¶
- GeometryCrs = 4096¶
- GeometryWkbType = 4097¶
- class 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
.FilterTypeAdded in version 3.32.
FilterVector
: Vector layersFilterRaster
: Raster layersFilterMesh
: Mesh layersFilterMeshDataset
: Mesh datasetsFilterPointCloud
: Point clouds (since QGIS 3.18)VectorTile
: Vector tile layers (since QGIS 3.32)TiledScene
: Tiled scene layers (since QGIS 3.34)
- 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 operationIncludeStyleFile
: Indicates that any associated .qml styling file should be included with the operation
- IncludeMetadataFile = 1¶
- IncludeStyleFile = 2¶
- class FileOperationFlags¶
- class FileOperationFlags(f: Qgis.FileOperationFlags | Qgis.FileOperationFlag)
- class FileOperationFlags(a0: Qgis.FileOperationFlags)
Bases:
sip.wrapper
- 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 pathRelative
: Relative path
- Absolute = 0¶
- Relative = 1¶
- 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)
- RA_Average = 5¶
- RA_Bilinear = 1¶
- RA_Cubic = 2¶
- RA_CubicSpline = 3¶
- RA_Lanczos = 4¶
- RA_Max = 8¶
- RA_Median = 10¶
- RA_Min = 9¶
- RA_Mode = 6¶
- RA_NearestNeighbour = 0¶
- RA_Q1 = 11¶
- RA_Q3 = 12¶
- 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 succeededNothingHappened
: Nothing happened, without any errorInvalidBaseGeometry
: The base geometry on which the operation is done is invalid or emptyInvalidInputGeometryType
: The input geometry (ring, part, split line, etc.) has not the correct geometry typeSelectionIsEmpty
: No features were selectedSelectionIsGreaterThanOne
: More than one features were selectedGeometryEngineError
: Geometry engine misses a method implemented or an error occurred in the geometry engineLayerNotEditable
: Cannot edit layerAddPartSelectedGeometryNotFound
: The selected geometry cannot be foundAddPartNotMultiGeometry
: The source geometry is not multiAddRingNotClosed
: The input ring is not closedAddRingNotValid
: The input ring is not validAddRingCrossesExistingRings
: The input ring crosses existing rings (it is not disjoint)AddRingNotInExistingFeature
: The input ring doesn’t have any existing ring to fit intoSplitCannotSplitPoint
: Cannot split pointsGeometryTypeHasChanged
: Operation has changed geometry type
- 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
: PointsLineGeometry
: LinesPolygonGeometry
: PolygonsUnknownGeometry
: Unknown typesNullGeometry
: No geometry
- 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 internalQgsGeometryValidator
methodValidatorGeos
: Use GEOS validation methods
- 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.
- class GeometryValidityFlags¶
- class GeometryValidityFlags(f: Qgis.GeometryValidityFlags | Qgis.GeometryValidityFlag)
- class GeometryValidityFlags(a0: Qgis.GeometryValidityFlags)
Bases:
sip.wrapper
- 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 systemGps
: Global Positioning System (GPS)Glonass
: Global Navigation Satellite System (GLONASS)Galileo
: GalileoBeiDou
: BeiDouQzss
: Quasi Zenith Satellite System (QZSS)Navic
: Indian Regional Navigation Satellite System (IRNSS) / NAVICSbas
: SBAS
- BeiDou = 4¶
- Galileo = 3¶
- Glonass = 2¶
- Gps = 1¶
- Qzss = 5¶
- Sbas = 7¶
- Unknown = 0¶
- 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 connectionInternal
: Internal GPS deviceSerial
: Serial port GPS deviceGpsd
: GPSD device
- Automatic = 0¶
- Gpsd = 3¶
- Internal = 1¶
- Serial = 2¶
- 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
: WaypointRoute
: RouteTrack
: Track
- Route = 1¶
- Track = 2¶
- Waypoint = 0¶
- 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
.FixStatusAdded in version 3.30.
NoData
: No fix data availableNoFix
: GPS is not fixedFix2D
: 2D fixFix3D
: 3D fix
- 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 aQgsPointXY
valueAltitude
: Altitude/elevation above or below the mean sea levelGroundSpeed
: Ground speedBearing
: Bearing measured in degrees clockwise from true north to the direction of travelTotalTrackLength
: Total distance of current GPS track (available fromQgsGpsLogger
class only)TrackDistanceFromStart
: Direct distance from first vertex in current GPS track to last vertex (available fromQgsGpsLogger
class only)Pdop
: Dilution of precisionHdop
: Horizontal dilution of precisionVdop
: Vertical dilution of precisionHorizontalAccuracy
: Horizontal accuracy in metersVerticalAccuracy
: Vertical accuracy in metersHvAccuracy
: 3D RMSSatellitesUsed
: Count of satellites used in obtaining the fixTimestamp
: TimestampTrackStartTime
: Timestamp at start of current track (available fromQgsGpsLogger
class only)TrackEndTime
: Timestamp at end (current point) of current track (available fromQgsGpsLogger
class only)TrackDistanceSinceLastPoint
: Distance since last recorded location (available fromQgsGpsLogger
class only)TrackTimeSinceLastPoint
: Time since last recorded location (available fromQgsGpsLogger
class only)GeoidalSeparation
: Geoidal separation, the difference between the WGS-84 Earth ellipsoid and mean-sea-level (geoid), “-” means mean-sea-level below ellipsoidEllipsoidAltitude
: Altitude/elevation above or below the WGS-84 Earth ellipsoid
- Altitude = 2¶
- Bearing = 8¶
- EllipsoidAltitude = 524288¶
- GeoidalSeparation = 262144¶
- GroundSpeed = 4¶
- Hdop = 128¶
- HorizontalAccuracy = 512¶
- HvAccuracy = 2048¶
- Location = 1¶
- Pdop = 64¶
- SatellitesUsed = 4096¶
- Timestamp = 8192¶
- TotalTrackLength = 16¶
- TrackDistanceFromStart = 32¶
- TrackDistanceSinceLastPoint = 65536¶
- TrackEndTime = 32768¶
- TrackStartTime = 16384¶
- TrackTimeSinceLastPoint = 131072¶
- Vdop = 256¶
- VerticalAccuracy = 1024¶
- class GpsInformationComponents¶
- class GpsInformationComponents(f: Qgis.GpsInformationComponents | Qgis.GpsInformationComponent)
- class GpsInformationComponents(a0: Qgis.GpsInformationComponents)
Bases:
sip.wrapper
- 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
: UnknownInvalid
: InvalidGPS
: StandaloneDGPS
: Differential GPSPPS
: PPSRTK
: Real-time-kynematicFloatRTK
: Float real-time-kynematicEstimated
: EstimatedManual
: Manual input modeSimulation
: Simulation mode
- DGPS = 2¶
- Estimated = 6¶
- FloatRTK = 5¶
- GPS = 1¶
- Invalid = 0¶
- Manual = 7¶
- PPS = 3¶
- RTK = 4¶
- Simulation = 8¶
- Unknown = -1¶
- 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
.GradientColorTypeAdded in version 3.24.
SimpleTwoColor
: Simple two color gradientColorRamp
: Gradient color ramp
- 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
.GradientSpreadAdded in version 3.24.
Pad
: Pad out gradient using colors at endpoint of gradientReflect
: Reflect gradientRepeat
: Repeat gradient
- 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
.GradientTypeAdded in version 3.24.
Linear
: Linear gradientRadial
: Radial (circular) gradientConical
: Conical (polar) gradient
- 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
.GraduatedMethodAdded in version 3.26.
GraduatedColor
: Alter color of symbolsGraduatedSize
: Alter size of symbols
- 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¶
- class HistoryProviderBackends¶
- class HistoryProviderBackends(f: Qgis.HistoryProviderBackends | Qgis.HistoryProviderBackend)
- class HistoryProviderBackends(a0: Qgis.HistoryProviderBackends)
Bases:
sip.wrapper
- 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 methodPost
: POST method
- Get = 0¶
- Post = 1¶
- 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 controllerMap3D
: 3D map controller
- Map2D = 0¶
- Map3D = 1¶
- 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 joinsJoinStyleMiter
: Use mitered joinsJoinStyleBevel
: Use beveled joins
- 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
.LinePlacementFlagAdded in version 3.32.
OnLine
: Labels can be placed directly over a line feature.AboveLine
: Labels can be placed above a line feature. Unless MapOrientation is also specified this mode respects the direction of the line feature, so a line from right to left labels will have labels placed placed below the line feature.BelowLine
: Labels can be placed below a line feature. Unless MapOrientation is also specified this mode respects the direction of the line feature, so a line from right to left labels will have labels placed placed above the line feature.MapOrientation
: Signifies that the AboveLine and BelowLine flags should respect the map’s orientation rather than the feature’s orientation. For example, AboveLine will always result in label’s being placed above a line, regardless of the line’s direction.
- class LabelLinePlacementFlags¶
- class LabelLinePlacementFlags(f: Qgis.LabelLinePlacementFlags | Qgis.LabelLinePlacementFlag)
- class LabelLinePlacementFlags(a0: Qgis.LabelLinePlacementFlags)
Bases:
sip.wrapper
- 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
.MultiLineAlignAdded in version 3.26.
MultiLeft
: Left alignMultiCenter
: Center alignMultiRight
: Right alignMultiFollowPlacement
: Alignment follows placement of label, e.g., labels to the left of a feature will be drawn with right alignmentMultiJustify
: Justified
- 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
.OffsetTypeAdded in version 3.26.
FromPoint
: Offset distance applies from point geometryFromSymbolBounds
: Offset distance applies from rendered symbol bounds
- 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 labelsAllowOverlapIfRequired
: Avoids overlapping labels when possible, but permit overlaps if labels for features cannot otherwise be placedAllowOverlapAtNoCost
: Labels may freely overlap other labels, at no cost
- AllowOverlapAtNoCost = 2¶
- AllowOverlapIfRequired = 1¶
- PreventOverlap = 0¶
- 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
.PlacementAdded 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
- 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
.PlacementEngineVersionAdded in version 3.30.
PlacementEngineVersion1
: Version 1, matches placement from QGIS <= 3.10.1PlacementEngineVersion2
: Version 2 (default for new projects since QGIS 3.12)
- 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
.PolygonPlacementFlagAdded in version 3.32.
AllowPlacementOutsideOfPolygon
: Labels can be placed outside of a polygon featureAllowPlacementInsideOfPolygon
: Labels can be placed inside a polygon feature
- class LabelPolygonPlacementFlags¶
- class LabelPolygonPlacementFlags(f: Qgis.LabelPolygonPlacementFlags | Qgis.LabelPolygonPlacementFlag)
- class LabelPolygonPlacementFlags(a0: Qgis.LabelPolygonPlacementFlags)
Bases:
sip.wrapper
- 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
.PredefinedPointPositionAdded in version 3.26.
TopLeft
: Label on top-left of pointTopSlightlyLeft
: Label on top of point, slightly left of centerTopMiddle
: Label directly above pointTopSlightlyRight
: Label on top of point, slightly right of centerTopRight
: Label on top-right of pointMiddleLeft
: Label on left of pointMiddleRight
: Label on right of pointBottomLeft
: Label on bottom-left of pointBottomSlightlyLeft
: Label below point, slightly left of centerBottomMiddle
: Label directly below pointBottomSlightlyRight
: Label below point, slightly right of centerBottomRight
: Label on bottom right of point
- 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
.QuadrantPositionAdded in version 3.26.
QuadrantAboveLeft
: Above leftQuadrantAbove
: Above centerQuadrantAboveRight
: Above rightQuadrantLeft
: Left middleQuadrantOver
: Center middleQuadrantRight
: Right middleQuadrantBelowLeft
: Below leftQuadrantBelow
: Below centerQuadrantBelowRight
: BelowRight
- 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
.FlagAdded in version 3.30.
UseAllLabels
: Whether to draw all labels even if there would be collisionsUsePartialCandidates
: Whether to use also label candidates that are partially outside of the map viewRenderOutlineLabels
: 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 usersCollectUnplacedLabels
: Whether unplaced labels should be collected in the labeling results (regardless of whether they are being rendered). Since QGIS 3.20DrawLabelMetrics
: Whether to render label metric guides (for debugging). Since QGIS 3.30
- class LabelingFlags¶
- class LabelingFlags(f: Qgis.LabelingFlags | Qgis.LabelingFlag)
- class LabelingFlags(a0: Qgis.LabelingFlags)
Bases:
sip.wrapper
- 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.
VectorTileLayer
:QgsVectorTileLayer
Added in version 3.14.
PointCloudLayer
:QgsPointCloudLayer
Added in version 3.18.
AnnotationLayer
:QgsAnnotationLayer
Added in version 3.22.
TiledSceneLayer
:QgsTiledSceneLayer
Added in version 3.34.
All
:SpatialLayer
:
Added in version 3.24.
- class LayerFilters¶
- class LayerFilters(f: Qgis.LayerFilters | Qgis.LayerFilter)
- class LayerFilters(a0: Qgis.LayerFilters)
Bases:
sip.wrapper
- 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¶
- class LayerTreeFilterFlags¶
- class LayerTreeFilterFlags(f: Qgis.LayerTreeFilterFlags | Qgis.LayerTreeFilterFlag)
- class LayerTreeFilterFlags(a0: Qgis.LayerTreeFilterFlags)
Bases:
sip.wrapper
- 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 pointTopOfTree
: Layers are added at the top of the layer treeOptimalInInsertionGroup
: Layers are added at optimal locations across the insertion point’s group
- AboveInsertionPoint = 0¶
- OptimalInInsertionGroup = 2¶
- TopOfTree = 1¶
- 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 layerRasterLayer
: Raster layerPluginLayer
: Plugin based layerMeshLayer
: Mesh layer. Added in QGIS 3.2VectorTileLayer
: Vector tile layer. Added in QGIS 3.14AnnotationLayer
: Contains freeform, georeferenced annotations. Added in QGIS 3.16PointCloudLayer
: Point cloud layer. Added in QGIS 3.18GroupLayer
: Composite group layer. Added in QGIS 3.24TiledScene
: Tiled scene layer. Added in QGIS 3.34
- 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
: MillimetersLayoutCentimeters
: CentimetersLayoutMeters
: MetersLayoutInches
: InchesLayoutFeet
: FeetLayoutPoints
: Typographic pointsLayoutPicas
: Typographic picasLayoutPixels
: Pixels
- 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 unitLayoutScreenUnits
: Unit is a screen based measurement unit
- 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 sourceDirectional
: Directional light source
- Directional = 1¶
- Point = 0¶
- 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¶
- 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 vertexAfterVertex
: Lock to next vertexNoVertex
: Don’t lock to vertex
- AfterVertex = 1¶
- BeforeVertex = 0¶
- NoVertex = 2¶
- 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¶
- 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 sourceRaster
: Raster sourceRasterDem
: Raster DEM sourceGeoJson
: GeoJSON sourceImage
: Image sourceVideo
: Video sourceUnknown
: Other/unknown source type
- GeoJson = 3¶
- Image = 4¶
- Raster = 1¶
- RasterDem = 2¶
- Unknown = 6¶
- Vector = 0¶
- Video = 5¶
- 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
.FlagAdded in version 3.30.
EnabledOnlyWhenEditable
: Action should be shown only for editable layers
- class MapLayerActionFlags¶
- class MapLayerActionFlags(f: Qgis.MapLayerActionFlags | Qgis.MapLayerActionFlag)
- class MapLayerActionFlags(a0: Qgis.MapLayerActionFlags)
Bases:
sip.wrapper
- 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
.TargetAdded in version 3.30.
Layer
: Action targets a complete layerSingleFeature
: Action targets a single feature from a layerMultipleFeatures
: Action targets multiple features from a layerAllActions
:
- class MapLayerActionTargets¶
- class MapLayerActionTargets(f: Qgis.MapLayerActionTargets | Qgis.MapLayerActionTarget)
- class MapLayerActionTargets(a0: Qgis.MapLayerActionTargets)
Bases:
sip.wrapper
- class MapLayerProperties¶
- class MapLayerProperties(f: Qgis.MapLayerProperties | Qgis.MapLayerProperty)
- class MapLayerProperties(a0: Qgis.MapLayerProperties)
Bases:
sip.wrapper
- 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¶
- 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¶
- class MapLayerRendererFlags¶
- class MapLayerRendererFlags(f: Qgis.MapLayerRendererFlags | Qgis.MapLayerRendererFlag)
- class MapLayerRendererFlags(a0: Qgis.MapLayerRendererFlags)
Bases:
sip.wrapper
- 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 mapWhenOutsideVisibleExtent
: Only recenter map when new center would be outside of current visible extentNever
: Never recenter map
- Always = 0¶
- Never = 2¶
- WhenOutsideVisibleExtent = 1¶
- 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 renderingDrawEditingInfo
: Enable drawing of vertex markers for layers in editing modeForceVectorOutput
: Vector graphics should not be cached and drawn as raster imagesUseAdvancedEffects
: Enable layer opacity and blending effectsDrawLabeling
: Enable drawing of labels on top of the mapUseRenderingOptimization
: Enable vector simplification and other rendering optimizationsDrawSelection
: Whether vector selections should be shown in the rendered mapDrawSymbolBounds
: Draw bounds of symbols (for debugging/testing)RenderMapTile
: Draw map such that there are no problems between adjacent tilesRenderPartialOutput
: Whether to make extra effort to update map image with partially rendered layers (better for interactive map canvas). Added in QGIS 3.0RenderPreviewJob
: Render is a ‘canvas preview’ render, and shortcuts should be taken to ensure fast renderingRenderBlocking
: Render and load remote sources in the same thread to ensure rendering remote sources (svg and images). WARNING: this flag must NEVER be used from GUI based applications (like the main QGIS application) or crashes will result. Only for use in external scripts or QGIS server.LosslessImageRendering
: Render images losslessly whenever possible, instead of the default lossy jpeg rendering used for some destination devices (e.g. PDF). This flag only works with builds based on Qt 5.13 or later.Render3DMap
: Render is for a 3D mapHighQualityImageTransforms
: 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)
- class MapSettingsFlags¶
- class MapSettingsFlags(f: Qgis.MapSettingsFlags | Qgis.MapSettingsFlag)
- class MapSettingsFlags(a0: Qgis.MapSettingsFlags)
Bases:
sip.wrapper
- 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 valuePixels
: Pixels unit of toleranceProjectUnits
: Map (project) units
- 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 markersShape
: Clip to polygon shapeCentroidWithin
: Render complete markers wherever their centroid falls within the polygon shapeCompletelyWithin
: Render complete markers wherever the completely fall within the polygon shape
- CentroidWithin = 2¶
- CompletelyWithin = 3¶
- NoClipping = 0¶
- Shape = 1¶
- 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
.PlacementAdded in version 3.24.
Interval
: Place symbols at regular intervalsVertex
: Place symbols on every vertex in the lineLastVertex
: Place symbols on the last vertex in the lineFirstVertex
: Place symbols on the first vertex in the lineCentralPoint
: Place symbols at the mid point of the lineCurvePoint
: 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 segmentInnerVertices
: Inner vertices (i.e. all vertices except the first and last vertex) (since QGIS 3.24)
- class MarkerLinePlacements¶
- class MarkerLinePlacements(f: Qgis.MarkerLinePlacements | Qgis.MarkerLinePlacement)
- class MarkerLinePlacements(a0: Qgis.MarkerLinePlacements)
Bases:
sip.wrapper
- 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
.ShapeAdded in version 3.24.
Square
: SquareDiamond
: DiamondPentagon
: PentagonHexagon
: HexagonTriangle
: TriangleEquilateralTriangle
: Equilateral triangleStar
: StarArrow
: ArrowCircle
: CircleCross
: Cross (lines only)CrossFill
: Solid filled crossCross2
: Rotated cross (lines only), ‘x’ shapeLine
: Vertical lineArrowHead
: Right facing arrow head (unfilled, lines only)ArrowHeadFilled
: Right facing filled arrow headSemiCircle
: 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 triangleLeftHalfTriangle
: Left half of triangleOctagon
: 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)
- 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 typeInvalidFace
: An error occurs due to an invalid face (for example, vertex indexes are unordered)TooManyVerticesInFace
: A face has more vertices than the maximum number supported per faceFlatFace
: A flat face is presentUniqueSharedVertex
: A least two faces share only one verticesInvalidVertex
: An error occurs due to an invalid vertex (for example, vertex index is out of range the available vertex)ManifoldFace
: ManifoldFace
- FlatFace = 3¶
- InvalidFace = 1¶
- InvalidVertex = 5¶
- ManifoldFace = 6¶
- NoError = 0¶
- TooManyVerticesInFace = 2¶
- 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 createdPublished
: Date publishedRevised
: Date revisedSuperseded
: Date superseded
- Created = 0¶
- Published = 1¶
- Revised = 2¶
- Superseded = 3¶
Bases:
enum.IntEnum
The navigation mode used by 3D cameras.
Added in version 3.30.
TerrainBased
: The default navigation based on the terrainWalk
: Uses WASD keys or arrows to navigate in walking (first person) manner
alias of
Qgis
- NoLevel = 4¶
- 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 suffixesEveryLabel
: Place suffix after every value labelFirstLabel
: Place suffix after the first label value onlyLastLabel
: Place suffix after the last label value onlyFirstAndLastLabels
: Place suffix after the first and last label values only
- EveryLabel = 1¶
- FirstAndLastLabels = 4¶
- FirstLabel = 2¶
- LastLabel = 3¶
- NoLabels = 0¶
- 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¶
- class PlotToolFlags¶
- class PlotToolFlags(f: Qgis.PlotToolFlags | Qgis.PlotToolFlag)
- class PlotToolFlags(a0: Qgis.PlotToolFlags)
Bases:
sip.wrapper
- 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 storedBottomToTop
: Draw points with larger Z values lastTopToBottom
: Draw points with larger Z values first
- 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 squaresCircle
: Renders points as circles
- 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
.CountMethodAdded in version 3.24.
AbsoluteCount
: The point count is used as an absolute count of markersDensityBasedCount
: The point count is part of a marker density count
- 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 setUnknown
: UnknownOrdinaryTable
: Ordinary tableIndex
: IndexSequence
: SequenceView
: ViewMaterializedView
: Materialized viewCompositeType
: Composition typeToastTable
: TOAST tableForeignTable
: Foreign tablePartitionedTable
: Partitioned table
- CompositeType = 7¶
- ForeignTable = 9¶
- Index = 3¶
- MaterializedView = 6¶
- NotSet = 0¶
- OrdinaryTable = 2¶
- PartitionedTable = 10¶
- Sequence = 4¶
- ToastTable = 8¶
- Unknown = 1¶
- View = 5¶
- class ProcessingModelChildParameterSource(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Processing model child parameter sources.
Added in version 3.34.
ModelParameter
: Parameter value is taken from a parent model parameterChildOutput
: Parameter value is taken from an output generated by a child algorithmStaticValue
: Parameter value is a static valueExpression
: Parameter value is taken from an expression, evaluated just before the algorithm runsExpressionText
: Parameter value is taken from a text with expressions, evaluated just before the algorithm runsModelOutput
: Parameter value is linked to an output parameter for the model
- ChildOutput = 1¶
- Expression = 3¶
- ExpressionText = 4¶
- ModelOutput = 5¶
- ModelParameter = 0¶
- StaticValue = 2¶
- class ProfileExportType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Types of export for elevation profiles.
Added in version 3.32.
Features3D
: Export profiles as 3D features, with elevation values stored in exported geometry Z valuesProfile2D
: Export profiles as 2D profile lines, with elevation stored in exported geometry Y dimension and distance in X dimensionDistanceVsElevationTable
: Export profiles as a table of sampled distance vs elevation values
- DistanceVsElevationTable = 2¶
- Features3D = 0¶
- Profile2D = 1¶
- class ProfileGeneratorFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Flags that control the way the
QgsAbstractProfileGenerator
operate.Added in version 3.26.
RespectsMaximumErrorMapUnit
: Generated profile respects the QgsProfileGenerationContext.maximumErrorMapUnits() property.RespectsDistanceRange
: Generated profile respects the QgsProfileGenerationContext.distanceRange() property.RespectsElevationRange
: Generated profile respects the QgsProfileGenerationContext.elevationRange() property.
- RespectsDistanceRange = 2¶
- RespectsElevationRange = 4¶
- RespectsMaximumErrorMapUnit = 1¶
- class ProfileGeneratorFlags¶
- class ProfileGeneratorFlags(f: Qgis.ProfileGeneratorFlags | Qgis.ProfileGeneratorFlag)
- class ProfileGeneratorFlags(a0: Qgis.ProfileGeneratorFlags)
Bases:
sip.wrapper
- class ProfileSurfaceSymbology(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Surface symbology type for elevation profile plots.
Added in version 3.26.
Line
: The elevation surface will be rendered using a line symbolFillBelow
: The elevation surface will be rendered using a fill symbol below the surface levelFillAbove
: The elevation surface will be rendered using a fill symbol above the surface level (since QGIS 3.32)
- FillAbove = 2¶
- FillBelow = 1¶
- Line = 0¶
- class ProjectCapabilities¶
- class ProjectCapabilities(f: Qgis.ProjectCapabilities | Qgis.ProjectCapability)
- class ProjectCapabilities(a0: Qgis.ProjectCapabilities)
Bases:
sip.wrapper
- class ProjectCapability(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Flags which control project capabilities.
These flags are specific upfront on creation of a
QgsProject
object, and can be used to selectively enable potentially costly functionality for the project.Added in version 3.26.1.
ProjectStyles
: Enable the project embedded style library. Enabling this flag can increase the time required to clear and load projects.
- ProjectStyles = 1¶
- class ProjectFileFormat(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Flags which control project read behavior.
Note
Prior to QGIS 3.26 this was available as
QgsProject
.FileFormatAdded in version 3.26.
Qgz
: Archive file format, supports auxiliary dataQgs
: Project saved in a clear text, does not support auxiliary data
- class ProjectFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Flags which control the behavior of
QgsProjects
.Added in version 3.26.
EvaluateDefaultValuesOnProviderSide
: If set, default values for fields will be evaluated on the provider side when features from the project are created instead of when they are committed.TrustStoredLayerStatistics
: If set, then layer statistics (such as the layer extent) will be read from values stored in the project instead of requesting updated values from the data provider. Additionally, when this flag is set, primary key unicity is not checked for views and materialized views with Postgres provider.RememberLayerEditStatusBetweenSessions
: If set, then any layers set to be editable will be stored in the project and immediately made editable whenever that project is restoredRememberAttributeTableWindowsBetweenSessions
: If set, then any open attribute tables will be stored in the project and immediately reopened when the project is restored
- EvaluateDefaultValuesOnProviderSide = 1¶
- RememberAttributeTableWindowsBetweenSessions = 8¶
- RememberLayerEditStatusBetweenSessions = 4¶
- TrustStoredLayerStatistics = 2¶
- class ProjectFlags¶
- class ProjectFlags(f: Qgis.ProjectFlags | Qgis.ProjectFlag)
- class ProjectFlags(a0: Qgis.ProjectFlags)
Bases:
sip.wrapper
- class ProjectReadFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Flags which control project read behavior.
Note
Prior to QGIS 3.26 this was available as
QgsProject
.ReadFlagAdded in version 3.26.
FlagDontResolveLayers
: Don’t resolve layer paths (i.e. don’t load any layer content). Dramatically improves project read time if the actual data from the layers is not required.FlagDontLoadLayouts
: Don’t load print layouts. Improves project read time if layouts are not required, and allows projects to be safely read in background threads (since print layouts are not thread safe).FlagTrustLayerMetadata
: Trust layer metadata. Improves project read time. Do not use it if layers’ extent is not fixed during the project’s use by QGIS and QGIS Server.FlagDontStoreOriginalStyles
: Skip the initial XML style storage for layers. Useful for minimising project load times in non-interactive contexts.FlagDontLoad3DViews
: Skip loading 3D views (since QGIS 3.26)DontLoadProjectStyles
: Skip loading project style databases (deprecated – use ProjectCapability.ProjectStyles flag instead)ForceReadOnlyLayers
: Open layers in a read-only mode. (since QGIS 3.28)
- class ProjectReadFlags¶
- class ProjectReadFlags(f: Qgis.ProjectReadFlags | Qgis.ProjectReadFlag)
- class ProjectReadFlags(a0: Qgis.ProjectReadFlags)
Bases:
sip.wrapper
- class ProviderStyleStorageCapabilities¶
- class ProviderStyleStorageCapabilities(f: Qgis.ProviderStyleStorageCapabilities | Qgis.ProviderStyleStorageCapability)
- class ProviderStyleStorageCapabilities(a0: Qgis.ProviderStyleStorageCapabilities)
Bases:
sip.wrapper
- class ProviderStyleStorageCapability(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
The StorageCapability enum represents the style storage operations supported by the provider.
Added in version 3.34.
SaveToDatabase
:LoadFromDatabase
:DeleteFromDatabase
:
- DeleteFromDatabase = 8¶
- LoadFromDatabase = 4¶
- SaveToDatabase = 2¶
- class PythonMacroMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Authorisation to run Python Macros
Added in version 3.10.
Never
: Macros are never runAsk
: User is prompt before runningSessionOnly
: Only during this sessionAlways
: Macros are always runNotForThisSession
: Macros will not be run for this session
- QGIS_DEV_VERSION = '91642333b10'¶
- QGIS_RELEASE_NAME = 'Prizren'¶
- QGIS_VERSION = '3.34.8-Prizren'¶
- QGIS_VERSION_INT = 33408¶
- class RasterAttributeTableFieldUsage(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
The RasterAttributeTableFieldUsage enum represents the usage of a Raster Attribute Table field.
Note
Directly mapped from GDALRATFieldUsage enum values.
Added in version 3.30.
Generic
: Field usage GenericPixelCount
: Field usage PixelCountName
: Field usage NameMin
: Field usage MinMax
: Field usage MaxMinMax
: Field usage MinMaxRed
: Field usage RedGreen
: Field usage GreenBlue
: Field usage BlueAlpha
: Field usage AlphaRedMin
: Field usage RedMinGreenMin
: Field usage GreenMinBlueMin
: Field usage BlueMinAlphaMin
: Field usage AlphaMinRedMax
: Field usage RedMaxGreenMax
: Field usage GreenMaxBlueMax
: Field usage BlueMaxAlphaMax
: Field usage AlphaMaxMaxCount
: Not used by QGIS: GDAL Maximum GFU value (equals to GFU_AlphaMax+1 currently)
- Alpha = 9¶
- AlphaMax = 17¶
- AlphaMin = 13¶
- Blue = 8¶
- BlueMax = 16¶
- BlueMin = 12¶
- Generic = 0¶
- Green = 7¶
- GreenMax = 15¶
- GreenMin = 11¶
- Max = 4¶
- MaxCount = 18¶
- Min = 3¶
- MinMax = 5¶
- Name = 2¶
- PixelCount = 1¶
- Red = 6¶
- RedMax = 14¶
- RedMin = 10¶
- class RasterAttributeTableType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
The RasterAttributeTableType enum represents the type of RAT. note Directly mapped from GDALRATTableType enum values.
Added in version 3.30.
Thematic
:Athematic
:
- Athematic = 1¶
- Thematic = 0¶
- class RasterBuildPyramidOption(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Raster pyramid building options.
Note
Prior to QGIS 3.30 this was available as
QgsRaster
.RasterBuildPyramidsAdded in version 3.30.
PyramidsFlagNo
: NeverPyramidsFlagYes
: YesPyramidsCopyExisting
: Copy existing
- class RasterColorInterpretation(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Raster color interpretation.
This is a modified copy of the GDAL GDALColorInterp enum.
Note
Prior to QGIS 3.30 this was available as
QgsRaster
.ColorInterpretationAdded in version 3.30.
UndefinedColorInterpretation
: UndefinedGrayIndex
: GrayscalePaletteIndex
: Paletted (see associated color table)RedBand
: Red band of RGBA imageGreenBand
: Green band of RGBA imageBlueBand
: Blue band of RGBA imageAlphaBand
: Alpha (0=transparent, 255=opaque)HueBand
: Hue band of HLS imageSaturationBand
: Saturation band of HLS imageLightnessBand
: Lightness band of HLS imageCyanBand
: Cyan band of CMYK imageMagentaBand
: Magenta band of CMYK imageYellowBand
: Yellow band of CMYK imageBlackBand
: Black band of CMLY imageYCbCr_YBand
: Y LuminanceYCbCr_CbBand
: Cb ChromaYCbCr_CrBand
: Cr ChromaContinuousPalette
: Continuous palette, QGIS addition, GRASS
- class RasterDrawingStyle(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Raster drawing styles.
Note
Prior to QGIS 3.30 this was available as
QgsRaster
.DrawingStyleAdded in version 3.30.
UndefinedDrawingStyle
: UndefinedSingleBandGray
: A single band image drawn as a range of gray colorsSingleBandPseudoColor
: A single band image drawn using a pseudocolor algorithmPalettedColor
: A “Palette” image drawn using color tablePalettedSingleBandGray
: A “Palette” layer drawn in gray scalePalettedSingleBandPseudoColor
: A “Palette” layerdrawn using a pseudocolor algorithmPalettedMultiBandColor
: Currently not supportedMultiBandSingleBandGray
: A layer containing 2 or more bands, but a single band drawn as a range of gray colorsMultiBandSingleBandPseudoColor
: A layer containing 2 or more bands, but a single band drawn using a pseudocolor algorithmMultiBandColor
: A layer containing 2 or more bands, mapped to RGB color space. In the case of a multiband with only two bands, one band will be mapped to more than one color.SingleBandColorDataStyle
: ARGB values rendered directly
- class RasterExportType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Raster file export types.
Prior to QGIS 3.32 this was available as
QgsRasterFileWriter
.ModeAdded in version 3.32.
Raw
: Raw dataImage
: Rendered image
- class RasterFileWriterResult(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Raster file export results.
Prior to QGIS 3.32 this was available as
QgsRasterFileWriter
.WriterErrorAdded in version 3.32.
NoError
: Successful exportSourceProviderError
: Source data provider errorDestProviderError
: Destination data provider errorCreateDatasourceError
: Data source creation errorWriteError
: Write errorNoDataConflict
: Internal error if a value used for ‘no data’ was found in inputWriteCanceled
: Writing was manually canceled
- class RasterIdentifyFormat(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Raster identify formats.
Note
Prior to QGIS 3.30 this was available as
QgsRaster
.IdentifyFormatAdded in version 3.30.
IdentifyFormatUndefined
: UndefinedIdentifyFormatValue
: Numerical pixel valueIdentifyFormatText
: WMS textIdentifyFormatHtml
: WMS HTMLIdentifyFormatFeature
: WMS GML/JSON -> feature
- class RasterLayerType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Raster layer types.
Note
Prior to QGIS 3.30 this was available as
QgsRasterLayer
.LayerTypeAdded in version 3.30.
GrayOrUndefined
: Gray or undefinedPalette
: PaletteMultiband
: Multi bandColorLayer
: Single band containing color data
- class RasterPipeInterfaceRole(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Raster pipe interface roles.
Added in version 3.22.
UnknownRole
: Unknown roleProviderRole
: Data provider roleRendererRole
: Raster renderer roleBrightnessRole
: Brightness filter roleResamplerRole
: Resampler roleProjectorRole
: Projector roleNullerRole
: Raster nuller roleHueSaturationRole
: Hue/saturation filter role (also applies grayscale/color inversion)
- class RasterPyramidFormat(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Raster pyramid formats.
Note
Prior to QGIS 3.30 this was available as
QgsRaster
.RasterPyramidsFormatAdded in version 3.30.
PyramidsGTiff
: Geotiff .ovr (external)PyramidsInternal
: InternalPyramidsErdas
: Erdas Image .aux (external)
- class RasterRendererFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Flags which control behavior of raster renderers.
Added in version 3.28.
InternalLayerOpacityHandling
: The renderer internally handles the raster layer’s opacity, so the default layer level opacity handling should not be applied.
- InternalLayerOpacityHandling = 1¶
- class RasterRendererFlags¶
- class RasterRendererFlags(f: Qgis.RasterRendererFlags | Qgis.RasterRendererFlag)
- class RasterRendererFlags(a0: Qgis.RasterRendererFlags)
Bases:
sip.wrapper
- class RasterResamplingStage(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Stage at which raster resampling occurs.
Added in version 3.22.
ResampleFilter
:Provider
:
- class RasterTemporalCapabilityFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Flags for raster layer temporal capabilities.
Added in version 3.28.
RequestedTimesMustExactlyMatchAllAvailableTemporalRanges
: If present, indicates that the provider must only request temporal values which are exact matches for the values present in QgsRasterDataProviderTemporalCapabilities.allAvailableTemporalRanges().
- RequestedTimesMustExactlyMatchAllAvailableTemporalRanges = 1¶
- class RasterTemporalCapabilityFlags¶
- class RasterTemporalCapabilityFlags(f: Qgis.RasterTemporalCapabilityFlags | Qgis.RasterTemporalCapabilityFlag)
- class RasterTemporalCapabilityFlags(a0: Qgis.RasterTemporalCapabilityFlags)
Bases:
sip.wrapper
- class RasterTemporalMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Raster layer temporal modes
Added in version 3.22.
ModeFixedTemporalRange
: Mode when temporal properties have fixed start and end datetimes.ModeTemporalRangeFromDataProvider
: Mode when raster layer delegates temporal range handling to the dataprovider.ModeRedrawLayerOnly
: Redraw the layer when temporal range changes, but don’t apply any filtering. Useful when raster symbology expressions depend on the time range. (since QGIS 3.22)
- class RelationshipCapabilities¶
- class RelationshipCapabilities(f: Qgis.RelationshipCapabilities | Qgis.RelationshipCapability)
- class RelationshipCapabilities(a0: Qgis.RelationshipCapabilities)
Bases:
sip.wrapper
- class RelationshipCapability(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Relationship capabilities.
Added in version 3.30.
MultipleFieldKeys
: Supports multiple field keys (as opposed to a singular field)ForwardPathLabel
: Supports forward path labelsBackwardPathLabel
: Supports backward path labels
- BackwardPathLabel = 4¶
- ForwardPathLabel = 2¶
- MultipleFieldKeys = 1¶
- class RelationshipCardinality(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Relationship cardinality.
Added in version 3.28.
OneToOne
: One to one relationshipOneToMany
: One to many relationshipManyToOne
: Many to one relationshipManyToMany
: Many to many relationship
- ManyToMany = 3¶
- ManyToOne = 2¶
- OneToMany = 1¶
- OneToOne = 0¶
- class RelationshipStrength(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Relationship strength.
Note
Prior to QGIS 3.28 this was available as
QgsRelation
.RelationStrength.Added in version 3.28.
Association
: Loose relation, related elements are not part of the parent and a parent copy will not copy any children.Composition
: Fix relation, related elements are part of the parent and a parent copy will copy any children or delete of parent will delete children
- class RelationshipType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Relationship types.
Note
Prior to QGIS 3.28 this was available as
QgsRelation
.RelationType.Added in version 3.28.
Normal
: A normal relationGenerated
: A generated relation is a child of a polymorphic relation
- class RenderContextFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Flags which affect rendering operations.
Added in version 3.22.
DrawEditingInfo
: Enable drawing of vertex markers for layers in editing modeForceVectorOutput
: Vector graphics should not be cached and drawn as raster imagesUseAdvancedEffects
: Enable layer opacity and blending effectsUseRenderingOptimization
: Enable vector simplification and other rendering optimizationsDrawSelection
: Whether vector selections should be shown in the rendered mapDrawSymbolBounds
: Draw bounds of symbols (for debugging/testing)RenderMapTile
: Draw map such that there are no problems between adjacent tilesAntialiasing
: Use antialiasing while drawingRenderPartialOutput
: Whether to make extra effort to update map image with partially rendered layers (better for interactive map canvas). Added in QGIS 3.0RenderPreviewJob
: Render is a ‘canvas preview’ render, and shortcuts should be taken to ensure fast renderingRenderBlocking
: Render and load remote sources in the same thread to ensure rendering remote sources (svg and images). WARNING: this flag must NEVER be used from GUI based applications (like the main QGIS application) or crashes will result. Only for use in external scripts or QGIS server.RenderSymbolPreview
: The render is for a symbol preview only and map based properties may not be available, so care should be taken to handle map unit based sizes in an appropriate way.LosslessImageRendering
: Render images losslessly whenever possible, instead of the default lossy jpeg rendering used for some destination devices (e.g. PDF). This flag only works with builds based on Qt 5.13 or later.ApplyScalingWorkaroundForTextRendering
: Whether a scaling workaround designed to stablise the rendering of small font sizes (or for painters scaled out by a large amount) when rendering text. Generally this is recommended, but it may incur some performance cost.Render3DMap
: Render is for a 3D mapApplyClipAfterReprojection
: Feature geometry clipping to mapExtent() must be performed after the geometries are transformed using coordinateTransform(). Usually feature geometry clipping occurs using the extent() in the layer’s CRS prior to geometry transformation, but in some cases when extent() could not be accurately calculated it is necessary to clip geometries to mapExtent() AFTER transforming them using coordinateTransform().RenderingSubSymbol
: Set whenever a sub-symbol of a parent symbol is currently being rendered. Can be used during symbol and symbol layer rendering to determine whether the symbol being rendered is a subsymbol. (Since QGIS 3.24)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)RecordProfile
: Enable run-time profiling while rendering (since QGIS 3.34)
- class RenderContextFlags¶
- class RenderContextFlags(f: Qgis.RenderContextFlags | Qgis.RenderContextFlag)
- class RenderContextFlags(a0: Qgis.RenderContextFlags)
Bases:
sip.wrapper
- class RenderSubcomponentProperty(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Rendering subcomponent properties.
Added in version 3.22.
Generic
: Generic subcomponent propertyShadowOffset
: Shadow offsetBlurSize
: Blur sizeGlowSpread
: Glow spread size
- BlurSize = 2¶
- Generic = 0¶
- GlowSpread = 3¶
- ShadowOffset = 1¶
- class RenderUnit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Rendering size units
Note
Prior to QGIS 3.30 this was available as
QgsUnitTypes
.RenderUnit.Added in version 3.30.
RenderMillimeters
: MillimetersRenderMapUnits
: Map unitsRenderPixels
: PixelsRenderPercentage
: Percentage of another measurement (e.g., canvas size, feature size)RenderPoints
: Points (e.g., for font sizes)RenderInches
: InchesRenderUnknownUnit
: Mixed or unknown unitsRenderMetersInMapUnits
: Meters value as Map units
- class RendererUsage(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Usage of the renderer.
Added in version 3.24.
View
: Renderer used for displaying on screenExport
: Renderer used for printing or exporting to a fileUnknown
: Renderer used for unknown usage
- Export = 1¶
- Unknown = 2¶
- View = 0¶
- SCALE_PRECISION = 0.9999999999¶
- class ScaleMethod(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Scale methods
Added in version 3.20.
ScaleArea
: Calculate scale by the areaScaleDiameter
: Calculate scale by the diameter
- class ScaleToTileZoomLevelMethod(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Available methods for converting map scales to tile zoom levels.
Added in version 3.26.
MapBox
: Uses a scale doubling approach to account for hi-DPI tiles, and rounds to the nearest tile level for the map scaleEsri
: No scale doubling, always rounds down when matching to available tile levels
- Esri = 1¶
- MapBox = 0¶
- class ScriptLanguage(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Scripting languages.
Added in version 3.30.
Css
: CSSQgisExpression
: QGIS expressionsHtml
: HTMLJavaScript
: JavaScriptJson
: JSONPython
: PythonR
: R StatsSql
: SQLBatch
: Windows batch filesBash
: Bash scriptsUnknown
: Unknown/other language
- Bash = 9¶
- Batch = 8¶
- Css = 0¶
- Html = 2¶
- JavaScript = 3¶
- Json = 4¶
- Python = 5¶
- QgisExpression = 1¶
- R = 6¶
- Sql = 7¶
- Unknown = 10¶
- class ScriptLanguageCapabilities¶
- class ScriptLanguageCapabilities(f: Qgis.ScriptLanguageCapabilities | Qgis.ScriptLanguageCapability)
- class ScriptLanguageCapabilities(a0: Qgis.ScriptLanguageCapabilities)
Bases:
sip.wrapper
- class ScriptLanguageCapability(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Script language capabilities.
The flags reflect the support capabilities of a scripting language.
Added in version 3.32.
Reformat
: Language supports automatic code reformattingCheckSyntax
: Language supports syntax checkingToggleComment
: Language supports comment toggling
- CheckSyntax = 2¶
- Reformat = 1¶
- ToggleComment = 4¶
- class SelectBehavior(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Specifies how a selection should be applied.
Added in version 3.22.
SetSelection
: Set selection, removing any existing selectionAddToSelection
: Add selection to current selectionIntersectSelection
: Modify current selection to include only select features which matchRemoveFromSelection
: Remove from current selection
- class SelectGeometryRelationship(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Geometry relationship test to apply for selecting features.
Added in version 3.28.
Intersect
: Select where features intersect the reference geometryWithin
: Select where features are within the reference geometry
- Intersect = 0¶
- Within = 1¶
- class SelectionFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Flags which control feature selection behavior.
Added in version 3.28.
SingleFeatureSelection
: Select only a single feature, picking the “best” match for the selection geometryToggleSelection
: Enables a “toggle” selection mode, where previously selected matching features will be deselected and previously deselected features will be selected. This flag works only when the SingleFeatureSelection flag is also set.
- SingleFeatureSelection = 1¶
- ToggleSelection = 2¶
- class SelectionFlags¶
- class SelectionFlags(f: Qgis.SelectionFlags | Qgis.SelectionFlag)
- class SelectionFlags(a0: Qgis.SelectionFlags)
Bases:
sip.wrapper
- class SelectionRenderingMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Specifies how a selection should be rendered.
Added in version 3.34.
Default
: Use default symbol and selection colorsCustomColor
: Use default symbol with a custom selection colorCustomSymbol
: Use a custom symbol
- CustomColor = 1¶
- CustomSymbol = 2¶
- Default = 0¶
- class SettingsOption(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Settings options
Added in version 3.26.
SaveFormerValue
:SaveEnumFlagAsInt
:
- SaveEnumFlagAsInt = 4¶
- SaveFormerValue = 2¶
- class SettingsOptions¶
- class SettingsOptions(f: Qgis.SettingsOptions | Qgis.SettingsOption)
- class SettingsOptions(a0: Qgis.SettingsOptions)
Bases:
sip.wrapper
- class SettingsOrigin(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
The setting origin describes where a setting is stored.
Added in version 3.30.
Any
: From any originGlobal
: Global settings are stored in qgis_global_settings.iniLocal
: Local settings are stored in the user profile
- Any = 0¶
- Global = 1¶
- Local = 2¶
- class SettingsTreeNodeOption(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Options for named list nodes
Added in version 3.30.
NamedListSelectedItemSetting
: Creates a setting to store which is the current item
- NamedListSelectedItemSetting = 1¶
- class SettingsTreeNodeOptions¶
- class SettingsTreeNodeOptions(f: Qgis.SettingsTreeNodeOptions | Qgis.SettingsTreeNodeOption)
- class SettingsTreeNodeOptions(a0: Qgis.SettingsTreeNodeOptions)
Bases:
sip.wrapper
- class SettingsTreeNodeType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Type of tree node
Added in version 3.30.
Root
: Root NodeStandard
: Normal NodeNamedList
:
- NamedList = 2¶
- Root = 0¶
- Standard = 1¶
- class SettingsType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Types of settings entries
Added in version 3.26.
Custom
: Custom implementationVariant
: Generic variantString
: StringStringList
: List of stringsVariantMap
: Map of stringsBool
: BooleanInteger
: IntegerDouble
: Double precision numberEnumFlag
: Enum or FlagColor
: Color
- class SldExportOption(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
SLD export options
Added in version 3.30.
NoOptions
: Default SLD exportSvg
: Export complex styles to separate SVG files for better compatibility with OGC serversPng
: Export complex styles to separate PNG files for better compatibility with OGC servers
- NoOptions = 0¶
- Png = 2¶
- Svg = 1¶
- class SldExportOptions¶
- class SldExportOptions(f: Qgis.SldExportOptions | Qgis.SldExportOption)
- class SldExportOptions(a0: Qgis.SldExportOptions)
Bases:
sip.wrapper
- class SldExportVendorExtension(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
SLD export vendor extensions, allow the use of vendor extensions when exporting to SLD.
Added in version 3.30.
NoVendorExtension
: No vendor extensionsGeoServerVendorExtension
: Use GeoServer vendor extensions when requiredDeegreeVendorExtension
: Use Deegree vendor extensions when required
- DeegreeVendorExtension = 4¶
- GeoServerVendorExtension = 2¶
- NoVendorExtension = 0¶
- class SnappingMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
SnappingMode defines on which layer the snapping is performed
Added in version 3.26.
ActiveLayer
: On the active layerAllLayers
: On all vector layersAdvancedConfiguration
: On a per layer configuration basis
- class SnappingType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
SnappingTypeFlag defines on what object the snapping is performed
Added in version 3.26.
NoSnapFlag
: No snappingVertexFlag
: On verticesSegmentFlag
: On segmentsAreaFlag
: On AreaCentroidFlag
: On centroidMiddleOfSegmentFlag
: On Middle segmentLineEndpointFlag
: Start or end points of lines, or first vertex in polygon rings only (since QGIS 3.20)
- class SnappingTypes¶
- class SnappingTypes(f: Qgis.SnappingTypes | Qgis.SnappingType)
- class SnappingTypes(a0: Qgis.SnappingTypes)
Bases:
sip.wrapper
- class SpatialFilterType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Feature request spatial filter types.
Added in version 3.22.
NoFilter
: No spatial filtering of featuresBoundingBox
: Filter using a bounding boxDistanceWithin
: Filter by distance to reference geometry
- BoundingBox = 1¶
- DistanceWithin = 2¶
- NoFilter = 0¶
- class SqlKeywordCategory(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
SqlKeywordCategory enum represents the categories of the SQL keywords used by the SQL query editor.
Note
The category has currently no usage, but it was planned for future uses.
Added in version 3.22.
Keyword
: SQL keywordConstant
: SQL constantFunction
: SQL generic functionGeospatial
: SQL spatial functionOperator
: SQL operatorMath
: SQL math functionAggregate
: SQL aggregate functionString
: SQL string functionIdentifier
: SQL identifier
- Aggregate = 6¶
- Constant = 1¶
- Function = 2¶
- Geospatial = 3¶
- Identifier = 8¶
- Keyword = 0¶
- Math = 5¶
- Operator = 4¶
- String = 7¶
- class SqlLayerDefinitionCapabilities¶
- class SqlLayerDefinitionCapabilities(f: Qgis.SqlLayerDefinitionCapabilities | Qgis.SqlLayerDefinitionCapability)
- class SqlLayerDefinitionCapabilities(a0: Qgis.SqlLayerDefinitionCapabilities)
Bases:
sip.wrapper
- class SqlLayerDefinitionCapability(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
SqlLayerDefinitionCapability enum lists the arguments supported by the provider when creating SQL query layers.
Added in version 3.22.
SubsetStringFilter
: SQL layer definition supports subset string filterGeometryColumn
: SQL layer definition supports geometry columnPrimaryKeys
: SQL layer definition supports primary keysUnstableFeatureIds
: SQL layer definition supports disabling select at id
- GeometryColumn = 4¶
- PrimaryKeys = 8¶
- SubsetStringFilter = 2¶
- UnstableFeatureIds = 16¶
- class SublayerFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Flags which reflect the properties of sublayers in a dataset.
Added in version 3.22.
SystemTable
: Sublayer is a system or internal table, which should be hidden by default
- SystemTable = 1¶
- class SublayerFlags¶
- class SublayerFlags(f: Qgis.SublayerFlags | Qgis.SublayerFlag)
- class SublayerFlags(a0: Qgis.SublayerFlags)
Bases:
sip.wrapper
- class SublayerPromptMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Specifies how to handle layer sources with multiple sublayers.
Added in version 3.22.
AlwaysAsk
: Always ask users to select from available sublayers, if sublayers are presentAskExcludingRasterBands
: Ask users to select from available sublayers, unless only raster bands are presentNeverAskSkip
: Never ask users to select sublayers, instead don’t load anythingNeverAskLoadAll
: Never ask users to select sublayers, instead automatically load all available sublayers
- AlwaysAsk = 0¶
- AskExcludingRasterBands = 1¶
- NeverAskLoadAll = 3¶
- NeverAskSkip = 2¶
- class SublayerQueryFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Flags which control how data providers will scan for sublayers in a dataset.
Added in version 3.22.
FastScan
: Indicates that the provider must scan for sublayers using the fastest possible approach – e.g. by first checking that a uri has an extension which is known to be readable by the providerResolveGeometryType
: Attempt to resolve the geometry type for vector sublayersCountFeatures
: Count features in vector sublayersIncludeSystemTables
: Include system or internal tables (these are not included by default)
- CountFeatures = 4¶
- FastScan = 1¶
- IncludeSystemTables = 8¶
- ResolveGeometryType = 2¶
- class SublayerQueryFlags¶
- class SublayerQueryFlags(f: Qgis.SublayerQueryFlags | Qgis.SublayerQueryFlag)
- class SublayerQueryFlags(a0: Qgis.SublayerQueryFlags)
Bases:
sip.wrapper
- Success = 3¶
- class SymbolCoordinateReference(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Symbol coordinate reference modes.
Note
Prior to QGIS 3.24 this was available as
QgsGradientFillSymbolLayer
.GradientCoordinateModeAdded in version 3.24.
Feature
: Relative to feature/shape being renderedViewport
: Relative to the whole viewport/output device
- class SymbolFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Flags controlling behavior of symbols
Added in version 3.20.
RendererShouldUseSymbolLevels
: If present, indicates that aQgsFeatureRenderer
using the symbol should use symbol levels for best results
- RendererShouldUseSymbolLevels = 1¶
- class SymbolFlags¶
- class SymbolFlags(f: Qgis.SymbolFlags | Qgis.SymbolFlag)
- class SymbolFlags(a0: Qgis.SymbolFlags)
Bases:
sip.wrapper
- class SymbolLayerFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Flags controlling behavior of symbol layers
Note
These differ from Qgis.SymbolLayerUserFlag in that Qgis.SymbolLayerFlag flags are used to reflect the inbuilt properties of a symbol layer type, whereas Qgis.SymbolLayerUserFlag are optional, user controlled flags which can be toggled for a symbol layer.
Added in version 3.22.
DisableFeatureClipping
: If present, indicates that features should never be clipped to the map extent during rendering
- DisableFeatureClipping = 1¶
- class SymbolLayerFlags¶
- class SymbolLayerFlags(f: Qgis.SymbolLayerFlags | Qgis.SymbolLayerFlag)
- class SymbolLayerFlags(a0: Qgis.SymbolLayerFlags)
Bases:
sip.wrapper
- class SymbolLayerUserFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
User-specified flags controlling behavior of symbol layers.
Note
These differ from Qgis.SymbolLayerFlag in that Qgis.SymbolLayerFlag flags are used to reflect the inbuilt properties of a symbol layer type, whereas Qgis.SymbolLayerUserFlag are optional, user controlled flags which can be toggled for a symbol layer.
Added in version 3.34.
DisableSelectionRecoloring
: If present, indicates that the symbol layer should not be recolored when rendering selected features
- DisableSelectionRecoloring = 1¶
- class SymbolLayerUserFlags¶
- class SymbolLayerUserFlags(f: Qgis.SymbolLayerUserFlags | Qgis.SymbolLayerUserFlag)
- class SymbolLayerUserFlags(a0: Qgis.SymbolLayerUserFlags)
Bases:
sip.wrapper
- class SymbolPreviewFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Flags for controlling how symbol preview images are generated.
Added in version 3.20.
FlagIncludeCrosshairsForMarkerSymbols
: Include a crosshairs reference image in the background of marker symbol previews
- class SymbolPreviewFlags¶
- class SymbolPreviewFlags(f: Qgis.SymbolPreviewFlags | Qgis.SymbolPreviewFlag)
- class SymbolPreviewFlags(a0: Qgis.SymbolPreviewFlags)
Bases:
sip.wrapper
- class SymbolRenderHint(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Flags controlling behavior of symbols during rendering
Added in version 3.20.
DynamicRotation
: Rotation of symbol may be changed during rendering and symbol should not be cached
- class SymbolRenderHints¶
- class SymbolRenderHints(f: Qgis.SymbolRenderHints | Qgis.SymbolRenderHint)
- class SymbolRenderHints(a0: Qgis.SymbolRenderHints)
Bases:
sip.wrapper
- class SymbolRotationMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Modes for handling how symbol and text entity rotation is handled when maps are rotated.
Added in version 3.32.
RespectMapRotation
: Entity is rotated along with the mapIgnoreMapRotation
: Entity ignores map rotation
- IgnoreMapRotation = 1¶
- RespectMapRotation = 0¶
- class SymbolType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Symbol types
Added in version 3.20.
Marker
: Marker symbolLine
: Line symbolFill
: Fill symbolHybrid
: Hybrid symbol
- class SystemOfMeasurement(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Systems of unit measurement.
Note
Prior to QGIS 3.30 this was available as
QgsUnitTypes
.SystemOfMeasurement.Added in version 3.30.
UnknownSystem
: Unknown system of measurementMetricSystem
: International System of Units (SI)ImperialSystem
: British ImperialUSCSSystem
: United States customary system
- class TemporalIntervalMatchMethod(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Method to use when resolving a temporal range to a data provider layer or band.
Added in version 3.22.
MatchUsingWholeRange
: Use an exact match to the whole temporal rangeMatchExactUsingStartOfRange
: Match the start of the temporal range to a corresponding layer or band, and only use exact matching resultsMatchExactUsingEndOfRange
: Match the end of the temporal range to a corresponding layer or band, and only use exact matching resultsFindClosestMatchToStartOfRange
: Match the start of the temporal range to the least previous closest datetime.FindClosestMatchToEndOfRange
: Match the end of the temporal range to the least previous closest datetime.
- class TemporalUnit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Temporal units.
Note
Prior to QGIS 3.30 this was available as
QgsUnitTypes
.TemporalUnit.Added in version 3.30.
TemporalMilliseconds
: MillisecondsTemporalSeconds
: SecondsTemporalMinutes
: MinutesTemporalHours
: HoursTemporalDays
: DaysTemporalWeeks
: WeeksTemporalMonths
: MonthsTemporalYears
: YearsTemporalDecades
: DecadesTemporalCenturies
: CenturiesTemporalIrregularStep
: Special ‘irregular step’ time unit, used for temporal data which uses irregular, non-real-world unit steps (since QGIS 3.20)TemporalUnknownUnit
: Unknown time unit
- class TextCharacterVerticalAlignment(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Text vertical alignment for characters.
This enum controls vertical alignment of individual characters within a block of text.
Added in version 3.30.
Normal
: Adjacent characters are positioned in the standard way for text in the writing system in useSuperScript
: Characters are placed above the base line for normal text.SubScript
: Characters are placed below the base line for normal text.
- Normal = 0¶
- SubScript = 2¶
- SuperScript = 1¶
- class TextComponent(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Text components.
Note
Prior to QGIS 3.28 this was available as
QgsTextRenderer
.TextPartAdded in version 3.28.
Text
: Text componentBuffer
: Buffer componentBackground
: Background shapeShadow
: Drop shadow
- class TextHorizontalAlignment(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Text horizontal alignment.
Note
Prior to QGIS 3.28 this was available as
QgsTextRenderer
.HAlignmentAdded in version 3.28.
AlignLeft
: Left alignAlignCenter
: Center alignAlignRight
: Right alignAlignJustify
: Justify align
- class TextLayoutMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Text layout modes.
Note
Prior to QGIS 3.28 this was available as
QgsTextRenderer
.DrawModeAdded in version 3.28.
Rect
: Text within rectangle layout modePoint
: Text at point of origin layout modeLabel
: Labeling-specific layout modeRectangleCapHeightBased
: Similar to Rectangle mode, but uses cap height only when calculating font heights for the first line of text, and cap height + descent for subsequent lines of text (since QGIS 3.30)RectangleAscentBased
: Similar to Rectangle mode, but uses ascents only when calculating font and line heights. (since QGIS 3.30)
- class TextOrientation(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Text orientations.
Note
Prior to QGIS 3.28 this was available as
QgsTextFormat
.TextOrientationAdded in version 3.28.
HorizontalOrientation
: Horizontally oriented textVerticalOrientation
: Vertically oriented textRotationBasedOrientation
: Horizontally or vertically oriented text based on rotation (only available for map labeling)
- class TextRenderFormat(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Options for rendering text.
Added in version 3.22.
TextFormatAlwaysOutlines
: Always render text using path objects (AKA outlines/curves). This setting guarantees the best quality rendering, even when using a raster paint surface (where sub-pixel path based text rendering is superior to sub-pixel text-based rendering). The downside is that text is converted to paths only, so users cannot open created vector outputs for post-processing in other applications and retain text editability. This setting also guarantees complete compatibility with the full range of formatting options available throughQgsTextRenderer
andQgsTextFormat
, some of which may not be possible to reproduce when using a vector-based paint surface and TextFormatAlwaysText mode. A final benefit to this setting is that vector exports created using text as outlines do not require all users to have the original fonts installed in order to display the text in its original style.TextFormatAlwaysText
: Always render text as text objects. While this mode preserves text objects as text for post-processing in external vector editing applications, it can result in rendering artifacts or poor quality rendering, depending on the text format settings. Even with raster based paint devices, TextFormatAlwaysText can result in inferior rendering quality to TextFormatAlwaysOutlines. When rendering using TextFormatAlwaysText to a vector based device (e.g. PDF or SVG), care must be taken to ensure that the required fonts are available to users when opening the created files, or default fallback fonts will be used to display the output instead. (Although PDF exports MAY automatically embed some fonts when possible, depending on the user’s platform).
- class TextRendererFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Flags which control the behavior of rendering text.
Added in version 3.24.
WrapLines
: Automatically wrap long lines of text
- WrapLines = 1¶
- class TextRendererFlags¶
- class TextRendererFlags(f: Qgis.TextRendererFlags | Qgis.TextRendererFlag)
- class TextRendererFlags(a0: Qgis.TextRendererFlags)
Bases:
sip.wrapper
- class TextVerticalAlignment(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Text vertical alignment.
This enum controls vertical alignment of text in a predefined rectangular bounding box. See also Qgis.TextCharacterVerticalAlignment.
Note
Prior to QGIS 3.28 this was available as
QgsTextRenderer
.VAlignmentAdded in version 3.28.
AlignTop
: Align to topAlignVCenter
: Center alignAlignBottom
: Align to bottom
- class TileAvailability(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Possible availability states for a tile within a tile matrix.
Added in version 3.32.
Available
: Tile is available within the matrixNotAvailable
: Tile is not available within the matrix, e.g. there is no content for the tileAvailableNoChildren
: Tile is available within the matrix, and is known to have no children (ie no higher zoom level tiles exist covering this tile’s region)UseLowerZoomLevelTile
: Tile is not available at the requested zoom level, it should be replaced by a tile from a lower zoom level instead182
- Available = 0¶
- AvailableNoChildren = 2¶
- NotAvailable = 1¶
- UseLowerZoomLevelTile = 3¶
- class TileChildrenAvailability(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Possible availability states for a tile’s children.
Added in version 3.34.
NoChildren
: Tile is known to have no childrenAvailable
: Tile children are already availableNeedFetching
: Tile has children, but they are not yet available and must be fetched
- Available = 1¶
- NeedFetching = 2¶
- NoChildren = 0¶
- class TilePixelRatio(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
DpiMode enum
Added in version 3.30.
Undefined
: Undefined (not scale)StandardDpi
: Standard (96 DPI)HighDpi
: High (192 DPI)
- HighDpi = 2¶
- StandardDpi = 1¶
- Undefined = 0¶
- class TileRefinementProcess(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Tiled scene tile refinement processes.
Refinement determines the process by which a lower resolution parent tile renders when its higher resolution children are selected to be rendered.
Added in version 3.34.
Replacement
: When tile is refined then its children should be used in place of itself.Additive
: When tile is refined its content should be used alongside its children simultaneously.
- Additive = 1¶
- Replacement = 0¶
- class TiledSceneBoundingVolumeType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Tiled scene bounding volume types.
Added in version 3.34.
Region
: Region typeOrientedBox
: Oriented bounding box (rotated box)Sphere
: Sphere
- OrientedBox = 1¶
- Region = 0¶
- Sphere = 2¶
- class TiledSceneProviderCapabilities¶
- class TiledSceneProviderCapabilities(f: Qgis.TiledSceneProviderCapabilities | Qgis.TiledSceneProviderCapability)
- class TiledSceneProviderCapabilities(a0: Qgis.TiledSceneProviderCapabilities)
Bases:
sip.wrapper
- class TiledSceneProviderCapability(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Tiled scene data provider capabilities.
Added in version 3.34.
ReadLayerMetadata
: Provider can read layer metadata from data store. See QgsDataProvider.layerMetadata()
- ReadLayerMetadata = 2¶
- class TiledSceneRendererFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Flags which control how tiled scene 2D renderers behave.
Added in version 3.34.
RequiresTextures
: Renderer requires texturesForceRasterRender
: Layer should always be rendered as a raster imageRendersTriangles
: Renderer can render triangle primitivesRendersLines
: Renderer can render line primitives
- ForceRasterRender = 2¶
- RendersLines = 8¶
- RendersTriangles = 4¶
- RequiresTextures = 1¶
- class TiledSceneRendererFlags¶
- class TiledSceneRendererFlags(f: Qgis.TiledSceneRendererFlags | Qgis.TiledSceneRendererFlag)
- class TiledSceneRendererFlags(a0: Qgis.TiledSceneRendererFlags)
Bases:
sip.wrapper
- class TiledSceneRequestFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Flags which control how tiled scene requests behave.
Added in version 3.34.
NoHierarchyFetch
: Do not allow hierarchy fetching when hierarchy is not currently available. Avoids network requests, but may result in an incomplete tile set. If set, then callers will need to manually perform hierarchy fetches as required.
- NoHierarchyFetch = 1¶
- class TiledSceneRequestFlags¶
- class TiledSceneRequestFlags(f: Qgis.TiledSceneRequestFlags | Qgis.TiledSceneRequestFlag)
- class TiledSceneRequestFlags(a0: Qgis.TiledSceneRequestFlags)
Bases:
sip.wrapper
- class TransactionMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Transaction mode.
Added in version 3.26.
Disabled
: Edits are buffered locally and sent to the provider when toggling layer editing mode.AutomaticGroups
: Automatic transactional editing means that on supported datasources (postgres and geopackage databases) the edit state of all tables that originate from the same database are synchronized and executed in a server side transaction.BufferedGroups
: Buffered transactional editing means that all editable layers in the buffered transaction group are toggled synchronously and all edits are saved in a local edit buffer. Saving changes is executed within a single transaction on all layers (per provider).
- AutomaticGroups = 1¶
- BufferedGroups = 2¶
- Disabled = 0¶
- class TransformDirection(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Indicates the direction (forward or inverse) of a transform.
Added in version 3.22.
ForwardTransform
: Forward transform (from source to destination)ReverseTransform
: Reverse/inverse transform (from destination to source)
- UI_SCALE_FACTOR = 1.0¶
- class UnitType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Unit types.
Note
Prior to QGIS 3.30 this was available as
QgsUnitTypes
.UnitType.Added in version 3.30.
TypeDistance
: Distance unitTypeArea
: Area unitTypeVolume
: Volume unitTypeUnknown
: Unknown unit typeTypeTemporal
: Temporal unit
- class UnplacedLabelVisibility(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Unplaced label visibility.
Added in version 3.20.
FollowEngineSetting
: Respect the label engine settingNeverShow
: Never show unplaced labels, regardless of the engine setting
- FollowEngineSetting = 0¶
- NeverShow = 1¶
- class UpsideDownLabelHandling(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Handling techniques for upside down labels.
Note
Prior to QGIS 3.26 this was available as
QgsPalLayerSettings
.UpsideDownLabelsAdded in version 3.26.
Upright
: Upside-down labels (90 <= angle < 270) are shown uprightShowDefined
: Show upside down when rotation is layer- or data-definedShowAll
: Show upside down for all labels, including dynamic ones
- class UserProfileSelectionPolicy(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
User profile selection policy.
Added in version 3.32.
LastProfile
: Open the last closed profile (only mode supported prior to QGIS 3.32)DefaultProfile
: Open a specific profileAskUser
: Let the user choose which profile to open
- AskUser = 2¶
- DefaultProfile = 1¶
- LastProfile = 0¶
- class VectorDataProviderAttributeEditCapabilities¶
- class VectorDataProviderAttributeEditCapabilities(f: Qgis.VectorDataProviderAttributeEditCapabilities | Qgis.VectorDataProviderAttributeEditCapability)
- class VectorDataProviderAttributeEditCapabilities(a0: Qgis.VectorDataProviderAttributeEditCapabilities)
Bases:
sip.wrapper
- class VectorDataProviderAttributeEditCapability(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Attribute editing capabilities which may be supported by vector data providers.
Added in version 3.32.
EditAlias
: Allows editing aliasesEditComment
: Allows editing comments
- EditAlias = 1¶
- EditComment = 2¶
- class VectorDataProviderTemporalMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Vector data provider temporal handling modes.
Added in version 3.22.
ProviderHasFixedTemporalRange
: Entire dataset from provider has a fixed start and end datetime.ProviderStoresFeatureDateTimeInstantInField
: Dataset has feature datetime instants stored in a single fieldProviderStoresFeatureDateTimeStartAndEndInSeparateFields
: Dataset stores feature start and end datetimes in separate fields
- class VectorEditResult(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Specifies the result of a vector layer edit operation
Added in version 3.22.
Success
: Edit operation was successfulEmptyGeometry
: Edit operation resulted in an empty geometryEditFailed
: Edit operation failedFetchFeatureFailed
: Unable to fetch requested featureInvalidLayer
: Edit failed due to invalid layer
- class VectorExportResult(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Vector layer export result codes.
Added in version 3.20.
NoError
: No errors were encounteredErrCreateDataSource
: Could not create the destination data sourceErrCreateLayer
: Could not create destination layerErrAttributeTypeUnsupported
: Source layer has an attribute type which could not be handled by destinationErrAttributeCreationFailed
: Destination provider was unable to create an attributeErrProjection
: An error occurred while reprojecting features to destination CRSErrFeatureWriteFailed
: An error occurred while writing a feature to the destinationErrInvalidLayer
: Could not access newly created destination layerErrInvalidProvider
: Could not find a matching provider keyErrProviderUnsupportedFeature
: Provider does not support creation of empty layersErrConnectionFailed
: Could not connect to destinationErrUserCanceled
: User canceled the export
- class VectorFileWriterCapabilities¶
- class VectorFileWriterCapabilities(f: Qgis.VectorFileWriterCapabilities | Qgis.VectorFileWriterCapability)
- class VectorFileWriterCapabilities(a0: Qgis.VectorFileWriterCapabilities)
Bases:
sip.wrapper
- class VectorFileWriterCapability(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Capabilities supported by a
QgsVectorFileWriter
object.Added in version 3.32.
FieldAliases
: Writer can support field aliasesFieldComments
: Writer can support field comments
- FieldAliases = 1¶
- FieldComments = 4¶
- class VectorLayerTypeFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Vector layer type flags.
Added in version 3.24.
SqlQuery
: SQL query layer
- SqlQuery = 1¶
- class VectorLayerTypeFlags¶
- class VectorLayerTypeFlags(f: Qgis.VectorLayerTypeFlags | Qgis.VectorLayerTypeFlag)
- class VectorLayerTypeFlags(a0: Qgis.VectorLayerTypeFlags)
Bases:
sip.wrapper
- class VectorProfileType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Types of elevation profiles to generate for vector sources.
Added in version 3.26.
IndividualFeatures
: Treat each feature as an individual object (eg buildings)ContinuousSurface
: The features should be treated as representing values on a continuous surface (eg contour lines)
- ContinuousSurface = 1¶
- IndividualFeatures = 0¶
- class VectorTemporalLimitMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Mode for the handling of the limits of the filtering timeframe for vector features
Added in version 3.22.
IncludeBeginExcludeEnd
: Default mode: include the Begin limit, but exclude the End limitIncludeBeginIncludeEnd
: Mode to include both limits of the filtering timeframe
- IncludeBeginExcludeEnd = 0¶
- IncludeBeginIncludeEnd = 1¶
- class VectorTemporalMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Vector layer temporal feature modes
Added in version 3.22.
ModeFixedTemporalRange
: Mode when temporal properties have fixed start and end datetimes.ModeFeatureDateTimeInstantFromField
: Mode when features have a datetime instant taken from a single fieldModeFeatureDateTimeStartAndEndFromFields
: Mode when features have separate fields for start and end timesModeFeatureDateTimeStartAndDurationFromFields
: Mode when features have a field for start time and a field for event durationModeFeatureDateTimeStartAndEndFromExpressions
: Mode when features use expressions for start and end timesModeRedrawLayerOnly
: Redraw the layer when temporal range changes, but don’t apply any filtering. Useful when symbology or rule based renderer expressions depend on the time range.
- class VectorTileProviderCapabilities¶
- class VectorTileProviderCapabilities(f: Qgis.VectorTileProviderCapabilities | Qgis.VectorTileProviderCapability)
- class VectorTileProviderCapabilities(a0: Qgis.VectorTileProviderCapabilities)
Bases:
sip.wrapper
- class VectorTileProviderCapability(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Enumeration with capabilities that vector tile data providers might implement.
Added in version 3.32.
ReadLayerMetadata
: Provider can read layer metadata from data store. See QgsDataProvider.layerMetadata()
- ReadLayerMetadata = 2¶
- class VectorTileProviderFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Flags for vector tile data providers.
Added in version 3.32.
AlwaysUseTileMatrixSetFromProvider
: Vector tile layer must always use the tile matrix set from the data provider, and should never store, restore or override the definition of this matrix set.
- AlwaysUseTileMatrixSetFromProvider = 2¶
- class VectorTileProviderFlags¶
- class VectorTileProviderFlags(f: Qgis.VectorTileProviderFlags | Qgis.VectorTileProviderFlag)
- class VectorTileProviderFlags(a0: Qgis.VectorTileProviderFlags)
Bases:
sip.wrapper
- class VertexMarkerType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Editing vertex markers, used for showing vertices during a edit operation.
Added in version 3.22.
SemiTransparentCircle
: Semi-transparent circle markerCross
: Cross markerNoMarker
: No marker
- class VertexType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Types of vertex.
Added in version 3.22.
SegmentVertex
: The actual start or end point of a segmentCurveVertex
: An intermediate point on a segment defining the curvature of the segment
- class VerticalAxisInversion(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Vertical axis inversion options for 3D views.
Added in version 3.30.
Never
: Never invert vertical axis movementsWhenDragging
: Invert vertical axis movements when dragging in first person modesAlways
: Always invert vertical axis movements
- Always = 2¶
- Never = 0¶
- WhenDragging = 1¶
- class ViewSyncModeFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Synchronization of 2D map canvas and 3D view
Added in version 3.26.
Sync3DTo2D
: Synchronize 3D view camera to the main map canvas extentSync2DTo3D
: Update the 2D main canvas extent to include the viewed area from the 3D view
- Sync2DTo3D = 2¶
- Sync3DTo2D = 1¶
- class ViewSyncModeFlags¶
- class ViewSyncModeFlags(f: Qgis.ViewSyncModeFlags | Qgis.ViewSyncModeFlag)
- class ViewSyncModeFlags(a0: Qgis.ViewSyncModeFlags)
Bases:
sip.wrapper
- class VolumeUnit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
Units of volume.
Note
Prior to QGIS 3.30 this was available as
QgsUnitTypes
.VolumeUnit.Added in version 3.30.
VolumeCubicMeters
: Cubic metersVolumeCubicFeet
: Cubic feetVolumeCubicYards
: Cubic yardsVolumeBarrel
: BarrelsVolumeCubicDecimeter
: Cubic decimetersVolumeLiters
: LitresVolumeGallonUS
: US GallonsVolumeCubicInch
: Cubic inchesVolumeCubicCentimeter
: Cubic CentimetersVolumeCubicDegrees
: Cubic degrees, for planar geographic CRS volume measurementsVolumeUnknownUnit
: Unknown volume unit
- Warning = 1¶
- class WkbType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
enum.IntEnum
The WKB type describes the number of dimensions a geometry has
Point
LineString
Polygon
as well as the number of dimensions for each individual vertex
X (always)
Y (always)
Z (optional)
M (measurement value, optional)
it also has values for multi types, collections, unknown geometry, null geometry, no geometry and curve support.
These classes of geometry are often used for data sources to communicate what kind of geometry should be expected for a given geometry field. It is also used for tools or algorithms to decide if they should be available for a given geometry type or act in a different mode.
Note
Prior to 3.30 this was available as
QgsWkbTypes
.Type.Added in version 3.30.
Unknown
: UnknownPoint
: PointLineString
: LineStringPolygon
: PolygonTriangle
: TriangleMultiPoint
: MultiPointMultiLineString
: MultiLineStringMultiPolygon
: MultiPolygonGeometryCollection
: GeometryCollectionCircularString
: CircularStringCompoundCurve
: CompoundCurveCurvePolygon
: CurvePolygonMultiCurve
: MultiCurveMultiSurface
: MultiSurfaceNoGeometry
: No geometryPointZ
: PointZLineStringZ
: LineStringZPolygonZ
: PolygonZTriangleZ
: TriangleZMultiPointZ
: MultiPointZMultiLineStringZ
: MultiLineStringZMultiPolygonZ
: MultiPolygonZGeometryCollectionZ
: GeometryCollectionZCircularStringZ
: CircularStringZCompoundCurveZ
: CompoundCurveZCurvePolygonZ
: CurvePolygonZMultiCurveZ
: MultiCurveZMultiSurfaceZ
: MultiSurfaceZPointM
: PointMLineStringM
: LineStringMPolygonM
: PolygonMTriangleM
: TriangleMMultiPointM
: MultiPointMMultiLineStringM
: MultiLineStringMMultiPolygonM
: MultiPolygonMGeometryCollectionM
: GeometryCollectionMCircularStringM
: CircularStringMCompoundCurveM
: CompoundCurveMCurvePolygonM
: CurvePolygonMMultiCurveM
: MultiCurveMMultiSurfaceM
: MultiSurfaceMPointZM
: PointZMLineStringZM
: LineStringZMPolygonZM
: PolygonZMMultiPointZM
: MultiPointZMMultiLineStringZM
: MultiLineStringZMMultiPolygonZM
: MultiPolygonZMGeometryCollectionZM
: GeometryCollectionZMCircularStringZM
: CircularStringZMCompoundCurveZM
: CompoundCurveZMCurvePolygonZM
: CurvePolygonZMMultiCurveZM
: MultiCurveZMMultiSurfaceZM
: MultiSurfaceZMTriangleZM
: TriangleZMPoint25D
: Point25DLineString25D
: LineString25DPolygon25D
: Polygon25DMultiPoint25D
: MultiPoint25DMultiLineString25D
: MultiLineString25DMultiPolygon25D
: MultiPolygon25D
- defaultProjectScales() str ¶
A string with default project scales.
Added in version 3.12.
- Return type:
str
- devVersion() str ¶
The development version
Added in version 3.12.
- Return type:
str
- geosVersion() str ¶
GEOS string version linked
Added in version 3.20.
- Return type:
str
- geosVersionInt() int ¶
GEOS version number linked
Added in version 3.20.
- Return type:
int
- geosVersionMajor() int ¶
GEOS Major version number linked
Added in version 3.20.
- Return type:
int
- geosVersionMinor() int ¶
GEOS Minor version number linked
Added in version 3.20.
- Return type:
int
- geosVersionPatch() int ¶
GEOS Patch version number linked
Added in version 3.20.
- Return type:
int
- releaseName() str ¶
Release name
Added in version 3.12.
- Return type:
str
- staticMetaObject = <PyQt5.QtCore.QMetaObject object>¶
- version() str ¶
Version string.
Added in version 3.12.
- Return type:
str
- versionInt() int ¶
Version number used for comparing versions using the “Check QGIS Version” function
Added in version 3.12.
- Return type:
int