core

NULL

ProjectDirtyBlocker

Context manager used to block project setDirty calls.

Qgis

Provides global constants and enumerations for use throughout the application.

QgsAbstractCacheIndex

Abstract base class for cache indices.

QgsAbstractContentCacheBase

A QObject derived base class for QgsAbstractContentCache.

QgsAbstractContentCacheEntry

Base class for entries in a QgsAbstractContentCache.

QgsAbstractFeatureIterator

Internal feature iterator to be implemented within data providers.

QgsAbstractFeatureIteratorFromSourceQgsVectorLayerFeatureSourceBase

Helper template that cares of two things: 1. automatic deletion of source if owned by iterator, 2. notification of open/closed iterator.

QgsAbstractFeatureSource

Base class that can be used for any class that is capable of returning features.

QgsAbstractGeometrySimplifier

Abstract base class for simplifying geometries using a specific algorithm.

QgsAbstractPropertyCollection

Abstract base class for QgsPropertyCollection like objects.

QgsAggregateCalculator

Utility class for calculating aggregates for a field (or expression) over the features from a vector layer.

QgsAlignRasterData

Provides data structures and enums for the align raster tool.

QgsAnimatedIcon

Animated icon is keeping an animation running if there are listeners connected to frameChanged.

QgsApplication

Extends QApplication to provide access to QGIS specific resources such as theme paths, database paths etc.

QgsArchive

Manages zip/unzip operations for an archive.

QgsAttributeTableConfig

A container for configuration of the attribute table.

QgsAuxiliaryStorage

Providing some utility methods to manage auxiliary storage.

QgsBearingUtils

Utilities for calculating bearings and directions.

QgsBlockingProcess

A thread safe class for performing blocking (sync) execution of external processes.

QgsBookmark

Represents a spatial bookmark, with a name, CRS and extent.

QgsBookmarkManager

Manages storage of a set of bookmarks.

QgsBookmarkManagerModel

Implements a model for the contents of QgsBookmarkManager objects.

QgsBookmarkManagerProxyModel

A QSortFilterProxyModel subclass for sorting the entries in a QgsBookmarkManagerModel.

QgsCacheIndexFeatureId

Indexes cached features using feature IDs.

QgsCachedFeatureIterator

Delivers features from the cache.

QgsCachedFeatureWriterIterator

Uses another iterator as backend and writes features to the cache.

QgsCadUtils

Provides routines for CAD editing.

QgsClipper

Trims lines and polygons to within a rectangular region.

QgsColorBrewerColorRamp

Color ramp utilising “Color Brewer” preset color schemes.

QgsColorRamp

Abstract base class for color ramps.

QgsColorRampTransformer

QgsPropertyTransformer subclass for transforming a numeric value into a color from a color ramp.

QgsColorScheme

Abstract base class for color schemes.

QgsColorSchemeRegistry

Registry of color schemes.

QgsColorUtils

Contains utility functions for working with colors.

QgsCommandLineUtils

Utils class for QGIS command line tools.

QgsConditionalLayerStyles

Holds conditional style information for a layer.

QgsConditionalStyle

Conditional styling for a rule.

QgsConnectionRegistry

A registry for saved data provider connections, allowing retrieval of saved connections by name and provider type.

QgsCoordinateFormatter

Contains methods for converting coordinates for display in various formats.

QgsCopyFileTask

Task to copy a file on disk.

QgsCptCityColorRamp

A color ramp from the CPT City collection.

QgsCredentials

Interface for requesting credentials in QGIS in GUI independent way.

QgsCredentialsConsole

Implementation of credentials interface for the console.

QgsCredentialsNone

Default implementation of credentials interface.

QgsCsException

Custom exception class for Coordinate Reference System related exceptions.

QgsCurveTransform

Handles scaling of input values to output values by using a curve created from smoothly joining a number of set control points.

QgsCustomColorScheme

A color scheme which contains custom colors set through QGIS app options dialog.

QgsDartMeasurement

Emits dart measurements for display in CDash reports.

QgsDataDefinedSizeLegend

Object that keeps configuration of appearance of marker symbol’s data-defined size in legend.

QgsDataProviderElevationProperties

Base class for handling elevation related properties for a data provider.

QgsDataProviderTemporalCapabilities

Base class for handling properties relating to a data provider’s temporal capabilities.

QgsDataSourceUri

Stores the component parts of a data source URI (e.g. a Postgres data source).

QgsDatabaseFilterProxyModel

Implements a custom filter and can be used as a proxy for QgsDbTableModel.

QgsDatabaseQueryLog

Handles logging of database queries.

QgsDatabaseQueryLogEntry

Encapsulates a logged database query.

QgsDatabaseSchemaModel

A model containing schemas from a database connection.

QgsDatabaseTableModel

A model containing tables from a database connection.

QgsDateRange

Stores a date range.

QgsDateTimeRange

Stores a range of date times.

QgsDateTimeStatisticalSummary

Calculator for summary statistics and aggregates for a list of datetimes.

QgsDefaultMeshLayerLegend

Default legend implementation for mesh layers.

QgsDefaultPointCloudLayerLegend

Default legend implementation for point cloud layers.

QgsDefaultRasterLayerLegend

Default legend implementation for raster layers.

QgsDefaultValue

Provides a container for managing client side default values for fields.

QgsDefaultVectorLayerLegend

Default legend implementation for vector layers.

QgsDiagramInterpolationSettings

Additional diagram settings for interpolated size rendering.

QgsDiagramLayerSettings

Stores the settings for rendering of all diagrams for a layer.

QgsDiagramRenderer

Evaluates and returns the diagram settings relating to a diagram for a specific feature.

QgsDiagramSettings

Stores the settings for rendering a single diagram.

QgsDistanceArea

A general purpose distance and area calculator, capable of performing ellipsoid based calculations.

QgsDoubleRange

QgsRange which stores a range of double values.

QgsEditError

QgsEditorWidgetSetup

Holder for the widget type and its configuration for a field.

QgsElevationMap

Stores a digital elevation model in a raster image which may get updated as a part of the map layer rendering process.

QgsElevationShadingRenderer

Renders elevation shading on an image with different methods (eye dome lighting, hillshading, …).

QgsElevationUtils

Contains utility methods for working with elevation from layers and projects.

QgsError

A container for error messages.

QgsErrorMessage

Represents a single error message.

QgsException

Defines a QGIS exception class.

QgsExpressionContext

Expression contexts are used to encapsulate the parameters around which a QgsExpression should be evaluated.

QgsExpressionContextGenerator

Abstract interface for generating an expression context.

QgsExpressionContextScope

Single scope for storing variables and functions for use within a QgsExpressionContext.

QgsExpressionContextScopeGenerator

Abstract interface for generating an expression context scope.

QgsExpressionFieldBuffer

Buffers information about expression fields for a vector layer.

QgsFeature

The feature class encapsulates a single feature including its unique ID, geometry and a list of field/values attributes.

QgsFeatureFilterModel

Provides a list of features based on filter conditions.

QgsFeatureFilterProvider

Abstract interface for use by classes that filter the features or attributes of a layer.

QgsFeatureIterator

Wrapper for iterator of features from vector data provider or vector layer.

QgsFeaturePickerModel

Provides a list of features based on filter conditions.

QgsFeaturePickerModelBase

Provides a list of features based on filter conditions.

QgsFeatureRequest

Wraps a request for features to a vector layer (or directly its vector data provider).

QgsFeatureSink

An interface for objects which accept features via addFeature(s) methods.

QgsFeatureSource

An interface for objects which provide features via a getFeatures method.

QgsFeatureStore

A container for features with the same fields and crs.

QgsFeedback

Base class for feedback objects to be used for cancellation of something running in a worker thread.

QgsField

Encapsulate a field in an attribute table or data source.

QgsFieldConstraints

Stores information about constraints which may be present on a field.

QgsFieldFormatter

A field formatter helps to handle and display values for a field.

QgsFieldFormatterContext

A context for field formatter containing information like the project.

QgsFieldFormatterRegistry

A registry which manages classes of QgsFieldFormatter.

QgsFieldModel

A model which displays the list of fields in widgets (optionally associated with a vector layer).

QgsFieldProxyModel

A proxy model to filter the list of fields of a layer.

QgsFields

Container of fields for a vector layer.

QgsFileFilterGenerator

Abstract interface for classes which generate a file filter string.

QgsFileUtils

Contains utilities for working with files.

QgsFontUtils

Contains utility functions for working with fonts.

QgsGenericNumericTransformer

QgsPropertyTransformer subclass for scaling an input numeric value into an output numeric value.

QgsGeometryOptions

Contains options to automatically adjust geometries to constraints on a layer.

QgsGeometryValidator

Validates geometries using the QGIS geometry validation model.

QgsGml

Reads data from a WFS server or alternatively from a GML file.

QgsGmlFeatureClass

Description of feature class in GML.

QgsGmlSchema

Represents a GML schema.

QgsGplColorScheme

A color scheme which stores its colors in a gpl palette file.

QgsGradientColorRamp

Gradient color ramp, which smoothly interpolates between two colors and also supports optional extra color stops.

QgsGradientStop

Represents a color stop within a QgsGradientColorRamp color ramp.

QgsGroupLayer

A map layer which consists of a set of child layers, where all component layers are rendered as a single flattened object during map renders.

QgsHistogram

Calculator for a numeric histogram from a list of values.

QgsHstoreUtils

Provides utility functions for handling hstore-formatted strings.

QgsHtmlUtils

Contains utilities for working with HTML.

QgsIconUtils

Contains utility functions for working with icons.

QgsIdentifyContext

Identify contexts are used to encapsulate the settings to be used to perform an identify action.

QgsImageCache

A cache for images derived from raster files.

QgsIntRange

QgsRange which stores a range of integer values.

QgsInterval

A representation of the interval between two datetime values.

QgsJsonExporter

Handles exporting QgsFeature features to GeoJSON features.

QgsJsonUtils

Helper utilities for working with JSON and GeoJSON conversions.

QgsLabelBlockingRegion

Label blocking region (in map coordinates and CRS).

QgsLayerDefinition

Holds generic methods for loading/exporting QLR files.

QgsLayerNotesUtils

Contains utility functions for working with layer notes.

QgsLayoutChecker

Renders a layout to an image and compares with an expected output.

QgsLegendRenderer

Handles automatic layout and rendering of legends.

QgsLegendSettings

Stores the appearance and layout settings for legend drawing with QgsLegendRenderer.

QgsLegendStyle

Contains detailed styling information relating to how a layout legend should be rendered.

QgsLimitedRandomColorRamp

Constrained random color ramp, which returns random colors based on preset parameters.

QgsLinearlyInterpolatedDiagramRenderer

Alters the size of rendered diagrams using linear scaling.

QgsLocalDefaultSettings

Contains local default settings which should be respected when creating new objects such as QgsProjects.

QgsLocalizedDataPathRegistry

A registry class to hold localized data paths which can be used for basemaps, logos, etc.

QgsLogger

Responsible for printing debug/warning/error messages to the console.

QgsMapClippingRegion

A map clipping region (in map coordinates and CRS).

QgsMapClippingUtils

Utility functions for use when clipping map renders.

QgsMapDecoration

Interface for map decorations.

QgsMapHitTest

Runs a hit test with given map settings.

QgsMapHitTestTask

Executes a QgsMapHitTest in a background thread.

QgsMapLayer

Base class for all map layer types.

QgsMapLayerDependency

Models dependencies with or between map layers.

QgsMapLayerElevationProperties

Base class for storage of map layer elevation properties.

QgsMapLayerFactory

Contains utility functions for creating map layers.

QgsMapLayerLegend

An abstract interface for implementations of legends for one map layer.

QgsMapLayerLegendUtils

Miscellaneous utility functions for handling of map layer legend.

QgsMapLayerModel

A model for display of map layers in widgets.

QgsMapLayerProxyModel

A proxy model which provides an easy to use model to display the list of layers in widgets.

QgsMapLayerRenderer

Base class for utility classes that encapsulate information necessary for rendering of map layers.

QgsMapLayerSelectionProperties

Base class for storage of map layer selection properties.

QgsMapLayerServerProperties

Manages QGIS Server properties for a map layer.

QgsMapLayerStore

A storage object for map layers, in which the layers are owned by the store and have their lifetime bound to the store.

QgsMapLayerStyle

Stores style information (renderer, opacity, labeling, diagrams etc.) applicable to a map layer.

QgsMapLayerStyleManager

Management of styles for use with one map layer.

QgsMapLayerStyleOverride

Restore overridden layer style on destruction.

QgsMapLayerTemporalProperties

Base class for storage of map layer temporal properties.

QgsMapLayerUtils

Contains utility functions for working with map layers.

QgsMapSettings

Contains configuration for rendering maps.

QgsMapSettingsUtils

Utilities for map settings.

QgsMapThemeCollection

Container class that allows storage of map themes consisting of visible map layers and layer styles.

QgsMapToPixel

Perform transforms between map coordinates and device coordinates.

QgsMapToPixelSimplifier

