core

NULL

ProjectDirtyBlocker

Context manager used to block project setDirty calls.

Qgis

The Qgis class provides global constants 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

QgsAbstractGeometrySimplifier

Abstract base class for simplify 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

The QgsAlignRasterData class provides data structures and enums for 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

Class allowing to manage the zip/unzip actions

QgsAttributeTableConfig

This is a container for configuration of the attribute table. The configuration is specific for one vector layer.

QgsAuxiliaryStorage

Class 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

QgsCachedFeatureIterator

Delivers features from the cache

QgsCachedFeatureWriterIterator

Uses another iterator as backend and writes features to the cache

QgsCadUtils

The QgsCadUtils class provides routines for CAD editing.

QgsClipper

A class to trim 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

The QgsConditionalLayerStyles class holds conditional style information for a layer. This includes field styles and full row styles.

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

Class for storing the component parts of a RDBMS data source URI (e.g. a Postgres data source).

QgsDatabaseFilterProxyModel

A class that 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

Constructor for QgsTemporalRange. The begin and end are specified, and optionally whether or not these bounds are included in the range.

QgsDateTimeRange

Constructor for QgsTemporalRange. The begin and end are specified, and optionally whether or not these bounds are included in the range.

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

The QgsDefaultValue class 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 digital elevation model in a raster image which may get updated as a part of map layer rendering process.

QgsElevationShadingRenderer

This class can render 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

QgsErrorMessage represents 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. Features are fetched asynchronously.

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

QgsFeaturePickerModel

Provides a list of features based on filter conditions. Features are fetched asynchronously.

QgsFeaturePickerModelBase

Provides a list of features based on filter conditions.

QgsFeatureRequest

This class 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

The QgsFieldFormatterRegistry manages registered classes of QgsFieldFormatter.

QgsFieldModel

The QgsFieldModel class is a model to display the list of fields in widgets (optionally associated with a vector layer).

QgsFieldProxyModel

The QgsFieldProxyModel class provides an easy to use model to display 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

Class for file utilities.

QgsFontUtils

Contains utility functions for working with fonts.

QgsGenericNumericTransformer

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

QgsGeometryOptions

The QgsGeometryOptions class contains options to automatically adjust geometries to constraints on a layer.

QgsGeometryValidator

Constructor for QgsGeometryValidator.

QgsGml

This class reads data from a WFS server or alternatively from a GML file.

QgsGmlFeatureClass

Description of feature class in GML

QgsGmlSchema

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

QgsHtmlUtils

Class for HTML utilities.

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

The QgsLayerDefinition class 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

The QgsLegendSettings class 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 a 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

QgsLogger is a class to print 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

Class that runs a hit test with given map settings. Based on the hit test it returns which symbols will be visible on the map - this is useful for content based legend.

QgsMapHitTestTask

Executes a QgsMapHitTest in a background thread.

QgsMapLayer

Base class for all map layer types. This is the base class for all map layer types (vector, raster).

QgsMapLayerDependency

This class 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

The QgsMapLayerLegend class is abstract interface for implementations of legends for one map layer.

QgsMapLayerLegendUtils

Miscellaneous utility functions for handling of map layer legend

QgsMapLayerModel

The QgsMapLayerModel class is a model to display layers in widgets.

QgsMapLayerProxyModel

The QgsMapLayerProxyModel class 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

The QgsMapSettings class contains configuration for rendering of the map.

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 GeometrySimplifier using the “MapToPixel” algorithm

QgsMapUnitScale

Struct for storing maximum and minimum scales for measurements in map

QgsMargins

Constructs a margins object with all margins set to 0.

QgsMaskIdProvider

This class 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.

QgsMeshUtils

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

This class 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

The QgsOgcUtils class 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

QgsOptional is a container for other classes and adds an additional enabled/disabled flag.

QgsOwsConnection

Connections management

QgsPathResolver

Resolves relative paths into absolute paths and vice versa. Used for

QgsPluginLayer

Base class for plugin layers. These can be implemented by plugins and registered in QgsPluginLayerRegistry.

QgsPluginLayerRegistry

A registry of plugin layers types.

QgsPluginLayerType

Class for creating plugin specific layers

QgsPointLocator

The class defines interface for querying point location:

QgsPointXY

A class to represent a 2D point.

QgsPolymorphicRelation