Implementation of a geometry simplifier using the “MapToPixel” algorithm.

QgsMapUnitScale

Struct for storing maximum and minimum scales for measurements in map units.

QgsMargins

Constructs a margins object with all margins set to 0.

QgsMaskIdProvider

Allows the creation of mask ids based on the different label layers and to give a mask id from a label layer.

QgsMaskRenderSettings

Contains settings regarding how masks are calculated and handled during a map render.

QgsMatrix4x4

A simple 4x4 matrix implementation useful for transformation in 3D space.

QgsMessageLog

Interface for logging messages from QGIS in GUI independent way.

QgsMessageLogConsole

Default implementation of message logging interface.

QgsMessageLogNotifyBlocker

Temporarily blocks the application QgsMessageLog (see QgsApplication.messageLog()) from emitting the messageReceived( bool ) signal for the lifetime of the object.

QgsMessageOutput

Interface for showing messages from QGIS in GUI independent way.

QgsMessageOutputConsole

Default implementation of message output interface.

QgsMimeDataUtils

Contains utility functions for working with MIME data.

QgsMultiRenderChecker

Allows checking rendered images against comparison images.

QgsNotSupportedException

Custom exception class which is raised when an operation is not supported.

QgsObjectCustomProperties

Simple key-value store (keys = strings, values = variants) that supports loading/saving to/from XML in verbatim <customproperties> endverbatim element.

QgsOfflineEditing

Handles logic relating to synchronizing online and offline copies of layer data.

QgsOgcUtils

Provides various utility functions for conversion between OGC (Open Geospatial Consortium) standards and QGIS internal representations.

QgsOptionalExpression

An expression with an additional enabled flag.

QgsOptionalQgsExpressionBase

A container for other classes and adds an additional enabled/disabled flag.

QgsOwsConnection

Connections management for OWS connections.

QgsPathResolver

Resolves relative paths into absolute paths and vice versa.

QgsPluginLayer

Base class for plugin layers.

QgsPluginLayerRegistry

A registry of plugin layers types.

QgsPluginLayerType

Responsible for creating plugin specific map layers.

QgsPointLocator

Defines the interface for querying point locations.

QgsPointXY

Represents a 2D point.

QgsPolymorphicRelation

A relation where the referenced (parent) layer is calculated based on fields from the referencing (child) layer.

QgsPostgresStringUtils

Provides functions to handle postgres array-like formatted lists in strings.

QgsPresetSchemeColorRamp

A scheme based color ramp consisting of a list of predefined colors.

QgsProcessingException

Custom exception class for processing related exceptions.

QgsProjectArchive

Allows managing the zip/unzip actions on project files.

QgsProjectColorScheme

A color scheme which contains project specific colors set through project properties dialog.

QgsProperty

A store for object properties.

QgsPropertyCollection

A grouped map of multiple QgsProperty objects, each referenced by an integer key value.

QgsPropertyCollectionStack

An ordered stack of QgsPropertyCollection containers, where collections added later to the stack will take priority over earlier collections.

QgsPropertyDefinition

Definition for a property.

QgsPropertyTransformer

Abstract base class for objects which transform the calculated value of a property.

QgsProviderConnectionException

Custom exception class for provider connection related exceptions.

QgsProviderConnectionModel

A model containing registered connection names for a specific data provider.

QgsProxyFeatureSink

A simple feature sink which proxies feature addition onto another feature sink.

QgsProxyProgressTask

A QgsTask shell which proxies progress reports.

QgsPythonRunner

Utility class for running Python commands from various parts of QGIS.

QgsQueryResultModel

A model for QgsAbstractDatabaseProviderConnection.QueryResult.

QgsRandomColorRamp

A color ramp consisting of random colors, constrained within component ranges.

QgsRangedoubleBase

A template based class for storing ranges (lower to upper values).

QgsRangeintBase

A template based class for storing ranges (lower to upper values).

QgsReadWriteContext

A container for the context for various read/write operations on objects.

QgsReadWriteContextCategoryPopper

Allows entering a context category and takes care of leaving this category on deletion of the class.

QgsReadWriteLocker

A convenience class that simplifies locking and unlocking QReadWriteLocks.

QgsRecentColorScheme

A color scheme which contains the most recently used colors.

QgsRecentStyleHandler

Handles and tracks style items recently used in the QGIS GUI.

QgsRelation

Represents a relationship between two vector layers.

QgsRelationContext

Context for relations.

QgsRelationManager

Manages a set of relations between layers.

QgsRemappingProxyFeatureSink

A QgsFeatureSink which proxies incoming features to a destination feature sink, after applying transformations and field value mappings.

QgsRemappingSinkDefinition

Defines the parameters used to remap features when creating a QgsRemappingProxyFeatureSink.

QgsRenderChecker

Helper class for unit tests that need to write an image and compare it to an expected result or render time.

QgsRenderContext

Contains information about the context of a rendering operation.

QgsRenderedFeatureHandlerInterface

An interface for classes which provide custom handlers for features rendered as part of a map render job.

QgsRenderedItemDetails

Base class for detailed information about a rendered item.

QgsRenderedLayerStatistics

Contains computed statistics for a layer render.

QgsRunProcess

Executes an external program/script.

QgsRuntimeProfiler

Provides a method of recording run time profiles of operations, allowing easy recording of their overall run time.

QgsSQLStatement

Parses SQL statements.

QgsSQLStatementFragment

Parses fragments of SQL statements, such as an expression or where clause.

QgsScaleCalculator

Calculates scale for a given combination of canvas size, map extent, and monitor dpi.

QgsScaleUtils

Contains utility functions for working with map scales.

QgsScopeLogger

Logs the location of the call.

QgsScopedProxyProgressTask

A QgsProxyProgressTask with automatic lifetime.

QgsScopedRuntimeProfile

Scoped object for logging of the runtime for a single operation or group of operations.

QgsScreenProperties

Stores properties relating to a screen.

QgsSelectionContext

Encapsulates the context of a layer selection operation.

QgsServerMetadataUrlProperties

Manages QGIS Server properties for a map layer.

QgsServerWmsDimensionProperties

Manages QGIS Server properties for WMS dimensions.

QgsSettingsException

Custom exception class for settings related exceptions.

QgsSimplifyMethod

Contains information about how to simplify geometries fetched from a QgsFeatureIterator.

QgsSingleCategoryDiagramRenderer

Renders the diagrams for all features with the same settings.

QgsSingleItemModel

A QAbstractItemModel subclass which contains a single read-only item.

QgsSipUtils

Contains utilities for working with SIP Python objects.

QgsSizeScaleTransformer

QgsPropertyTransformer subclass for scaling a value into a size according to various scaling methods.

QgsSldExportContext

Holds SLD export options and other information related to SLD export of a QGIS layer style.

QgsSnappingConfig

Stores configuration of snapping settings for the project.

QgsSnappingUtils

Contains configuration of snapping and can return answers to snapping queries.

QgsSourceCache

A cache for source strings that returns a local file path containing the source content.

QgsSpatialIndex

A spatial index for QgsFeature objects.

QgsSpatialIndexKDBush

A very fast static spatial index for 2D points based on a flat KD-tree.

QgsSpatialIndexKDBushData

A container for data stored inside a QgsSpatialIndexKDBush index.

QgsSqliteUtils

Contains utilities for working with Sqlite data sources.

QgsStackedDiagramRenderer

Renders diagrams using mixed diagram render types.

QgsStatisticalSummary

Calculator for summary statistics for a list of doubles.

QgsStoredExpression

Stored expression containing name, content (expression text) and a category tag.

QgsStoredExpressionManager

Manages stored expressions regarding creation, modification and storing in the project.

QgsStringReplacement

A representation of a single string replacement.

QgsStringReplacementCollection

A collection of string replacements (specified using QgsStringReplacement objects).

QgsStringStatisticalSummary

Calculator for summary statistics and aggregates for a list of strings.

QgsStringUtils

Utility functions for working with strings.

QgsTableCell

Encapsulates the contents and formatting of a single table cell.

QgsTask

Abstract base class for long running background tasks.

QgsTaskManager

Task manager for managing a set of long-running QgsTask tasks.

QgsTaskWithSerialSubTasks

A task that is composed of sub-tasks to be executed in a serial way.

QgsTaskWrapper

QgsTemporalController

A controller base class for temporal objects, contains a signal for notifying updates of the objects temporal range.

QgsTemporalNavigationObject

Implements a temporal controller based on a frame by frame navigation and animation.

QgsTemporalProperty

Base class for temporal property.

QgsTemporalRangeObject

Base class for objects with an associated (optional) temporal range.

QgsTemporalUtils

Contains utility methods for working with temporal layers and projects.

QgsTessellator

Tessellates polygons into triangles.

QgsTestUtils

QgsTileMatrix

Defines a matrix of tiles for a single zoom level: it is defined by its size (width * height) and map extent that it covers.

QgsTileMatrixSet

Defines a set of tile matrices for multiple zoom levels.

QgsTileRange

A range of tiles in a tile matrix.

QgsTileXYZ

Stores coordinates of a tile in a tile matrix set.

QgsTolerance

Provides calculations for tolerance values in map units.

QgsTopologyPreservingSimplifier

Implementation of GeometrySimplifier using the Douglas-Peucker algorithm.

QgsTracer

Utility class that constructs a planar graph from the input vector layers and provides shortest path search for tracing of existing features.

QgsTransaction

Allows creation of a multi-layer database-side transaction.

QgsTransactionGroup

Represents a transaction group.

QgsTranslationContext

Used for the collecting of strings from projects for translation and creation of ts files.

QgsUnitTypes

Helper functions for various unit types.

QgsUnsetAttributeValue

Represents a default, “not-specified” value for a feature attribute.

QgsUserColorScheme

A color scheme which stores its colors in a gpl palette file within the “palettes” subfolder off the user’s QGIS settings folder.

QgsUserProfile

User profile contains information about the user profile folders on the machine.

QgsUserProfileManager

A manager for QGIS user profiles.

QgsVariantUtils

Contains utility functions for working with QVariants and QVariant types.

QgsVector

Represent a 2-dimensional vector.

QgsVector3D

A 3D vector (similar to QVector3D) with the difference that it uses double precision instead of single precision floating point numbers.

QgsVectorFileWriter

A convenience class for writing vector layers to disk based formats (e.g. Shapefiles, GeoPackage).

QgsVectorFileWriterTask

QgsTask task which performs a QgsVectorFileWriter layer saving operation as a background task.

QgsVectorLayerServerProperties

Convenient class for API compatibility.

QgsVectorSimplifyMethod

Contains settings for simplifying geometries fetched from a vector layer.

QgsVirtualLayerDefinition

Manipulates the definition of a virtual layer.

QgsVirtualLayerDefinitionUtils

Utility class for QgsVirtualLayerDefinition.

QgsVirtualLayerTask

Initializes a virtual layer with postpone mode activated and reloads the data in a separate thread.

QgsWeakRelation

Represent a QgsRelation with possibly unresolved layers or unmatched fields.

QgsXmlUtils

Assorted helper methods for reading and writing chunks of XML.

QgsZipUtils

Provides utility functions for working with zip files.

ReadWriteContextEnterCategory

Push a category to the stack

ScopedRuntimeProfileContextManager

Context manager used to profile blocks of code in the QgsApplication.profiler() registry.

check

Constructs QgsAbstractValidityChecks using a decorator.

compareWkt

Compare two WKT strings with some tolerance

edit

metaEnumFromType

Returns the QMetaEnum for an enum type. The enum must have declared using the Q_ENUM macro

metaEnumFromValue

Returns the QMetaEnum for an enum value. The enum must have declared using the Q_ENUM macro

qHash

Hash for QVariant

qgsDoubleNear

Compare two doubles (but allow some difference)

qgsDoubleNearSig

Compare two doubles using specified number of significant digits

qgsDoubleToString

Returns a string representation of a double

qgsFloatNear

Compare two floats (but allow some difference)

qgsNanCompatibleEquals

Compare two doubles, treating nan values as equal

qgsPermissiveToDouble

Converts a string to a double in a permissive way, e.g., allowing for incorrect numbers of digits between thousand separators

qgsPermissiveToInt

Converts a string to an integer in a permissive way, e.g., allowing for incorrect numbers of digits between thousand separators

qgsPermissiveToLongLong

Converts a string to an qlonglong in a permissive way, e.g., allowing for incorrect numbers of digits between thousand separators

qgsRound

Returns a double number, rounded (as close as possible) to the specified number of places.

qgsVariantCompare

Compares two QVariant values.

qgsVariantEqual

Compares two QVariant values and returns whether they are equal, two NULL values are always treated as equal and 0 is not treated as equal with NULL

qgsVariantGreaterThan

Compares two QVariant values and returns whether the first is greater than the second. Useful for sorting lists of variants, correctly handling sorting of the various QVariant data types (such as strings, numeric values, dates and times)

qgsVariantLessThan

Compares two QVariant values and returns whether the first is less than the second. Useful for sorting lists of variants, correctly handling sorting of the various QVariant data types (such as strings, numeric values, dates and times)

qgsVsiPrefix

Returns a the vsi prefix which corresponds to a file path, or an empty string if the path is not associated with a vsi prefix.

qgsfunction

Decorator function used to define a user expression function.

register_function

Register a Python function to be used as a expression function.

stringToSymbolLayerReferenceList

Utility function to parse a string originated from symbolLayerReferenceListToString into a QgsSymbolLayerReferenceList

symbolLayerReferenceListToString

Utility function to turn a QgsSymbolLayerReferenceList into a string

3D

Qgs3DRendererAbstractMetadata

Base metadata class for 3D renderers.

Qgs3DRendererRegistry

A registry for available 3D renderers.

Qgs3DSymbolAbstractMetadata

Stores metadata about one 3D symbol class.

Qgs3DSymbolRegistry

Registry of available 3D symbol classes.

QgsAbstract3DRenderer

Base class for all renderers that participate in 3D views.

QgsAbstract3DSymbol

Abstract base class for 3D symbols that are used by VectorLayer3DRenderer objects.

QgsAbstractPointCloud3DRenderer

Base class for point cloud 3D renderers.

Annotations and Annotation Layers

QgsAbstractAnnotationItemEditOperation

Abstract base class for annotation item edit operations.

QgsAnnotation

Abstract base class for annotation items which are drawn over a map.

QgsAnnotationItem

Abstract base class for annotation items which are drawn with QgsAnnotationLayers.

QgsAnnotationItemAbstractMetadata

Stores metadata about one annotation item class.

QgsAnnotationItemEditContext

Encapsulates the context for an annotation item edit operation.

QgsAnnotationItemEditOperationAddNode

Annotation item edit operation consisting of adding a node.

QgsAnnotationItemEditOperationDeleteNode

Annotation item edit operation consisting of deleting a node.

QgsAnnotationItemEditOperationMoveNode

Annotation item edit operation consisting of moving a node.

QgsAnnotationItemEditOperationTransientResults

Encapsulates the transient results of an in-progress annotation edit operation.

QgsAnnotationItemEditOperationTranslateItem

Annotation item edit operation consisting of translating (moving) an item.

QgsAnnotationItemNode

Contains information about a node used for editing an annotation item.

QgsAnnotationItemRegistry

Registry of available annotation item types.

QgsAnnotationLayer

Represents a map layer containing a set of georeferenced annotations, e.g. markers, lines, polygons or text items.

QgsAnnotationLineItem

An annotation item which renders a line symbol along a line geometry.

QgsAnnotationLineTextItem

An annotation item which renders text along a line geometry.

QgsAnnotationManager

Manages storage of a set of QgsAnnotation annotation objects.

QgsAnnotationMarkerItem

An annotation item which renders a marker symbol at a point location.

QgsAnnotationPictureItem

An annotation item which renders a picture.

QgsAnnotationPointTextItem

An annotation item which renders a text string at a point location.

QgsAnnotationPolygonItem

An annotation item which renders a fill symbol for a polygon geometry.

QgsAnnotationRectItem

Abstract base class for annotation items which render annotations in a rectangular shape.

QgsAnnotationRectangleTextItem

An annotation item which renders paragraphs of text within a rectangle.

QgsHtmlAnnotation

An annotation item that embeds HTML content.

QgsRenderedAnnotationItemDetails

Contains information about a rendered annotation item.

QgsSvgAnnotation

An annotation which renders the contents of an SVG file.

QgsTextAnnotation

An annotation item that displays formatted text from a QTextDocument document.

Attribute Form Configuration

QgsAttributeEditorAction

This element will load a layer action onto the form.

QgsAttributeEditorContainer

A container for attribute editors, used to group them visually in the attribute form if it is set to the drag and drop designer.

QgsAttributeEditorElement

An abstract base class for any elements of a drag and drop form.

QgsAttributeEditorField

This element will load a field’s widget onto the form.

QgsAttributeEditorHtmlElement

An attribute editor widget that will represent arbitrary HTML code.

QgsAttributeEditorQmlElement

An attribute editor widget that will represent arbitrary QML code.

QgsAttributeEditorRelation

This element will load a relation editor onto the form.

QgsAttributeEditorSpacerElement

An attribute editor widget that will represent a spacer.

QgsAttributeEditorTextElement

An attribute editor widget that will represent arbitrary text code.

QgsEditFormConfig

Contains configuration settings for an editor form.

Authentication Framework

QgsAuthCertUtils

Utilities for working with certificates and keys.

QgsAuthConfigSslServer

Configuration container for SSL server connection exceptions or overrides.

QgsAuthConfigurationStorage

Abstract class that defines the interface for all authentication configuration storage implementations.

QgsAuthConfigurationStorageDb

QSqlDatabase based implementation of QgsAuthConfigurationStorage.

QgsAuthConfigurationStorageRegistry

Registry for authentication configuration storages.

QgsAuthManager

Singleton which offers an interface to manage the authentication configuration database and to utilize configurations through various authentication method plugins.

QgsAuthMethod

Abstract base class for authentication method plugins.

QgsAuthMethodConfig

Configuration storage class for authentication method configurations.

QgsPkiBundle

Storage set for PKI bundle: SSL certificate, key, optional CA cert chain.

QgsPkiConfigBundle

Storage set for constructed SSL certificate, key, associated with an authentication config.

Browser

QgsBrowserModel

A model for showing available data sources and other items in a structured tree.

QgsBrowserProxyModel

A QSortFilterProxyModel subclass for filtering and sorting browser model items.

QgsConnectionsRootItem

A browser item that represents a root group of connections from a single data provider.

QgsDataCollectionItem

A browser item for collections of data.

QgsDataItem

Base class for all items in the model.

QgsDataItemProvider

Interface for providers that add custom data items to the browser tree.

QgsDataItemProviderRegistry

A registry for data item providers that may add items to the browser tree.

QgsDatabaseSchemaItem

A browser item that represents a database schema item.

QgsDirectoryItem

A browser item for directories: contains subdirectories and layers.

QgsDirectoryParamWidget

Browser parameter widget implementation for directory items.

QgsErrorItem

A browser item that can be used to report problems (e.g. network error).

QgsFavoritesItem

A browser item which contains various Favorites directories.

QgsFieldDomainItem

A browser item representing a field domain.

QgsFieldDomainsItem

Contains a collection of field domain items.

QgsFieldItem

A data item representing a single field from a layer.

QgsFieldsItem

A browser item which contains a collection of field items.

QgsLayerItem

A browser item that represents a layer that can be opened with one of the providers.

QgsProjectItem

Data item that can be used to represent QGIS projects.

QgsRelationshipItem

A browser item representing a relationship.

QgsRelationshipsItem

Contains a collection of relationship items.

QgsZipItem

A browser item for zip (archive) files.

Classification Methods

QgsClassificationCustom

A dummy implementation class method which does not compute any breaks.

QgsClassificationEqualInterval

A classification method which uses equal width intervals.

QgsClassificationFixedInterval

Implementation of a fixed interval classification.

QgsClassificationJenks

A classification method for natural breaks, based on Jenks method.

QgsClassificationLogarithmic

Implementation of a logarithmic scale method for classification.

QgsClassificationMethod

An abstract class for implementations of classification methods.

QgsClassificationMethodRegistry

Manages all known classification methods.

QgsClassificationPrettyBreaks

A classification method which applies pretty breaks to data.

QgsClassificationQuantile

A classification method which creates classes based on quantiles.

QgsClassificationRange

Contains the information about a classification range.

QgsClassificationStandardDeviation

A classification method which classifies based on standard deviation of values.

Coordinate Systems and Transformations

QgsCelestialBody

Contains information about a celestial body.

QgsCoordinateReferenceSystem

Represents a coordinate reference system (CRS).

QgsCoordinateReferenceSystemRegistry

A registry for known coordinate reference system (CRS) definitions, including any user-defined CRSes.

QgsCoordinateReferenceSystemUtils

Utility functions for working with QgsCoordinateReferenceSystem objects.

QgsCoordinateTransform

Handles coordinate transforms between two coordinate systems.

QgsCoordinateTransformContext

Contains information about the context in which a coordinate transform is executed.

QgsDatumEnsemble

Contains information about a datum ensemble.

QgsDatumEnsembleMember

Contains information about a member of a datum ensemble.

QgsDatumTransform

Contains methods and classes relating the datum transformations.

QgsEllipsoidUtils

Contains utility functions for working with ellipsoids and querying the ellipsoid database.

QgsProjOperation

Contains information about a PROJ operation.

QgsProjUtils

Utility functions for working with the proj library.

QgsProjectionFactors

Contains various cartographic properties, such as scale factors, angular distortion and meridian convergence.

DXF Exports

QgsDxfExport

Exports QGIS layers to the DXF format.

Data Providers

QgsAbstractDatabaseProviderConnection

Provides common functionality for database based connections.

QgsAbstractDbTableModel

Pure virtual model class for results in a database source widget selector.

QgsAbstractProviderConnection

An interface for data provider connections.

QgsDataProvider

Abstract base class for spatial data provider implementations.

QgsMeshDriverMetadata

Holds metadata about mesh drivers.

QgsProviderRegistry

A registry / canonical manager of data providers.

QgsProviderSqlQueryBuilder

Provides an interface for provider-specific creation of SQL queries.

QgsProviderSublayerDetails

Contains details about a sub layer available from a dataset.

QgsProviderSublayerModel

A model for representing the sublayers present in a URI.

QgsProviderSublayerProxyModel

A QSortFilterProxyModel for filtering and sorting a QgsProviderSublayerModel.

QgsProviderSublayerTask

A QgsTask which retrieves sublayer details for a URI.

QgsProviderUtils

Contains utility functions for working with data providers.

Data Providers - ArcGIS

QgsArcGisPortalUtils

Utility functions for working with ArcGIS REST services.

QgsArcGisRestContext

Contains the context of a ArcGIS REST service operation.

QgsArcGisRestUtils

Utility functions for working with ArcGIS REST services.

Data Providers - Memory

QgsMemoryProviderUtils

Utility functions for use with the memory vector data provider.

Data Providers - OGC Sensorthings

QgsSensorThingsExpansionDefinition

Encapsulates information about how relationships in a SensorThings API service should be expanded.

QgsSensorThingsUtils

Utility functions for working with OGC SensorThings API services.

Diagrams and Charts

QgsDiagram

Base class for all diagram types.

QgsHistogramDiagram

A histogram style diagram.

QgsPieDiagram

A pie chart diagram.

QgsStackedBarDiagram

A stacked bar chart diagram.

QgsStackedDiagram

A diagram composed of several subdiagrams, located side by side.

QgsTextDiagram

A text based diagram.

Elevation Handling

QgsAbstractProfileGenerator

Abstract base class for objects which generate elevation profiles.

QgsAbstractProfileResults

Abstract base class for storage of elevation profiles.

QgsAbstractProfileSource

Interface for classes which can generate elevation profiles.

QgsAbstractTerrainProvider

Abstract base class for terrain providers.

QgsFlatTerrainProvider

A terrain provider where the terrain is a simple flat surface.

QgsMeshTerrainProvider

A terrain provider that uses the Z values of a mesh layer to build a terrain surface.

QgsProfileExporter

Handles exports of elevation profiles in various formats.

QgsProfileExporterTask

Handles exports of elevation profiles in various formats in a background task.

QgsProfileGenerationContext

Encapsulates the context in which an elevation profile is to be generated.

QgsProfileIdentifyContext

Encapsulates the context of identifying profile results.

QgsProfileIdentifyResults

Stores identify results generated by a QgsAbstractProfileResults object.

QgsProfilePlotRenderer

Generates and renders elevation profile plots.

QgsProfilePoint

Encapsulates a point on a distance-elevation profile.

QgsProfileRenderContext

Abstract base class for storage of elevation profiles.

QgsProfileRequest

Encapsulates properties and constraints relating to fetching elevation profiles from different sources.

QgsProfileSnapContext

Encapsulates the context of snapping a profile point.

QgsProfileSnapResult

Encapsulates results of snapping a profile point.

QgsProfileSourceRegistry

Registry of profile sources used by QgsProfilePlotRenderer.

QgsRasterDemTerrainProvider

A terrain provider where the terrain source is a raster DEM layer.

Expression Engine

QgsExpression

Handles parsing and evaluation of expressions (formerly called “search strings”).

QgsExpressionContextUtils

Contains utilities for working with QgsExpressionContext objects, including methods for creating scopes for specific uses (e.g., project scopes, layer scopes).

QgsExpressionFunction

An abstract base class for defining QgsExpression functions.

QgsExpressionNode

Abstract base class for all nodes that can appear in an expression.

QgsExpressionNodeBetweenOperator

SQL-like BETWEEN and NOT BETWEEN predicates.

QgsExpressionNodeBinaryOperator

A binary expression operator, which operates on two values.

QgsExpressionNodeColumnRef

An expression node which takes its value from a feature’s field.

QgsExpressionNodeCondition

An expression node for CASE WHEN clauses.