A polymorphic relation consists of the same properties like a normal relation except for the referenced layer which is calculated based on one or several fields of the referencing layer.

QgsPostgresStringUtils

The 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

Class allowing to manage the zip/unzip actions on project file

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 a 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. Possible uses include transformers which map a value into a scaled size or color from a gradient.

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 on to another feature sink.

QgsProxyProgressTask

A QgsTask shell which proxies progress reports.

QgsPythonRunner

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

QgsQueryResultModel

The QgsQueryResultModel class is a model for QgsAbstractDatabaseProviderConnection.QueryResult

QgsRandomColorRamp

Totally random color ramp. Returns colors generated at random, but constrained to some hardcoded saturation and value ranges to prevent ugly color generation.

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

The class is used as a container of context for various read/write operations on other objects.

QgsReadWriteContextCategoryPopper

Allows entering a context category and takes care of leaving this category on deletion of the class. This would happen when it gets out of scope.

QgsReadWriteLocker

The QgsReadWriteLocker class is 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. Used to resolve layers from projects.

QgsRelationManager

This class 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

This is a 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 provider custom handlers for features rendered as part of a map render job.

QgsRenderedItemDetails

Base class for detailed information about a rendered item.

QgsRunProcess

A class that 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

Class for parsing SQL statements.

QgsSQLStatementFragment

Class for parsing 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

QgsScopedProxyProgressTask

Scoped QgsScopedProxyProgressTask, which automatically adds the proxy task to the application task manager on construction and finalizes the task when it goes out of scope.

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

This class contains information about how to simplify geometries fetched from a QgsFeatureIterator

QgsSingleCategoryDiagramRenderer

Renders the diagrams for all features with the same settings

QgsSingleItemModel

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

QgsSizeScaleTransformer

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

QgsSldExportContext

The QgsSldExportContext class holds SLD export options and other information related to SLD export of a QGIS layer style.

QgsSnappingConfig

This is a container for configuration of the snapping of the project

QgsSnappingUtils

This class has all the 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. The size of the rendered diagram is given by a combination of subrenderers.

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

Task that is composed of sub-tasks to be executed in a serial way, which may be useful for example to add several layers in a single target dataset which does not support concurrent updates.

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

Class that takes care of tessellation of 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

Range of tiles in a tile matrix to be rendered. The selection is rectangular, given by start/end row and column numbers.

QgsTileXYZ

Stores coordinates of a tile in a tile matrix set.

QgsTolerance

This is the class is providing tolerance value in map unit values.

QgsTopologyPreservingSimplifier

Implementation of GeometrySimplifier using the Douglas-Peucker algorithm

QgsTracer

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

QgsTransaction

This class allows including a set of layers in a database-side transaction, provided the layer data providers support transactions and are compatible with each other.

QgsTransactionGroup

Constructor for QgsTransactionGroup

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

User profile manager is used to manager list, and manage user profiles on the users machine.

QgsVariantUtils

Contains utility functions for working with QVariants and QVariant types.

QgsVector

A class to represent a vector. Currently no Z axis / 2.5D support is implemented.

QgsVector3D

Class for storage of 3D vectors 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. This can be used to save a vector layer out to a file without blocking the QGIS interface.

QgsVectorLayerServerProperties

QgsVectorSimplifyMethod

This class contains information how to simplify geometries fetched from a vector layer

QgsVirtualLayerDefinition

Class to manipulate the definition of a virtual layer

QgsVirtualLayerDefinitionUtils

Utils class for QgsVirtualLayerDefinition

QgsVirtualLayerTask

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

QgsWeakRelation

The QgsWeakRelation class represent a QgsRelation with possibly unresolved layers or unmatched fields.

QgsXmlUtils

Assorted helper methods for reading and writing chunks of XML

QgsZipUtils

ReadWriteContextEnterCategory

Push a category to the stack

ScopedRuntimeProfileContextManager

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

USER_CRS_START_ID

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.__int__(). For floating point numbers, this truncates towards zero.

check

Constructs QgsAbstractValidityChecks using a decorator.

compareWkt

Compare two WKT strings with some tolerance

edit

geoEpsgCrsAuthId

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

qgsfunction

Decorator function used to define a user expression function.

register_function

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

stringToSymbolLayerReferenceList

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

symbolLayerReferenceListToString

Utilitary function to turn a QgsSymbolLayerReferenceList into a string

3D

Qgs3DRendererAbstractMetadata

Base metadata class for 3D renderers. Instances of derived classes may be registered in Qgs3DRendererRegistry.

Qgs3DRendererRegistry

Keeps track of available 3D renderers. Should be accessed through QgsApplication.renderer3DRegistry() singleton.

Qgs3DSymbolAbstractMetadata

Stores metadata about one 3D symbol class.

Qgs3DSymbolRegistry

Registry of available 3D symbol classes.

QgsAbstract3DRenderer

Base class for all renderers that may to participate in 3D view.

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

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

This is 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

This is 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

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 offering 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 Collection that represents a root group of connections from a single data provider

QgsDataCollectionItem

A Collection: logical collection of layers or subcollections, e.g. GRASS location/mapset, database? wms source?

QgsDataItem

Base class for all items in the model.

QgsDataItemProvider

This is the interface for those who want to add custom data items to the browser tree.

QgsDataItemProviderRegistry

This class keeps a list of data item providers that may add items to the browser tree.

QgsDatabaseSchemaItem

A Collection that represents a database schema item

QgsDirectoryItem

A directory: contains subdirectories and layers

QgsDirectoryParamWidget

Browser parameter widget implementation for directory items.

QgsErrorItem

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

QgsFavoritesItem

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 collection of field items with some internal logic to retrieve the fields and a the vector layer instance from a connection URI, the schema and the table name.

QgsLayerItem

Item that represents a layer that can be opened with one of the

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 zip file: contains layers, using GDAL/OGR VSIFILE mechanism

Classification Methods

QgsClassificationCustom

QgsClassificationCustom is a dummy implementation of QgsClassification which does not compute any break.

QgsClassificationEqualInterval

QgsClassificationEqualInterval is an implementation of QgsClassificationMethod for equal intervals

QgsClassificationFixedInterval

Implementation of a fixed interval classification.

QgsClassificationJenks

QgsClassificationJenks is an implementation of QgsClassificationMethod for natural breaks based on Jenks

QgsClassificationLogarithmic

Implementation of a logarithmic scale method

QgsClassificationMethod

QgsClassificationMethod is an abstract class for implementations of classification methods

QgsClassificationMethodRegistry

This class manages all known classification methods

QgsClassificationPrettyBreaks

QgsClassificationPrettyBreaks is an implementation of QgsClassificationMethod for pretty breaks

QgsClassificationQuantile

QgsClassificationQuantile is an implementation of QgsClassificationMethod based on quantiles

QgsClassificationRange

QgsClassificationRange contains the information about a classification range

QgsClassificationStandardDeviation

QgsClassificationCustom is an implementation of QgsClassificationMethod based on standard deviation

Coordinate Systems and Transformations

QgsCelestialBody

Contains information about a celestial body.

QgsCoordinateReferenceSystem

This class 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

Class for doing transforms between two map 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

The QgsAbstractDatabaseProviderConnection class provides common functionality for DB based connections.

QgsAbstractDbTableModel

The QgsAbstractDbTableModel class is a pure virtual model class for results in a database source widget selector

QgsAbstractProviderConnection

The QgsAbstractProviderConnection provides an interface for data provider connections.

QgsDataProvider

Abstract base class for spatial data provider implementations.

QgsMeshDriverMetadata

Holds metadata about mesh driver

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

Class for parsing and evaluation of expressions (formerly called “search strings”). The expressions try to follow both syntax and semantics of SQL expressions.

QgsExpressionContextUtils

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

QgsExpressionFunction

A 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 it 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

A 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. This differs from a standard QgsExpression.Function in that it requires an implemented clone() method.

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

Class for QgsExternalStorage fetched content

QgsExternalStorageRegistry

Registry of external storage backends used by QgsExternalResourceWidget

QgsExternalStorageStoredContent

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 connection to a GPS device

QgsGpsConnectionRegistry

A class to register / unregister existing GPS connections such that the information is available to all classes and plugins.

QgsGpsDetector

Class to detect the GPS port

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.

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

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 features, or polygon features which are labeled in the “around” or “over” centroid placement modes.

QgsLabelPosition

Represents the calculated placement of a map label.

QgsLabelSearchTree

A class to query the labeling structure at a given point (small wrapper around pal RTree class)

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