QgsExpressionNodeFunction

An expression node for expression functions.

QgsExpressionNodeInOperator

An expression node for value IN or NOT IN clauses.

QgsExpressionNodeIndexOperator

An indexing expression operator, which allows use of square brackets [] to reference map and array items.

QgsExpressionNodeLiteral

An expression node for literal values.

QgsExpressionNodeUnaryOperator

A unary node is either negative as in boolean (not) or as in numbers (minus).

QgsScopedExpressionFunction

Expression function for use within a QgsExpressionContextScope.

External Storage

QgsExternalStorage

Abstract interface for external storage - to be implemented by various backends and registered in QgsExternalStorageRegistry.

QgsExternalStorageContent

Base class for QgsExternalStorage stored and fetched content.

QgsExternalStorageFetchedContent

Abstract base class for QgsExternalStorage fetched content.

QgsExternalStorageRegistry

Registry of external storage backends used by QgsExternalResourceWidget.

QgsExternalStorageStoredContent

Abstract base class for QgsExternalStorage stored content.

Field Value Formating

QgsCheckBoxFieldFormatter

Field formatter for a checkbox field.

QgsDateTimeFieldFormatter

Field formatter for a date time field.

QgsFallbackFieldFormatter

A default fallback field formatter in case no specialized field formatter is defined.

QgsKeyValueFieldFormatter

Field formatter for a key value field.

QgsListFieldFormatter

Field formatter for a list field.

QgsRangeFieldFormatter

Field formatter for a range (double) field with precision and locale.

QgsRelationReferenceFieldFormatter

Field formatter for a relation reference field.

QgsValueMapFieldFormatter

Field formatter for a ValueMap field.

QgsValueRelationFieldFormatter

Field formatter for a value relation field.

GPS and GNSS

QgsAbstractBabelFormat

Abstract base class for babel GPS formats.

QgsBabelFormatRegistry

A registry for QgsAbstractBabelFormat GPSBabel formats.

QgsBabelGpsDeviceFormat

A babel format capable of interacting directly with a GPS device.

QgsBabelSimpleImportFormat

A babel format capable of converting input files to GPX files.

QgsGpsConnection

Abstract base class for connections to a GPS device.

QgsGpsConnectionRegistry

Registers existing GPS connections such that the information is available to all classes and plugins.

QgsGpsDetector

Detects connected GPS device ports.

QgsGpsInformation

Encapsulates information relating to a GPS position fix.

QgsGpsLogger

Base class for objects which log incoming GPS data.

QgsGpsdConnection

Evaluates NMEA sentences coming from gpsd.

QgsNmeaConnection

Evaluates NMEA sentences coming from a GPS device.

QgsQtLocationConnection

A GPS connection subclass based on the Qt Location libraries.

QgsSatelliteInfo

Encapsulates information relating to a GPS satellite.

QgsVectorLayerGpsLogger

Handles logging of incoming GPS data to a vector layer.

Geocoding

QgsAbstractGeocoderLocatorFilter

An abstract base class which implements a locator filter populated from a QgsGeocoderInterface.

QgsGeocoderContext

Encapsulates the context of a geocoding operation.

QgsGeocoderInterface

Interface for geocoders.

QgsGeocoderResult

Represents a matching result from a geocoder search.

QgsGoogleMapsGeocoder

A geocoder which uses the Google Map geocoding API to retrieve results.

QgsNominatimGeocoder

A geocoder which uses the Nominatim geocoding API to retrieve results.

Geometry

QgsAbstractGeometry

Abstract base class for all geometries.

QgsAbstractGeometryTransformer

An abstract base class for classes which transform geometries by transforming input points to output points.

QgsBox3D

A 3-dimensional box composed of x, y, z coordinates.

QgsCircle

Circle geometry type.

QgsCircularString

Circular string geometry type.

QgsCompoundCurve

Compound curve geometry type.

QgsConstWkbPtr

A const WKB pointer.

QgsCurve

Abstract base class for curved geometry type.

QgsCurvePolygon

Curve polygon geometry type.

QgsEllipse

Ellipse geometry type.

QgsGeometry

A geometry is the spatial representation of a feature.

QgsGeometryCollection

Geometry collection.

QgsGeometryConstPartIterator

Java-style iterator for const traversal of parts of a geometry.

QgsGeometryEngine

A geometry engine is a low-level representation of a QgsAbstractGeometry object, optimised for use with external geometry libraries such as GEOS.

QgsGeometryParameters

Encapsulates parameters under which a geometry operation is performed.

QgsGeometryPartIterator

Java-style iterator for traversal of parts of a geometry.

QgsGeometryUtils

Contains various geometry utility functions.

QgsGeometryUtilsBase

Convenience functions for geometry utils.

QgsGeos

Does vector analysis using the GEOS library and handles import, export, and exception handling.

QgsLineSegment2D

Represents a single 2D line segment, consisting of a 2D start and end vertex only.

QgsLineString

Line string geometry type, with support for z-dimension and m-values.

QgsMultiCurve

Multi curve geometry collection.

QgsMultiLineString

Multi line string geometry collection.

QgsMultiPoint

Multi point geometry collection.

QgsMultiPolygon

Multi polygon geometry collection.

QgsMultiSurface

Multi surface geometry collection.

QgsOrientedBox3D

Represents a oriented (rotated) box in 3 dimensions.

QgsPoint

Point geometry type, with support for z-dimension and m-values.

QgsPolygon

Polygon geometry type.

QgsPolyhedralSurface

Polyhedral surface geometry type.

QgsQuadrilateral

Quadrilateral geometry type.

QgsRay3D

A representation of a ray in 3D.

QgsRectangle

A rectangle specified with double values.

QgsReferencedGeometry

A QgsGeometry with associated coordinate reference system.

QgsReferencedGeometryBase

A base class for geometry primitives which are stored with an associated reference system.

QgsReferencedPointXY

A QgsPointXY with associated coordinate reference system.

QgsReferencedRectangle

A QgsRectangle with associated coordinate reference system.

QgsRegularPolygon

Regular Polygon geometry type.

QgsSphere

A spherical geometry object.

QgsSurface

Surface geometry type.

QgsTriangle

Triangle geometry type.

QgsTriangulatedSurface

Triangulated surface geometry type.

QgsVertexId

Utility class for identifying a unique vertex within a geometry.

QgsVertexIterator

Java-style iterator for traversal of vertices of a geometry.

QgsWkbPtr

WKB pointer handler.

QgsWkbTypes

Handles storage of information regarding WKB types and their properties.

Label Callouts

QgsBalloonCallout

A cartoon talking bubble callout style.

QgsCallout

Abstract base class for callout renderers.

QgsCalloutAbstractMetadata

Stores metadata about one callout renderer class.

QgsCalloutMetadata

Convenience metadata class that uses static functions to create callouts and their widgets.

QgsCalloutRegistry

Registry of available callout classes.

QgsCurvedLineCallout

Draws curved lines as callouts.

QgsManhattanLineCallout

Draws straight (right angled) lines as callouts.

QgsSimpleLineCallout

A simple direct line callout style.

Labeling

QgsAbstractVectorLayerLabeling

Abstract base class - its implementations define different approaches to the labeling of a vector layer.

QgsCalloutPosition

Represents the calculated placement of a map label callout line.

QgsLabelCandidate

Represents a label candidate.

QgsLabelLineSettings

Contains settings related to how the label engine places and formats labels for line features (or polygon features which are labeled in a “perimeter” style mode).

QgsLabelObstacleSettings

Contains settings related to how the label engine treats features as obstacles.

QgsLabelPlacementSettings

Contains general settings related to how labels are placed.

QgsLabelPointSettings

Contains settings related to how the label engine places and formats labels for point-like features.

QgsLabelPosition

Represents the calculated placement of a map label.

QgsLabelSearchTree

Queries the labeling structure at a given point.

QgsLabelThinningSettings

Contains settings related to how the label engine removes candidate label positions and reduces the number of displayed labels.

QgsLabeling

Contains constants and enums relating to labeling.

QgsLabelingEngineSettings

Stores global configuration for labeling engine.

QgsLabelingResults

Stores computed placement from labeling engine.

QgsPalLabeling

PAL labeling utilities.

QgsPalLayerSettings

Contains settings for how a map layer will be labeled.

QgsRuleBasedLabeling

Rule based labeling for a vector layer.

QgsVectorLayerSimpleLabeling

Basic implementation of the labeling interface.

Labeling - Advanced Rules

QgsAbstractLabelingEngineRule

Abstract base class for labeling engine rules.

QgsAbstractLabelingEngineRuleDistanceFromFeature

Base class for labeling engine rules which prevent labels being placed too close or too far from features from a different layer.

QgsLabelingEngineContext

Encapsulates the context for a labeling engine run.

QgsLabelingEngineRuleAvoidLabelOverlapWithFeature

A labeling engine rule which prevents labels being placed overlapping features from a different layer.

QgsLabelingEngineRuleMaximumDistanceLabelToFeature

A labeling engine rule which prevents labels being placed too far from features from a different layer.

QgsLabelingEngineRuleMinimumDistanceLabelToFeature

A labeling engine rule which prevents labels being placed too close to features from a different layer.

QgsLabelingEngineRuleMinimumDistanceLabelToLabel

A labeling engine rule which prevents labels being placed too close to labels from a different layer.

QgsLabelingEngineRuleRegistry

A registry for labeling engine rules.

Layer Tree and Legends

QgsColorRampLegendNode

A legend node which renders a color ramp.

QgsColorRampLegendNodeSettings

Settings for a color ramp legend node.

QgsDataDefinedSizeLegendNode

A legend node with a marker symbol.

QgsImageLegendNode

Implementation of legend node interface for displaying arbitrary raster images.

QgsLayerTree

Namespace with helper functions for layer tree operations.

QgsLayerTreeFilterProxyModel

A sort filter proxy model to easily reproduce the legend/layer tree in a tree view.

QgsLayerTreeFilterSettings

Contains settings relating to filtering the contents of QgsLayerTreeModel and views.

QgsLayerTreeGroup

Layer tree group node serves as a container for layers and further groups.

QgsLayerTreeLayer

Layer tree node points to a map layer.

QgsLayerTreeModel

A model representing the layer tree, including layers and groups of layers.

QgsLayerTreeModelLegendNode

An abstract interface for legend items returned from QgsMapLayerLegend implementation.

QgsLayerTreeNode

Base class for nodes in a layer tree.

QgsLayerTreeRegistryBridge

Listens to layer changes from a QgsProject and applies changes to a QgsLayerTree.

QgsLayerTreeUtils

Assorted functions for dealing with layer trees.

QgsLegendPatchShape

Represents a patch shape for use in map legends.

QgsRasterSymbolLegendNode

Implementation of legend node interface for displaying raster legend entries.

QgsSimpleLegendNode

Implementation of legend node interface for displaying arbitrary labels with icons.

QgsSymbolLegendNode

Implementation of legend node interface for displaying preview of vector symbols and their labels and allowing interaction with the symbol / renderer.

QgsVectorLabelLegendNode

A legend node for a labeling text symbol.

QgsWmsLegendNode

Implementation of legend node interface for displaying WMS legend entries.

Locator Bar

QgsLocator

Handles the management of QgsLocatorFilter objects and async collection of search results from them.

QgsLocatorAutomaticModel

A QgsLocatorModel which is associated directly with a QgsLocator, and is automatically populated with results from locator searches.

QgsLocatorContext

Encapsulates the properties relating to the context of a locator search.

QgsLocatorFilter

Abstract base class for filters which collect locator results.

QgsLocatorModel

An abstract list model for displaying the results of locator searches.

QgsLocatorModelBridge

Provides the core functionality to be used in a locator widget.

QgsLocatorProxyModel

A sort proxy model for QgsLocatorModel, which automatically sorts results by precedence.

QgsLocatorResult

Encapsulates properties of an individual matching result found by a QgsLocatorFilter.

Map Actions

QgsAction

Utility class that encapsulates an action based on vector attributes.

QgsActionManager

Storage and management of actions associated with a layer.

QgsActionScope

An action scope defines a “place” for an action to be shown and may add additional expression variables.

QgsActionScopeRegistry

The action scope registry is an application wide registry that contains a list of available action scopes.

Map Rendering

QgsMapRendererAbstractCustomPainterJob

Abstract base class for map renderer jobs which use custom painters.

QgsMapRendererCache

Responsible for keeping a cache of rendered images resulting from a map rendering job.

QgsMapRendererCustomPainterJob

Job implementation that renders everything sequentially using a custom painter.

QgsMapRendererJob

Abstract base class for map rendering implementations.

QgsMapRendererParallelJob

Job implementation that renders all layers in parallel.

QgsMapRendererQImageJob

Intermediate base class adding functionality that allows a client to query the rendered image.

QgsMapRendererSequentialJob

Job implementation that renders everything sequentially in one thread.

QgsMapRendererTask

QgsTask task which draws a map to an image file or a painter as a background task.

QgsRenderedItemResults

Stores collated details of rendered items during a map rendering operation.

Mesh Layers

QgsAbstractMeshLayerLabeling

Abstract base class - its implementations define different approaches to the labeling of a mesh layer.

QgsMesh

Mesh - vertices, edges and faces

QgsMesh3DAveragingMethod

Abstract class for interpolating 3d stacked mesh data to 2d data.

QgsMesh3DDataBlock

A block of 3d stacked mesh data related N faces defined on base mesh frame.

QgsMeshAdvancedEditing

Abstract class that can be derived to implement advanced editing on mesh.

QgsMeshCalculator

Performs mesh layer calculations.

QgsMeshDataBlock

A block of integers/doubles from a mesh dataset.

QgsMeshDataProvider

Base class for providing data for QgsMeshLayer.

QgsMeshDataProviderTemporalCapabilities

Handles properties relating to a mesh data provider’s temporal capabilities.

QgsMeshDataSourceInterface

Interface for mesh data sources.

QgsMeshDataset

Abstract class that represents a mesh dataset.

QgsMeshDatasetGroup

Abstract class that represents a dataset group.

QgsMeshDatasetGroupMetadata

A collection of dataset group metadata such as whether the data is vector or scalar, name.

QgsMeshDatasetGroupTreeItem

Tree item for display of the mesh dataset groups.

QgsMeshDatasetIndex

An index that identifies the dataset group (e.g. wind speed) and a dataset in this group (e.g. magnitude of wind speed in particular time).

QgsMeshDatasetMetadata

Represents mesh dataset metadata, such as whether the data is valid or the associated time.

QgsMeshDatasetSourceInterface

Interface for mesh datasets and dataset groups.

QgsMeshDatasetValue

Represents a single mesh dataset value.

QgsMeshEditForceByLine

Forces mesh editing based on a line.

QgsMeshEditForceByPolylines

Derived from QgsMeshEditForceByLine that forces mesh based on polyline.

QgsMeshEditRefineFaces

Performs refinement of faces of a mesh.

QgsMeshEditingError

Represents an error which occurred during mesh editing.

QgsMeshEditor

Handles edit operations on a mesh layer.

QgsMeshElevationAveragingMethod

Elevation averaging method averages the values based on range defined absolute value to the model’s datum.

QgsMeshLayer

Represents a mesh layer supporting display of data on structured or unstructured meshes.

QgsMeshLayerElevationProperties

Mesh layer specific subclass of QgsMapLayerElevationProperties.

QgsMeshLayerSimpleLabeling

Basic implementation of the labeling interface for mesh layers.

QgsMeshLayerTemporalProperties

Implementation of map layer temporal properties for mesh layers.

QgsMeshMultiLevelsAveragingMethod

Multi level averaging method specifies limits of vertical layers from the top layer down or reversed.

QgsMeshRelativeHeightAveragingMethod

Relative height averaging method which averages the values based on range defined relative to bed elevation or surface.

QgsMeshRendererMeshSettings

Represents a mesh renderer settings for mesh objects.

QgsMeshRendererScalarSettings

Represents a mesh renderer settings for scalar datasets.

QgsMeshRendererSettings

Represents all mesh renderer settings.

QgsMeshRendererVectorArrowSettings

Represents a mesh renderer settings for vector datasets displayed with arrows.

QgsMeshRendererVectorSettings

Represents a renderer settings for vector datasets.

QgsMeshRendererVectorStreamlineSettings

Represents a streamline renderer settings for vector datasets displayed by streamlines.

QgsMeshRendererVectorTracesSettings

Represents a trace renderer settings for vector datasets displayed by particle traces.

QgsMeshRendererVectorWindBarbSettings

Represents a mesh renderer settings for vector datasets displayed with wind barbs.

QgsMeshSigmaAveragingMethod

Sigma averages over the values between 0 (bed level) and 1 (surface).

QgsMeshSpatialIndex

A spatial index for QgsMeshFace or QgsMeshEdge objects.

QgsMeshTimeSettings

Represents a mesh time settings for mesh datasets.

QgsMeshTransformVerticesByExpression

Transforms vertices of a mesh by expression.

QgsMeshUtils

Provides utility functions for working with mesh data.

QgsMeshVectorTraceAnimationGenerator

A wrapper for QgsMeshParticuleTracesField used to render the particles.

QgsTopologicalMesh

Wraps a QgsMesh to ensure the consistency of the mesh during editing and helps to access elements from other elements.

Metadata Handling

QgsAbstractLayerMetadataProvider

Layer metadata provider backend interface.

QgsAbstractMetadataBase

An abstract base class for metadata stores.

QgsAbstractMetadataBaseValidator

Abstract base class for metadata validators.

QgsLayerMetadata

A structured metadata store for a map layer.

QgsLayerMetadataFormatter

Formats layer metadata into HTML.

QgsLayerMetadataProviderRegistry

Registry of layer metadata provider backends.

QgsLayerMetadataProviderResult

Result record of layer metadata provider search.

QgsLayerMetadataSearchResults

Container of result records from a layer metadata search.

QgsMetadataSearchContext

Metadata search context

QgsMetadataUtils

Contains utility functions for working with metadata.

QgsNativeMetadataBaseValidator

A validator for the native base QGIS metadata schema definition.

QgsNativeMetadataValidator

A validator for the native QGIS layer metadata schema definition.

QgsNativeProjectMetadataValidator

A validator for the native QGIS project metadata schema definition.

QgsProjectMetadata

A structured metadata store for a project.

Network Access

QgsBlockingNetworkRequest

A thread safe class for performing blocking (sync) network requests, with full support for QGIS proxy and authentication settings.

QgsFetchedContent

Holds information about fetched network content.

QgsFileDownloader

A utility class for downloading files.

QgsHttpHeaders

Implements simple HTTP header management.

QgsNetworkAccessManager

QNetworkAccessManager with additional QGIS specific logic.

QgsNetworkContentFetcher

HTTP network content fetcher.

QgsNetworkContentFetcherRegistry

Registry for temporary fetched files.

QgsNetworkContentFetcherTask

Handles HTTP network content fetching in a background task.

QgsNetworkReplyContent

Encapsulates a network reply within a container which is inexpensive to copy and safe to pass between threads.

QgsNetworkRequestParameters

Encapsulates parameters and properties of a network request.

QgsNewsFeedModel

A model for published QGIS news feeds.

QgsNewsFeedParser

Parser for published QGIS news feeds.

QgsNewsFeedProxyModel

A proxy model for use with QgsNewsFeedModel.

Numeric Formats

QgsBasicNumericFormat

A numeric formater which returns a simple text representation of a value.

QgsBearingNumericFormat

A numeric formater which returns a text representation of a direction/bearing.

QgsCurrencyNumericFormat

A numeric formater which returns a text representation of a currency value.

QgsExpressionBasedNumericFormat

A numeric formatter which uses a QgsExpression to calculate the text representation of a value.

QgsFallbackNumericFormat

A basic numeric formater which returns a simple text representation of a value.

QgsFractionNumericFormat

A numeric formater which returns a vulgar fractional representation of a decimal value (e.g. “1/2” instead of 0.5).

QgsGeographicCoordinateNumericFormat

A numeric formater which returns a text representation of a geographic coordinate (latitude or longitude).

QgsNumericFormat

Abstract base class for numeric formatters, which allow for formatting a numeric value for display.

QgsNumericFormatContext

A context for numeric formats.

QgsNumericFormatRegistry

A registry which manages classes of QgsNumericFormat.

QgsPercentageNumericFormat

A numeric formater which returns a text representation of a percentage value.

QgsScientificNumericFormat

A numeric formater which returns a scientific notation representation of a value.

PDF Rendering

QgsPdfRenderer

Utility class for rendering PDF documents.

Paint Effects

QgsBlurEffect

A paint effect which blurs a source picture, using a number of different blur methods.

QgsColorEffect

A paint effect which alters the colors (e.g., brightness, contrast) in a source picture.

QgsDrawSourceEffect

A paint effect which draws the source picture with minor or no alterations.

QgsDropShadowEffect

A paint effect which draws an offset and optionally blurred drop shadow.

QgsEffectPainter

Manages painter saving and restoring required for effect drawing.

QgsEffectStack

A paint effect which consists of a stack of other chained paint effects.

QgsGlowEffect

Base class for paint effects which draw a glow inside or outside a picture.

QgsImageOperation

Contains operations and filters which apply to QImages.

QgsInnerGlowEffect

A paint effect which draws a glow within a picture.

QgsInnerShadowEffect

A paint effect which draws an offset and optionally blurred drop shadow within a picture.

QgsOuterGlowEffect

A paint effect which draws a glow outside of a picture.

QgsPaintEffect

Base class for visual effects which can be applied to QPicture drawings.

QgsPaintEffectAbstractMetadata

Stores metadata about a paint effect class.

QgsPaintEffectRegistry

Registry of available paint effects.

QgsShadowEffect

Base class for paint effects which render offset, blurred shadows.

QgsTransformEffect

A paint effect which applies transformations (such as move, scale and rotate) to a picture.

Painting Operations

QgsGeometryPaintDevice

A paint device which converts everything renderer to a QgsGeometry representation of the rendered shapes.

QgsMaskPaintDevice

Mask painter device that can be used to register everything painted into a QPainterPath used later as clip path.

QgsNullPaintDevice

Null painter device that can be used for map renderer jobs which use custom painters.

QgsPaintEngineHack

Hack to workaround Qt #5114 by disabling PatternTransform.

QgsPainting

Contains miscellaneous painting utility functions.

Plot and Graph Rendering

Qgs2DPlot

Base class for 2-dimensional plot/chart/graphs.

QgsPlot

Base class for plot/chart/graphs.

QgsPlotAxis

Encapsulates the properties of a plot axis.

QgsPlotDefaultSettings

Manages default settings for plot objects.

Point Cloud Layers

QgsPointCloudAttribute

Attribute for point cloud data pair of name and size in bytes.

QgsPointCloudAttributeByRampRenderer

An RGB renderer for 2d visualisation of point clouds using embedded red, green and blue attributes.

QgsPointCloudAttributeCollection

A collection of point cloud attributes.

QgsPointCloudAttributeModel

A model for display of available attributes from a point cloud.

QgsPointCloudAttributeProxyModel

A proxy model for filtering available attributes from a point cloud attribute model.

QgsPointCloudAttributeStatistics

Stores statistics of one attribute of a point cloud dataset.

QgsPointCloudBlock

Base class for storing raw data from point cloud nodes.

QgsPointCloudCategory

Represents an individual category (class) from a QgsPointCloudClassifiedRenderer.

QgsPointCloudClassifiedRenderer

Renders point clouds by a classification attribute.

QgsPointCloudDataProvider

Base class for providing data for QgsPointCloudLayer.

QgsPointCloudExtentRenderer

A renderer for 2d visualisation of point clouds which shows the dataset’s extents using a fill symbol.

QgsPointCloudIndex

Smart pointer for QgsAbstractPointCloudIndex.

QgsPointCloudLayer

Represents a map layer supporting display of point clouds.

QgsPointCloudLayerElevationProperties

Point cloud layer specific subclass of QgsMapLayerElevationProperties.

QgsPointCloudLayerExporter

Handles exporting point cloud layers to memory layers, OGR supported files and PDAL supported files.

QgsPointCloudLayerExporterTask

QgsTask task which performs a QgsPointCloudLayerExporter layer export operation as a background task.

QgsPointCloudNode

Keeps metadata for an indexed point cloud node.

QgsPointCloudNodeId

Represents an indexed point cloud node’s position in octree.

QgsPointCloudRenderContext

Encapsulates the render context for a 2D point cloud rendering operation.

QgsPointCloudRenderer

Abstract base class for 2d point cloud renderers.

QgsPointCloudRendererAbstractMetadata

Stores metadata about one point cloud renderer class.

QgsPointCloudRendererMetadata

Convenience metadata class that uses static functions to create point cloud renderer and its widget.

QgsPointCloudRendererRegistry

Registry of 2D renderers for point clouds.

QgsPointCloudRgbRenderer

An RGB renderer for 2d visualisation of point clouds using embedded red, green and blue attributes.

QgsPointCloudStatistics

Used to store statistics of a point cloud dataset.

Processing Framework

QgsProcessing

Contains enumerations and other constants for use in processing algorithms and parameters.

QgsProcessingAlgRunnerTask

QgsTask task which runs a QgsProcessingAlgorithm in a background task.

QgsProcessingAlgorithm

Abstract base class for processing algorithms.

QgsProcessingAlgorithmInformation

Contains basic properties for a Processing algorithm.

QgsProcessingBatchFeedback

Processing feedback subclass for use when batch processing.

QgsProcessingContext

Contains information about the context in which a processing algorithm is executed.

QgsProcessingDestinationParameter

Base class for all parameter definitions which represent file or layer destinations, e.g. parameters which are used for the destination for layers output by an algorithm.

QgsProcessingFeatureBasedAlgorithm

An abstract QgsProcessingAlgorithm base class for processing algorithms which operate “feature-by-feature”.