Class that 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 prevents labels being placed too close or to 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

Produces legend node with a marker symbol

QgsImageLegendNode

Implementation of legend node interface for displaying arbitrary raster

QgsLayerTree

Namespace with helper functions for layer tree operations.

QgsLayerTreeFilterProxyModel

QgsLayerTreeFilterProxyModel is 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

The QgsLayerTreeModel class is model implementation for Qt item views framework.

QgsLayerTreeModelLegendNode

The QgsLegendRendererItem class is abstract interface for legend items returned from QgsMapLayerLegend implementation.

QgsLayerTreeNode

This class is a base class for nodes in a layer tree.

QgsLayerTreeRegistryBridge

Listens to the updates in map layer registry and does changes in layer tree.

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

QgsSimpleLegendNode

Implementation of legend node interface for displaying arbitrary label with icon.

QgsSymbolLegendNode

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

QgsVectorLabelLegendNode

Produces legend node for a labeling text symbol

QgsWmsLegendNode

Implementation of legend node interface for displaying WMS legend

Locator Bar

QgsLocator

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

QgsLocatorAutomaticModel

A QgsLocatorModel which has 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

The QgsLocatorModelBridge class 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

This class is responsible for keeping 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 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. This can be used to draw maps without blocking the QGIS interface.

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 to interpolate 3d stacked mesh data to 2d data

QgsMesh3DDataBlock

QgsMesh3DDataBlock is 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

QgsMeshDataBlock is a block of integers/doubles that can be used to retrieve: active flags (e.g. face’s active integer flag) scalars (e.g. scalar dataset double values) vectors (e.g. vector dataset doubles x,y values)

QgsMeshDataProvider

Base class for providing data for QgsMeshLayer

QgsMeshDataProviderTemporalCapabilities

Class for handling properties relating to a mesh data provider’s temporal capabilities.

QgsMeshDataSourceInterface

Interface for mesh data sources

QgsMeshDataset

Abstract class that represents a dataset

QgsMeshDatasetGroup

Abstract class that represents a dataset group

QgsMeshDatasetGroupMetadata

QgsMeshDatasetGroupMetadata is 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. Dataset group is set of datasets with the same name, but different control variable (e.g. time)

QgsMeshDatasetIndex

QgsMeshDatasetIndex is 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

QgsMeshDatasetMetadata is a collection of mesh dataset metadata such as whether the data is valid or associated time for the

QgsMeshDatasetSourceInterface

Interface for mesh datasets and dataset groups

QgsMeshDatasetValue

QgsMeshDatasetValue represents single dataset value.

QgsMeshEditForceByLine

Class derived from QgsMeshAdvancedEditing that forces mesh based on a line

QgsMeshEditForceByPolylines

Class derived from QgsMeshEditForceByLine that forces mesh based on polyline.

QgsMeshEditRefineFaces

Class that can do a refinement of faces of a mesh.

QgsMeshEditingError

Class that represents an error during mesh editing

QgsMeshEditor

Class that makes edit operation on a mesh

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

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 averages the values based on range defined relative to bed elevation or surface (when countedFromTop())

QgsMeshRendererMeshSettings

Represents a mesh renderer settings for mesh object

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

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

Class that can transform vertices of a mesh by expression

QgsMeshVectorTraceAnimationGenerator

A wrapper for QgsMeshParticuleTracesField used to render the particles. Available for Python binding

QgsTopologicalMesh

Class that wraps a QgsMesh to ensure the consistency of the mesh during editing and help to access to 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

Class for metadata formatter.

QgsLayerMetadataProviderRegistry

Registry of layer metadata provider backends.

QgsLayerMetadataProviderResult

Result record of layer metadata provider search. The result contains QGIS metadata information and all information that is required by QGIS to load the layer and to filter the results.

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 map layer.

Network Access

QgsBlockingNetworkRequest

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

QgsFetchedContent

FetchedContent holds useful information about a network content being

QgsFileDownloader

QgsFileDownloader is a utility class for downloading files.

QgsHttpHeaders

This class implements simple http header management.

QgsNetworkAccessManager

network access manager for QGIS

QgsNetworkContentFetcher

HTTP network content fetcher. A simple method for fetching remote HTTP content and converting the content to standard formats.

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 formatter which returns a simple text representation of a value.

QgsBearingNumericFormat

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