QgsProcessingFeatureSource

QgsFeatureSource subclass which proxies methods to an underlying QgsFeatureSource, modifying results according to the settings in a QgsProcessingContext.

QgsProcessingFeatureSourceDefinition

Encapsulates settings relating to a feature source input to a processing algorithm.

QgsProcessingFeedback

Base class for providing feedback from a processing algorithm.

QgsProcessingLayerPostProcessorInterface

An interface for layer post-processing handlers for execution following a processing algorithm operation.

QgsProcessingMultiStepFeedback

Processing feedback object for multi-step operations.

QgsProcessingOutputBoolean

A boolean output for processing algorithms.

QgsProcessingOutputConditionalBranch

A conditional branch output for processing algorithms, which represents a possible model logic flow which branches out from this algorithm.

QgsProcessingOutputDefinition

Base class for the definition of processing outputs.

QgsProcessingOutputFile

A file output for processing algorithms.

QgsProcessingOutputFolder

A folder output for processing algorithms.

QgsProcessingOutputHtml

A HTML file output for processing algorithms.

QgsProcessingOutputLayerDefinition

Encapsulates settings relating to a feature sink or output raster layer for a processing algorithm.

QgsProcessingOutputMapLayer

A map layer output for processing algorithms, where layers may be either vector or raster.

QgsProcessingOutputMultipleLayers

A multi-layer output for processing algorithms which create map layers, when the number and nature of the output layers is not predefined.

QgsProcessingOutputNumber

A numeric output for processing algorithms.

QgsProcessingOutputPointCloudLayer

A pointcloud layer output for processing algorithms.

QgsProcessingOutputRasterLayer

A raster layer output for processing algorithms.

QgsProcessingOutputString

A string output for processing algorithms.

QgsProcessingOutputVariant

A variant output for processing algorithms, capable of storing any QVariant value.

QgsProcessingOutputVectorLayer

A vector layer output for processing algorithms.

QgsProcessingOutputVectorTileLayer

A vector tile layer output for processing algorithms.

QgsProcessingParameterAggregate

A parameter for “aggregate” configurations, which consist of a definition of desired output fields, types, and aggregate used to populate them.

QgsProcessingParameterAlignRasterLayers

A parameter for Processing algorithms specifying how rasters should be aligned.

QgsProcessingParameterAnnotationLayer

An annotation layer parameter for processing algorithms.

QgsProcessingParameterArea

A double numeric parameter for area values.

QgsProcessingParameterAuthConfig

A string parameter for authentication configuration ID values.

QgsProcessingParameterBand

A raster band parameter for Processing algorithms.

QgsProcessingParameterBoolean

A boolean parameter for processing algorithms.

QgsProcessingParameterColor

A color parameter for processing algorithms.

QgsProcessingParameterCoordinateOperation

A coordinate operation parameter for processing algorithms.

QgsProcessingParameterCrs

A coordinate reference system parameter for processing algorithms.

QgsProcessingParameterDatabaseSchema

A database schema parameter for processing algorithms, allowing users to select from existing schemas on a registered database connection.

QgsProcessingParameterDatabaseTable

A database table name parameter for processing algorithms.

QgsProcessingParameterDateTime

A datetime (or pure date or time) parameter for processing algorithms.

QgsProcessingParameterDefinition

Base class for the definition of processing parameters.

QgsProcessingParameterDistance

A double numeric parameter for distance values.

QgsProcessingParameterDuration

A double numeric parameter for duration values.

QgsProcessingParameterDxfLayers

A parameter for Processing algorithms that need a list of input vector layers to export as DXF file.

QgsProcessingParameterEnum

An enum based parameter for processing algorithms, allowing for selection from predefined values.

QgsProcessingParameterExpression

An expression parameter for processing algorithms.

QgsProcessingParameterExtent

A rectangular map extent parameter for processing algorithms.

QgsProcessingParameterFeatureSink

A feature sink output for processing algorithms.

QgsProcessingParameterFeatureSource

An input feature source (such as vector layers) parameter for processing algorithms.

QgsProcessingParameterField

A vector layer or feature source field parameter for processing algorithms.

QgsProcessingParameterFieldMapping

A parameter for “field mapping” configurations, which consist of a definition of desired output fields, types, and expressions used to populate them.

QgsProcessingParameterFile

An input file or folder parameter for processing algorithms.

QgsProcessingParameterFileDestination

A generic file based destination parameter, for specifying the destination path for a file (non-map layer) created by the algorithm.

QgsProcessingParameterFolderDestination

A folder destination parameter, for specifying the destination path for a folder created by the algorithm or used for creating new files within the algorithm.

QgsProcessingParameterGeometry

A geometry parameter for processing algorithms.

QgsProcessingParameterLayout

A print layout parameter, allowing users to select a print layout.

QgsProcessingParameterLayoutItem

A print layout item parameter, allowing users to select a particular item from a print layout.

QgsProcessingParameterLimitedDataTypes

Can be inherited by parameters which require limits to their acceptable data types.

QgsProcessingParameterMapLayer

A map layer parameter for processing algorithms.

QgsProcessingParameterMapTheme

A map theme parameter for processing algorithms, allowing users to select an existing map theme from a project.

QgsProcessingParameterMatrix

A table (matrix) parameter for processing algorithms.

QgsProcessingParameterMeshDatasetGroups

A parameter for processing algorithms that need a list of mesh dataset groups.

QgsProcessingParameterMeshDatasetTime

A parameter for processing algorithms that need a list of mesh dataset index from time parameter.

QgsProcessingParameterMeshLayer

A mesh layer parameter for processing algorithms.

QgsProcessingParameterMultipleLayers

A parameter for processing algorithms which accepts multiple map layers.

QgsProcessingParameterNumber

A numeric parameter for processing algorithms.

QgsProcessingParameterPoint

A point parameter for processing algorithms.

QgsProcessingParameterPointCloudAttribute

A point cloud layer attribute parameter for Processing algorithms.

QgsProcessingParameterPointCloudDestination

A point cloud layer destination parameter, for specifying the destination path for a point cloud layer created by the algorithm.

QgsProcessingParameterPointCloudLayer

A point cloud layer parameter for processing algorithms.

QgsProcessingParameterProviderConnection

A data provider connection parameter for processing algorithms, allowing users to select from available registered connections for a particular data provider.

QgsProcessingParameterRange

A numeric range parameter for processing algorithms.

QgsProcessingParameterRasterDestination

A raster layer destination parameter, for specifying the destination path for a raster layer created by the algorithm.

QgsProcessingParameterRasterLayer

A raster layer parameter for processing algorithms.

QgsProcessingParameterScale

A double numeric parameter for map scale values.

QgsProcessingParameterString

A string parameter for processing algorithms.

QgsProcessingParameterTinInputLayers

A parameter for processing algorithms that need a list of input vector layers to construct a TIN.

QgsProcessingParameterType

Makes metadata of processing parameters available.

QgsProcessingParameterVectorDestination

A vector layer destination parameter, for specifying the destination path for a vector layer created by the algorithm.

QgsProcessingParameterVectorLayer

A vector layer (with or without geometry) parameter for processing algorithms.

QgsProcessingParameterVectorTileDestination

A vector tile layer destination parameter, for specifying the destination path for a vector tile layer created by the algorithm.

QgsProcessingParameterVectorTileWriterLayers

A parameter for Processing algorithms that need a list of input vector layers for writing of vector tiles.

QgsProcessingParameterVolume

A double numeric parameter for volume values.

QgsProcessingParameters

A collection of utilities for working with parameters when running a processing algorithm.

QgsProcessingProvider

Abstract base class for processing providers.

QgsProcessingRegistry

Registry for various processing components, including providers, algorithms and various parameters and outputs.

QgsProcessingUtils

Utility functions for use with processing classes.

Processing Framework - Models

QgsProcessingModelAlgorithm

Model based algorithm with processing.

QgsProcessingModelChildAlgorithm

Child algorithm representing a single component of a QgsProcessingModelAlgorithm.

QgsProcessingModelChildAlgorithmResult

Encapsulates the results of running a child algorithm within a model.

QgsProcessingModelChildDependency

Contains details of a child algorithm dependency.

QgsProcessingModelChildParameterSource

Source for the value of a parameter for a child algorithm within a model.

QgsProcessingModelComment

Represents a comment in a model.

QgsProcessingModelComponent

Represents a component of a model algorithm.

QgsProcessingModelGroupBox

Represents a group box in a model.

QgsProcessingModelOutput

Represents a final output created by the model.

QgsProcessingModelParameter

Represents an input parameter used by the model.

QgsProcessingModelResult

Encapsulates the results of running a Processing model.

QGIS Projects

QgsMapViewsManager

Manages storage of a set of views.

QgsProject

Encapsulates a QGIS project, including sets of map layers and their styles, layouts, annotations, canvases, etc.

QgsProjectBadLayerHandler

Interface for classes that handle missing layer files when reading project files.

QgsProjectDirtyBlocker

Temporarily blocks QgsProject “dirtying” for the lifetime of the object.

QgsProjectDisplaySettings

Contains settings and properties relating to how a QgsProject should display values such as map coordinates and bearings.

QgsProjectElevationProperties

Contains elevation properties for a QgsProject.

QgsProjectFileTransform

Convert from older project file versions to newer.

QgsProjectGpsSettings

Contains settings and properties relating to how a QgsProject should interact with a GPS device.

QgsProjectProperty

An abstract base class for QGIS project property hierarchys.

QgsProjectPropertyKey

Project property key node.

QgsProjectPropertyValue

Project property value node, contains a QgsProjectPropertyKey’s value.

QgsProjectServerValidator

Validates the server specific parts of the configuration of a QGIS project.

QgsProjectStorage

Abstract interface for project storage - to be implemented by various backends and registered in QgsProjectStorageRegistry.

QgsProjectStorageRegistry

Registry of storage backends that QgsProject may use.

QgsProjectStyleDatabaseModel

List model representing the style databases associated with a QgsProject.

QgsProjectStyleDatabaseProxyModel

A proxy model for filtering QgsProjectStyleDatabaseModel.

QgsProjectStyleSettings

Contains settings and properties relating to how a QgsProject should handle styling.

QgsProjectTimeSettings

Contains temporal settings and properties for the project, this may be used when animating maps or showing temporal layers.

QgsProjectTranslator

An interface for objects which can translate project strings.

QgsProjectUtils

Contains utility functions for working with QGIS projects.

QgsProjectVersion

Describes the version of a project.

QgsProjectViewSettings

Contains settings and properties relating to how a QgsProject should be displayed inside map canvas, e.g. map scales and default view extent for the project.

Raster Layers

QgsAbstractRasterLayerLabeling

Abstract base class for labeling settings for raster layers.

QgsBilinearRasterResampler

Bilinear raster resampler.

QgsBrightnessContrastFilter

Brightness/contrast and gamma correction filter pipe for rasters.

QgsClipToMinMaxEnhancement

A raster contrast enhancement that will clip a value to the specified min/max range.

QgsColorRampShader

A ramp shader will color a raster pixel based on a list of values ranges in a ramp.

QgsContrastEnhancement

Handles contrast enhancement and clipping.

QgsContrastEnhancementFunction

A contrast enhancement function is the base class for all raster contrast enhancements.

QgsCubicRasterResampler

Cubic Raster Resampler.

QgsExifTools

Contains utilities for working with EXIF tags in images.

QgsHillshadeRenderer

A renderer for generating live hillshade models.

QgsHueSaturationFilter

Color and saturation filter pipe for rasters.

QgsImageFetcher

Handles asynchronous download of images.

QgsLinearMinMaxEnhancement

A color enhancement function that performs a linear enhanceContrast between min and max.

QgsLinearMinMaxEnhancementWithClip

A linear enhanceContrast enhancement that first clips to min max and then enhanceContrastes linearly between min and max.

QgsMultiBandColorRenderer

Renderer for multiband images with the color components.

QgsPalettedRasterRenderer

Renderer for paletted raster images.

QgsRaster

Raster namespace.

QgsRasterAttributeTable

Represents a Raster Attribute Table (RAT).

QgsRasterBandStats

The RasterBandStats struct is a container for statistics about a single raster band.

QgsRasterBlock

Raster data container.

QgsRasterBlockFeedback

Feedback object tailored for raster block reading.

QgsRasterChecker

A helper class for unit tests that need to write an image and compare it to an expected result or render time.

QgsRasterContourRenderer

Raster renderer that generates contours on the fly for a source raster band.

QgsRasterDataProvider

Base class for raster data providers.

QgsRasterDataProviderElevationProperties

Handles elevation related properties for a raster data provider.

QgsRasterDataProviderTemporalCapabilities

Implementation of data provider temporal properties for QgsRasterDataProviders.

QgsRasterDrawer

The drawing pipe for raster layers.

QgsRasterFileWriter

The raster file writer which allows you to save a raster to a new file.

QgsRasterFileWriterTask

QgsTask task which performs a QgsRasterFileWriter layer saving operation as a background task.

QgsRasterHistogram