QgsCurrencyNumericFormat

A numeric formatter 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 formatter which returns a simple text representation of a value.

QgsFractionNumericFormat

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

QgsGeographicCoordinateNumericFormat

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

QgsNumericFormat

A numeric formatter allows for formatting a numeric value for display, using a variety of different formatting techniques (e.g. as scientific notation, currency values, percentage values, etc)

QgsNumericFormatContext

A context for numeric formats

QgsNumericFormatRegistry

The QgsNumericFormatRegistry manages registered classes of QgsNumericFormat.

QgsPercentageNumericFormat

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

QgsScientificNumericFormat

A numeric formatter 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

QgsDropShadowEffect

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

QgsEffectPainter

A class to manager painter saving and restoring required for effect

QgsEffectStack

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

QgsGlowEffect

Base class for paint effect 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 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

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

Class used to store 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.

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. This can be used to export a point cloud layer out to a provider without blocking the QGIS interface.

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

Class 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 then.

QgsProcessingParameterAlignRasterLayers

A parameter for Processing algorithms that need a list of input raster layers to align - this parameter provides Processing framework’s adapter for QList<QgsAlignRaster.Item>.

QgsProcessingParameterAnnotationLayer

An annotation layer parameter for processing algorithms.

QgsProcessingParameterArea

A double numeric parameter for area values. Linked to a source layer or CRS parameter to determine what units the area values are in.

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, for selection between available coordinate operations to use when projecting between a source and destination coordinate reference system.

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, allowing users to select from existing database tables on a registered database connection (or optionally to enter a new table name).

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. Linked to a source layer or CRS parameter to determine what units the distance values are in.

QgsProcessingParameterDuration

A double numeric parameter for duration values. The returned value will always be in milliseconds.

QgsProcessingParameterDxfLayers

A parameter for Processing algorithms that need a list of input vector layers to export as DXF file - this parameter provides Processing framework’s adapter for QList<QgsDxfExport.DxfLayer>.

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

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. Consider using the more versatile QgsProcessingParameterFeatureSource wherever possible.

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 - this parameter provides processing framework’s adapter for QList<QgsVectorTileWriter.Layer>.

QgsProcessingParameterVolume

A double numeric parameter for volume values. Linked to a source layer or CRS parameter to determine what units the volume values are in.

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

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

Class to 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

A class to describe 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

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

Manipulates raster or point cloud pixel values so that they enhanceContrast or clip into a specified numerical range according to the specified ContrastEnhancementAlgorithm.

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

The QgsRasterAttributeTable class 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

This is 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. This can be used to save a raster layer out to a file without blocking the QGIS interface.

QgsRasterHistogram

The QgsRasterHistogram is a container for histogram of a single raster band. It is used to cache computed histograms in raster providers.

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.

QgsRasterLayerTemporalProperties

Implementation of map layer temporal properties for raster layers.

QgsRasterLayerUtils

Contains utility functions for working with raster layers.

QgsRasterMinMaxOrigin

This class describes the origin of min/max values. It does not store by itself the min/max values.

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

Raster values range container. Represents range of values between min and max including 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. AKA “South African” style.

QgsNumericScaleBarRenderer

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

QgsScaleBarRenderer

Abstract base class for scale bar renderers.

QgsScaleBarRendererRegistry

The QgsScaleBarRendererRegistry manages registered scalebar renderers.

QgsScaleBarSettings

The QgsScaleBarSettings class 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 sensor classes

QgsIODeviceSensor

An abstract class QIODevice-based sensor classes

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

This class is a composition of two QSettings instances:

QgsSettingsEntryBase

Represent settings entry and provides methods for reading and writing settings values. Different subclasses are provided for different settings types with metainformations to validate set values and provide more accurate settings description for the gui.

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 setting 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

QgsSettingsRegistry is used for settings introspection and collects a list of child QgsSettingsRegistry and a list of child QgsSettingsRegistry

QgsSettingsRegistryCore

QgsSettingsRegistryCore is used for settings introspection and collects all QgsSettingsEntry instances of core.

QgsSettingsTree

QgsSettingsTree holds the tree structure for the settings in QGIS core

QgsSettingsTreeNamedListNode

QgsSettingsTreeNamedListNode is a named list tree node for the settings tree to help organizing and introspecting the tree. the named list node is used to store a group of settings under a dynamically named key.