A container for a histogram of a single raster band.

QgsRasterIdentifyResult

Raster identify results container.

QgsRasterInterface

Base class for processing filters like renderers, reprojector, resampler etc.

QgsRasterIterator

Iterator for sequentially processing raster cells.

QgsRasterLayer

Represents a raster layer.

QgsRasterLayerElevationProperties

Raster layer specific subclass of QgsMapLayerElevationProperties.

QgsRasterLayerSimpleLabeling

Basic implementation of the labeling interface for raster layers.

QgsRasterLayerTemporalProperties

Implementation of map layer temporal properties for raster layers.

QgsRasterLayerUtils

Contains utility functions for working with raster layers.

QgsRasterMinMaxOrigin

Describes the origin of minimum and maximum values in a raster.

QgsRasterNuller

Raster pipe that deals with null values.

QgsRasterPipe

Contains a pipeline of raster interfaces for sequential raster processing.

QgsRasterProjector

Implements approximate projection support for optimised raster transformation.

QgsRasterPyramid

This struct is used to store pyramid info for the raster layer.

QgsRasterRange

Represents a range of raster values between min and max, optionally including the min and max value.

QgsRasterRenderer

Raster renderer pipe that applies colors to a raster.

QgsRasterRendererRegistry

Registry for raster renderers.

QgsRasterRendererUtils

Utility functions for raster renderers.

QgsRasterResampleFilter

Resample filter pipe for rasters.

QgsRasterResampler

Interface for resampling rasters (e.g. to have a smoother appearance).

QgsRasterResamplerV2

Interface for resampling rasters (V2) (e.g. to have a smoother appearance), which provides a more efficient interface vs QgsRasterResampler.

QgsRasterShader

Interface for all raster shaders.

QgsRasterShaderFunction

The raster shade function applies a shader to a pixel at render time - typically used to render grayscale images as false color.

QgsRasterSingleColorRenderer

Raster renderer which renders all data pixels using a single color.

QgsRasterTransparency

Defines the list of pixel values to be considered as transparent or semi transparent when rendering rasters.

QgsRasterViewPort

This class provides details of the viewable area that a raster will be rendered into.

QgsSingleBandColorDataRenderer

Raster renderer pipe for single band color.

QgsSingleBandGrayRenderer

Raster renderer pipe for single band gray.

QgsSingleBandPseudoColorRenderer

Raster renderer pipe for single band pseudocolor.

Scale Bars

QgsDoubleBoxScaleBarRenderer

Double box with alternating colors.

QgsHollowScaleBarRenderer

Scalebar style that draws a single box with alternating color for the segments, with horizontal lines through alternating segments.

QgsNumericScaleBarRenderer

A scale bar style that draws text in the form of ‘1:XXXXX’.

QgsScaleBarRenderer

Abstract base class for scale bar renderers.

QgsScaleBarRendererRegistry

A registry which manages registered scalebar renderers.

QgsScaleBarSettings

Stores the appearance and layout settings for scalebar drawing with QgsScaleBarRenderer.

QgsSingleBoxScaleBarRenderer

Scalebar style that draws a single box with alternating color for the segments.

QgsSteppedLineScaleBarRenderer

Scalebar style that draws a stepped line representation of a scalebar.

QgsTicksScaleBarRenderer

A scale bar that draws segments using short ticks.

Sensor Handling

QgsAbstractSensor

An abstract base class for sensors.

QgsIODeviceSensor

An abstract class for QIODevice-based sensors.

QgsSensorAbstractMetadata

Stores metadata about a sensor class.

QgsSensorManager

Manages sensors.

QgsSensorModel

A QAbstractItemModel subclass for showing sensors within a QgsSensorManager.

QgsSensorRegistry

Registry of available sensor types.

QgsSerialPortSensor

A serial port sensor class.

QgsTcpSocketSensor

A TCP socket sensor class.

QgsUdpSocketSensor

A UDP socket sensor class.

Settings Handling

PyQgsSettingsEntryEnumFlag

class PyQgsSettingsEntryEnumFlag An enum settings entry. since QGIS 3.20

QgsSettings

Stores settings for use within QGIS.

QgsSettingsEntryBase

Represents a settings entry and provides methods for reading and writing settings values.

QgsSettingsEntryBaseTemplateQColorBase

Base abstract class for settings entries with typed get and set methods.

QgsSettingsEntryBaseTemplateQStringBase

Base abstract class for settings entries with typed get and set methods.

QgsSettingsEntryBaseTemplateQStringListBase

Base abstract class for settings entries with typed get and set methods.

QgsSettingsEntryBaseTemplateQVariantBase

Base abstract class for settings entries with typed get and set methods.

QgsSettingsEntryBaseTemplateQVariantMapBase

Base abstract class for settings entries with typed get and set methods.

QgsSettingsEntryBaseTemplateboolBase

Base abstract class for settings entries with typed get and set methods.

QgsSettingsEntryBaseTemplatedoubleBase

Base abstract class for settings entries with typed get and set methods.

QgsSettingsEntryBaseTemplateintBase

Base abstract class for settings entries with typed get and set methods.

QgsSettingsEntryBool

A boolean settings entry.

QgsSettingsEntryColor

A color settings entry.

QgsSettingsEntryDouble

A double settings entry.

QgsSettingsEntryGroup

Creates a group of settings which have a common definition of base key.

QgsSettingsEntryInteger

An integer settings entry.

QgsSettingsEntryString

A string settings entry.

QgsSettingsEntryStringList

A string list settings entry.

QgsSettingsEntryVariant

A variant settings entry.

QgsSettingsEntryVariantMap

A string list settings entry.

QgsSettingsRegistry

Used for settings introspection and collects a list of child QgsSettingsRegistry and a list of child QgsSettingsRegistry.

QgsSettingsRegistryCore

Used for settings introspection and collects all QgsSettingsEntry instances of core.

QgsSettingsTree

Holds the tree structure for the settings in QGIS core.

QgsSettingsTreeNamedListNode

A named list tree node for the settings tree to help organizing and introspecting the tree.

QgsSettingsTreeNode

A tree node for the settings tree to help organizing and introspecting the tree.

Symbology and Vector Renderers

Qgs25DRenderer

A vector renderer which represents 3D features in an isometric view.

QgsAbstractBrushedLineSymbolLayer

Base class for line symbol layer types which draws line sections using a QBrush.

QgsAnimatedMarkerSymbolLayer

Animated marker symbol layer class.

QgsArrowSymbolLayer

Line symbol layer used for representing lines as arrows.

QgsCategorizedSymbolRenderer

A feature renderer which represents features using a list of renderer categories.

QgsCentroidFillSymbolLayer

A fill symbol layer which renders a marker symbol at the centroid of a polygon geometry.

QgsColorBrewerPalette

Contains utility functions for working with Color Brewer color schemes.

QgsCombinedStyleModel

A model which contains entities from multiple QgsStyle databases.

QgsCptCityAllRampsItem

An “All ramps item”, which contains all items in a flat hierarchy.

QgsCptCityArchive

Represents a CPT City color scheme.

QgsCptCityBrowserModel

A custom item model for display of CPT City color palettes.

QgsCptCityCollectionItem

A logical collection of subcollections and color ramps for use in QgsCptCityBrowserModel.

QgsCptCityColorRampItem

An item that represents a layer that can be opened with one of the providers for a QgsCptCityBrowserModel.

QgsCptCityDataItem

Base class for all items in a QgsCptCityBrowserModel model.

QgsCptCityDirectoryItem

A directory which contains subdirectories and color ramps for use in QgsCptCityBrowserModel.

QgsCptCitySelectionItem

A selection which contains subdirectories and color ramps for use in QgsCptCityBrowserModel.

QgsEllipseSymbolLayer

A symbol layer for rendering objects with major and minor axis (e.g. ellipse, rectangle, etc).

QgsEmbeddedSymbolRenderer

A vector feature renderer which uses embedded feature symbology to render per-feature symbols.

QgsFeatureRenderer

Abstract base class for all 2D vector feature renderers.

QgsFeatureRendererGenerator

An interface for objects which generate feature renderers for vector layers.

QgsFillSymbol

A fill symbol type, for rendering Polygon and MultiPolygon geometries.

QgsFillSymbolLayer

Abstract base class for fill symbol layers.

QgsFilledLineSymbolLayer

A line symbol layer type which fills a stroked line with a QgsFillSymbol.

QgsFilledMarkerSymbolLayer

Filled marker symbol layer, consisting of a shape which is rendered using a QgsFillSymbol. This allows the symbol to support advanced styling of the interior and stroke of the shape.

QgsFontMarkerSymbolLayer

A marker symbol layer which displays characters rendered using a font.

QgsGeometryGeneratorSymbolLayer

A symbol layer subclass which alters rendered feature shapes through the use of QGIS expressions.

QgsGradientFillSymbolLayer

A fill symbol layer which draws a smooth color gradient over a polygon.

QgsGraduatedSymbolRenderer

A vector feature renderer which uses numeric attributes to classify features into different ranges.

QgsHashedLineSymbolLayer

Line symbol layer type which draws repeating line sections along a line feature.

QgsHeatmapRenderer

A renderer which draws points as a live heatmap.

QgsImageFillSymbolLayer

Base class for fill symbol layers which fill polygons with a repeated image.

QgsInterpolatedLineColor

Defines color interpolation for rendering mesh datasets.

QgsInterpolatedLineRenderer

Represents a simple line renderer with width and color varying depending on values.

QgsInterpolatedLineSymbolLayer

A symbol layer that represents vector layer line features as interpolated lines.

QgsInterpolatedLineWidth

Represents a width that can vary depending on values.

QgsInvertedPolygonRenderer

A polygon-only feature renderer used to display features inverted.

QgsLegendSymbolItem

Stores information about one class/rule of a vector layer renderer in a unified way that can be used by the legend model for rendering of legend.

QgsLinePatternFillSymbolLayer

A symbol fill consisting of repeated parallel lines.

QgsLineSymbol

A line symbol type, for rendering LineString and MultiLineString geometries.

QgsLineSymbolLayer

Abstract base class for line symbol layers.

QgsLinearReferencingSymbolLayer

Line symbol layer used for decorating according to linear referencing.

QgsLineburstSymbolLayer

Line symbol layer type which draws a gradient pattern perpendicularly along a line.

QgsMapInfoSymbolConversionContext

Context for a MapInfo symbol conversion operation.

QgsMapInfoSymbolConverter

Handles conversion of MapInfo symbols to QGIS symbology.

QgsMarkerLineSymbolLayer

Line symbol layer type which draws repeating marker symbols along a line feature.

QgsMarkerSymbol

A marker symbol type, for rendering Point and MultiPoint geometries.

QgsMarkerSymbolLayer

Abstract base class for marker symbol layers.

QgsMaskMarkerSymbolLayer

Special symbol layer that uses its sub symbol as a selective mask.

QgsMergedFeatureRenderer

A polygon or line-only feature renderer used to render a set of features merged (or dissolved) into a single geometry.

QgsNullSymbolRenderer

Null symbol renderer, which draws no symbols for features by default, but allows for labeling and diagrams for the layer.

QgsPointClusterRenderer

A renderer that automatically clusters points with the same geographic position.

QgsPointDisplacementRenderer

A renderer that automatically displaces points with the same geographic location.

QgsPointDistanceRenderer

An abstract base class for distance based point renderers (e.g., clusterer and displacement renderers).

QgsPointPatternFillSymbolLayer

A fill symbol layer which fills polygon shapes with repeating marker symbols.

QgsRandomMarkerFillSymbolLayer

A fill symbol layer which places markers at random locations within polygons.

QgsRasterFillSymbolLayer

A fill symbol layer which fills polygons with a repeated raster image.

QgsRasterLineSymbolLayer

Line symbol layer type which draws line sections using a raster image file.

QgsRasterMarkerSymbolLayer

Raster marker symbol layer class.

QgsRendererAbstractMetadata

Stores metadata about one renderer class.

QgsRendererCategory

Represents an individual category (class) from a QgsCategorizedSymbolRenderer.

QgsRendererMetadata

Convenience metadata class that uses static functions to create renderer and its widget.

QgsRendererRange

Represents a value range for a QgsGraduatedSymbolRenderer.

QgsRendererRangeLabelFormat

Encapsulates the formatting for a QgsRendererRange label.

QgsRendererRegistry

Registry of renderers.

QgsRuleBasedRenderer

Rule based renderer.

QgsSVGFillSymbolLayer

A fill symbol layer which fills polygons with a repeated SVG file.

QgsShapeburstFillSymbolLayer

A fill symbol layer which applies a gradient from the outer edges of a symbol to the inside.

QgsSimpleFillSymbolLayer

Renders polygons using a single fill and stroke color.

QgsSimpleLineSymbolLayer

A simple line symbol layer, which renders lines using a line in a variety of styles (e.g. solid, dotted, dashed).

QgsSimpleMarkerSymbolLayer

Simple marker symbol layer, consisting of a rendered shape with solid fill color and a stroke.

QgsSimpleMarkerSymbolLayerBase

Abstract base class for simple marker symbol layers.

QgsSingleSymbolRenderer

A feature renderer which renders all features with the same symbol.

QgsStyle

A database of saved style entities, including symbols, color ramps, text formats and others.

QgsStyleColorRampEntity

A color ramp entity for QgsStyle databases.

QgsStyleEntityInterface

An interface for entities which can be placed in a QgsStyle database.

QgsStyleEntityVisitorInterface

An interface for classes which can visit style entity (e.g. symbol) nodes (using the visitor pattern).

QgsStyleLabelSettingsEntity

A label settings entity for QgsStyle databases.

QgsStyleLegendPatchShapeEntity

A legend patch shape entity for QgsStyle databases.

QgsStyleModel

A QAbstractItemModel subclass for showing symbol and color ramp entities contained within a QgsStyle database.

QgsStyleProxyModel

A QSortFilterProxyModel subclass for showing filtered symbol and color ramps entries from a QgsStyle database.

QgsStyleSymbol3DEntity

A 3d symbol entity for QgsStyle databases.

QgsStyleSymbolEntity

A symbol entity for QgsStyle databases.

QgsStyleTextFormatEntity

A text format entity for QgsStyle databases.

QgsSvgCache

A cache for images / pictures derived from SVG files.

QgsSvgMarkerSymbolLayer

A marker symbol layer which renders an SVG graphic.

QgsSymbol

Abstract base class for all rendered symbols.

QgsSymbolAnimationSettings

Contains settings relating to symbol animation.

QgsSymbolBufferSettings

Contains settings relating to symbol buffers, which draw a “halo” effect around the symbol.

QgsSymbolLayer

Abstract base class for symbol layers.

QgsSymbolLayerAbstractMetadata

Stores metadata about one symbol layer class.

QgsSymbolLayerId

We may need stable references to symbol layers, when pointers to symbol layers are not usable (when a symbol or a feature renderer is cloned for example).

QgsSymbolLayerMetadata

Convenience metadata class that uses static functions to create symbol layer and its widget.

QgsSymbolLayerReference

Type used to refer to a specific symbol layer in a symbol of a layer.

QgsSymbolLayerRegistry

Registry of available symbol layer classes.

QgsSymbolLayerUtils

Contains utility functions for working with symbols and symbol layers.

QgsSymbolLevelItem

Represents a symbol level during vector rendering operations.

QgsSymbolRenderContext

Encapsulates the context in which a symbol is being rendered.

QgsTemplatedLineSymbolLayerBase

Base class for templated line symbols, e.g. line symbols which draw markers or hash lines at intervals along the line feature.

QgsVectorFieldSymbolLayer

A symbol layer class for displaying displacement arrows based on point layer attributes.

Text Rendering

QgsFontDownloadDetails

Encapsulates details required for downloading a font.

QgsFontManager

Manages available fonts and font installation for a QGIS instance.

QgsTextBackgroundSettings

Container for settings relating to a text background object.

QgsTextBlock

Represents a block of text consisting of one or more QgsTextFragment objects.

QgsTextBlockFormat

Stores information relating to individual block formatting.

QgsTextBufferSettings

Container for settings relating to a text buffer.

QgsTextCharacterFormat

Stores information relating to individual character formatting.

QgsTextDocument

Represents a document consisting of one or more QgsTextBlock objects.

QgsTextDocumentMetrics

Contains pre-calculated metrics of a QgsTextDocument.

QgsTextDocumentRenderContext

Encapsulates the context in which a text document is to be rendered.

QgsTextFormat

Container for all settings relating to text rendering.

QgsTextFragment

Stores a fragment of document along with formatting overrides to be used when rendering the fragment.

QgsTextMaskSettings

Container for settings relating to a selective masking around a text.

QgsTextRenderer

Handles rendering text using rich formatting options, including drop shadows, buffers and background shapes.

QgsTextRendererUtils

Utility functions for text rendering.

QgsTextShadowSettings

Container for settings relating to a text shadow.

Tiled Scene Layers

QgsCesiumUtils

Contains utilities for working with Cesium data.

QgsTiledSceneBoundingVolume

Represents a bounding volume for a tiled scene.

QgsTiledSceneDataProvider

Base class for data providers for QgsTiledSceneLayer.

QgsTiledSceneIndex

An index for tiled scene data providers.

QgsTiledSceneLayer

Represents a map layer supporting display of tiled scene objects.

QgsTiledSceneLayerElevationProperties

Tiled scene layer specific subclass of QgsMapLayerElevationProperties.

QgsTiledSceneRenderContext

Encapsulates the render context for a 2D tiled scene rendering operation.

QgsTiledSceneRenderer

Abstract base class for 2d tiled scene renderers.

QgsTiledSceneRendererAbstractMetadata

Stores metadata about one tiled scene renderer class.

QgsTiledSceneRendererMetadata

Convenience metadata class that uses static functions to create tiled scene renderer and its widget.

QgsTiledSceneRendererRegistry

Registry of 2D renderers for tiled scenes.

QgsTiledSceneRequest

Tiled scene data request.

QgsTiledSceneTextureRenderer

Renders tiled scene layers using textures.

QgsTiledSceneTile

Represents an individual tile from a tiled scene data source.

QgsTiledSceneWireframeRenderer

Renders tiled scene layers using the raw primitive wireframes.

Validity Checks

QgsAbstractValidityCheck

Abstract base class for individual validity checks.

QgsLayoutValidityCheckContext

Validity check context for print layout validation.

QgsValidityCheckContext

Base class for validity check contexts.

QgsValidityCheckRegistry

A registry that keeps a list of QgsAbstractValidityCheck checks which can be used when performing validity checks.

QgsValidityCheckResult

Represents an individual result from a validity check run by a QgsAbstractValidityCheck subclass.

Vector Layers

QgsAuxiliaryLayer

Allows managing the auxiliary storage for a vector layer.

QgsCodedFieldDomain

Definition of a coded / enumerated field domain.

QgsCodedValue

Associates a code and a value.

QgsFieldDomain

Base class for field domains.

QgsGlobFieldDomain

Definition of a field domain for field content validated by a glob.

QgsRangeFieldDomain

Definition of a numeric field domain with a range of validity for values.

QgsTrackedVectorLayerTools

Vector layer tools subclass which “tracks” edits.

QgsVectorDataProvider

Base class for vector data providers.

QgsVectorDataProviderTemporalCapabilities

Implementation of data provider temporal properties for QgsVectorDataProviders.

QgsVectorLayer

Represents a vector layer which manages a vector based dataset.

QgsVectorLayerCache

Caches features for a given QgsVectorLayer.

QgsVectorLayerEditBuffer

Stores queued vector layer edit operations prior to committing changes to the layer’s data provider.

QgsVectorLayerEditBufferGroup

The edit buffer group manages a group of edit buffers.

QgsVectorLayerEditPassthrough

An edit buffer which directly passes commands through, used when a layer is within a transaction.

QgsVectorLayerEditUtils

Contains utility functions for editing vector layers.

QgsVectorLayerElevationProperties

Vector layer specific subclass of QgsMapLayerElevationProperties.

QgsVectorLayerExporter

A convenience class for exporting vector layers to a destination data provider.

QgsVectorLayerExporterTask

QgsTask task which performs a QgsVectorLayerExporter layer export operation as a background task.

QgsVectorLayerFeatureCounter

Counts the features in a QgsVectorLayer in task.

QgsVectorLayerFeatureIterator

A feature iterator which iterates over features from a QgsVectorLayer.

QgsVectorLayerFeatureSource

Partial snapshot of vector layer’s state (only the members necessary for access to features).

QgsVectorLayerJoinBuffer

Manages joined fields for a vector layer.

QgsVectorLayerJoinInfo

Defines left outer join from our vector layer to some other vector layer.

QgsVectorLayerSelectedFeatureSource

QgsFeatureSource subclass for the selected features from a QgsVectorLayer.

QgsVectorLayerSelectionProperties

Implementation of layer selection properties for vector layers.

QgsVectorLayerTemporalContext

Encapsulates the context in which a QgsVectorLayer’s temporal capabilities will be applied.

QgsVectorLayerTemporalProperties

Implementation of map layer temporal properties for vector layers.

QgsVectorLayerTools

Used to handle basic editing operations on vector layers.

QgsVectorLayerToolsContext

Contains settings which reflect the context in which vector layer tool operations should be considered.

QgsVectorLayerUndoCommand

Base class for undo commands within a QgsVectorLayerEditBuffer.

QgsVectorLayerUndoCommandAddAttribute

Undo command for adding a new attribute to a vector layer.

QgsVectorLayerUndoCommandAddFeature

Undo command for adding a feature to a vector layer.

QgsVectorLayerUndoCommandChangeAttribute

Undo command for modifying an attribute of a feature from a vector layer.

QgsVectorLayerUndoCommandChangeGeometry

Undo command for modifying the geometry of a feature from a vector layer.

QgsVectorLayerUndoCommandDeleteAttribute

Undo command for removing an existing attribute from a vector layer.

QgsVectorLayerUndoCommandDeleteFeature

Undo command for deleting a feature from a vector layer.

QgsVectorLayerUndoCommandRenameAttribute

Undo command for renaming an existing attribute of a vector layer.

QgsVectorLayerUndoPassthroughCommand

Undo command for vector layer in a transaction group mode.

QgsVectorLayerUndoPassthroughCommandAddAttribute

Undo command for adding attri to a vector layer in transaction group.

QgsVectorLayerUndoPassthroughCommandAddFeatures

Undo command for adding a feature to a vector layer in a transaction group mode.

QgsVectorLayerUndoPassthroughCommandChangeAttribute

Undo command for changing attr value from a vector layer in a transaction group.

QgsVectorLayerUndoPassthroughCommandChangeAttributes

Undo command for changing attributes’ values from a vector layer in a transaction group.

QgsVectorLayerUndoPassthroughCommandChangeGeometry

Undo command for changing feature geometry from a vector layer in a transaction group.

QgsVectorLayerUndoPassthroughCommandDeleteAttribute

Undo command for deleting attributes of a vector layer in a transaction group.

QgsVectorLayerUndoPassthroughCommandDeleteFeatures

Undo command for deleting features from a vector layer in a transaction group.

QgsVectorLayerUndoPassthroughCommandRenameAttribute

Undo command for deleting attributes of a vector layer in a transaction group.

QgsVectorLayerUndoPassthroughCommandUpdate

Undo command for running a specific sql query in a transaction group.

QgsVectorLayerUtils

Contains utility methods for working with QgsVectorLayers.

Vector Tile Layers

QgsMapBoxGlStyleAbstractSource

Abstract base class for MapBox GL style sources.

QgsMapBoxGlStyleConversionContext

Context for a MapBox GL style conversion operation.

QgsMapBoxGlStyleConverter

Handles conversion of MapBox GL styles to QGIS vector tile renderers and labeling settings.

QgsMapBoxGlStyleRasterSource

Encapsulates a MapBox GL style raster source.

QgsMapBoxGlStyleRasterSubLayer

Encapsulates a MapBox GL style raster sub layer.

QgsVectorTileBasicLabeling

Basic labeling configuration for vector tile layers.

QgsVectorTileBasicLabelingStyle

Configuration of a single style within QgsVectorTileBasicLabeling.

QgsVectorTileBasicRenderer

The default vector tile renderer implementation.

QgsVectorTileBasicRendererStyle

Definition of map rendering of a subset of vector tile data.

QgsVectorTileLabeling

Base class for labeling configuration classes for vector tile layers.

QgsVectorTileLayer

Implements a map layer that is dedicated to rendering of vector tiles.

QgsVectorTileMatrixSet

Encapsulates properties of a vector tile matrix set, including tile origins and scaling information.

QgsVectorTileRenderer

Abstract base class for all vector tile renderer implementations.

QgsVectorTileRendererData

Contains decoded features of a single vector tile and any other data necessary for rendering of it.

QgsVectorTileUtils

Utility functions for working with vector tiles.

QgsVectorTileWriter

Takes care of writing vector tiles.

QgsVtpkTiles

Utility class for reading and writing ESRI VTPK files.

stac

QgsStacAsset

Class for storing a STAC asset’s data.

QgsStacCatalog

Class for storing a STAC Catalog’s data.

QgsStacCollection

Class for storing a STAC Collection’s data.

QgsStacCollectionList

Class for storing a list of STAC Collections, which is typically used to store the data returned by STAC API /collections endpoint.

QgsStacConnection

Represents connections to STAC catalogs.

QgsStacController

The QgsStacController class handles STAC requests.

QgsStacExtent

Class for storing a STAC SpatioTemporal extent.

QgsStacItem

Class for storing a STAC Item’s data.

QgsStacItemCollection

Class for storing a STAC Item Collections.

QgsStacLink

Class for storing data associated with a STAC link.

QgsStacObject

Abstract base class for storing STAC objects.

QgsStacParser

SpatioTemporal Asset Catalog JSON parser.

QgsStacProvider

Class for storing a STAC collection’s provider data.