QgsSettingsTreeNode

QgsSettingsTreeNode is 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

Constructor for QgsCategorizedSymbolRenderer.

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 Collection: logical collection of subcollections and color ramps

QgsCptCityColorRampItem

Item that represents a layer that can be opened with one of the

QgsCptCityDataItem

Base class for all items in the model

QgsCptCityDirectoryItem

A directory: contains subdirectories and color ramps

QgsCptCitySelectionItem

A selection: contains subdirectories and color ramps

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

Constructs a font marker symbol layer.

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 polygon renderers generating texture images

QgsInterpolatedLineColor

Class defining color to render mesh datasets. The color can vary depending on the dataset value.

QgsInterpolatedLineRenderer

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

QgsInterpolatedLineSymbolLayer

A symbol layer that represents vector layer line feature as interpolated line The interpolation is done between two values defined at the

QgsInterpolatedLineWidth

Represents a width than can vary depending on values

QgsInvertedPolygonRenderer

QgsInvertedPolygonRenderer is a polygon-only feature renderer used to display features inverted, where the exterior is turned to an interior and where the exterior theoretically spans the entire plane, allowing to mask the surroundings of some features.

QgsLegendSymbolItem

The class stores information about one class/rule of a vector layer renderer in a unified way that can be used by 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 accordingly 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

QgsMergedFeatureRenderer is a polygon or line-only feature renderer used to renderer 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 class for filling symbols 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

Creates a renderer symbol range

QgsRendererRangeLabelFormat

Deprecated since version 3.10.

QgsRendererRegistry

Registry of renderers.

QgsRuleBasedRenderer

Rule based renderer.

QgsSVGFillSymbolLayer

A class for filling symbols with a repeated SVG file.

QgsShapeburstFillSymbolLayer

Constructor for QgsShapeburstFillSymbolLayer.

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 an stroke.

QgsSimpleMarkerSymbolLayerBase

Abstract base class for simple marker symbol layers. Handles creation of the symbol shapes but leaves the actual drawing of the symbols to subclasses.

QgsSingleSymbolRenderer

Constructor for QgsSingleSymbolRenderer.

QgsStyle

Constructor for QgsStyle, with the specified parent object.

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

Constructs SVG marker symbol layer with picture from given absolute path to a SVG file

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

Constructor for QgsSymbolLayer.

QgsSymbolLayerAbstractMetadata

Stores metadata about one symbol layer class.

QgsSymbolLayerId

We may need stable references to symbol layers, when pointers to symbol layers is 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

QgsSymbolRenderContext

Constructor for QgsSymbolRenderContext

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

This class 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

Class allowing to manage 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

QgsVectorDataProvider

This is the 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 data sets.

QgsVectorLayerCache

This class caches features of 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

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. This can be used to export a vector layer out to a provider without blocking the QGIS interface.

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

Methods in this class are used to handle basic operations on vector layers. With an implementation of this class, parts of the application can ask for an operation to be done and the implementation will then take care of it.

QgsVectorLayerToolsContext

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

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 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 transaction group mode.

QgsVectorLayerUndoPassthroughCommandChangeAttribute

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

QgsVectorLayerUndoPassthroughCommandChangeAttributes

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

QgsVectorLayerUndoPassthroughCommandChangeGeometry

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

QgsVectorLayerUndoPassthroughCommandDeleteAttribute

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

QgsVectorLayerUndoPassthroughCommandDeleteFeatures

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

QgsVectorLayerUndoPassthroughCommandRenameAttribute

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

QgsVectorLayerUndoPassthroughCommandUpdate

Undo command for running a specific sql query in 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. It contains a definition of a list of labeling styles, where each labeling style is a combination of sub-layer name, geometry type, filter expression, zoom range and label settings.

QgsVectorTileBasicLabelingStyle

Configuration of a single style within QgsVectorTileBasicLabeling

QgsVectorTileBasicRenderer

The default vector tile renderer implementation. It has an ordered list of “styles”, each defines a rendering rule.

QgsVectorTileBasicRendererStyle

Definition of map rendering of a subset of vector tile data. The subset of data is defined by:

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

Random utility functions for working with vector tiles

QgsVectorTileWriter

Takes care of writing vector tiles.

QgsVtpkTiles

Utility class for reading and writing ESRI VTPK files.