core¶
Context manager used to block project setDirty calls. |
|
The |
|
Abstract base class for cache indices |
|
A QObject derived base class for |
|
Base class for entries in a |
|
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. |
Base class that can be used for any class that is capable of returning |
|
Abstract base class for simplify geometries using a specific algorithm |
|
Abstract base class for |
|
Utility class for calculating aggregates for a field (or expression) over the features from a vector layer. |
|
The |
|
Animated icon is keeping an animation running if there are listeners connected to frameChanged |
|
Extends QApplication to provide access to QGIS specific resources such as theme paths, database paths etc. |
|
Class allowing to manage the zip/unzip actions |
|
This is a container for configuration of the attribute table. The configuration is specific for one vector layer. |
|
Class providing some utility methods to manage auxiliary storage. |
|
Utilities for calculating bearings and directions. |
|
A thread safe class for performing blocking (sync) execution of external processes. |
|
Represents a spatial bookmark, with a name, CRS and extent. |
|
Manages storage of a set of bookmarks. |
|
Implements a model for the contents of |
|
A QSortFilterProxyModel subclass for sorting the entries in a |
|
Delivers features from the cache |
|
Uses another iterator as backend and writes features to the cache |
|
The |
|
A class to trim lines and polygons to within a rectangular region. |
|
Color ramp utilising “Color Brewer” preset color schemes. |
|
Abstract base class for color ramps |
|
|
|
Abstract base class for color schemes |
|
Registry of color schemes |
|
Contains utility functions for working with colors. |
|
Utils class for QGIS command line tools. |
|
The |
|
Conditional styling for a rule. |
|
A registry for saved data provider connections, allowing retrieval of saved connections by name and provider type. |
|
Contains methods for converting coordinates for display in various formats. |
|
Task to copy a file on disk |
|
A color ramp from the CPT City collection. |
|
Interface for requesting credentials in QGIS in GUI independent way. |
|
Implementation of credentials interface for the console |
|
Default implementation of credentials interface |
|
Custom exception class for Coordinate Reference System related exceptions. |
|
Handles scaling of input values to output values by using a curve created from smoothly joining a number of set control points. |
|
A color scheme which contains custom colors set through QGIS app options dialog. |
|
Emits dart measurements for display in CDash reports. |
|
Object that keeps configuration of appearance of marker symbol’s data-defined size in legend. |
|
Base class for handling elevation related properties for a data provider. |
|
Base class for handling properties relating to a data provider’s temporal capabilities. |
|
Class for storing the component parts of a RDBMS data source URI (e.g. a Postgres data source). |
|
A class that implements a custom filter and can be used as a proxy for |
|
Handles logging of database queries. |
|
Encapsulates a logged database query. |
|
A model containing schemas from a database connection. |
|
A model containing tables from a database connection. |
|
Constructor for QgsTemporalRange. The |
|
Constructor for QgsTemporalRange. The |
|
Calculator for summary statistics and aggregates for a list of datetimes. |
|
Default legend implementation for mesh layers |
|
Default legend implementation for point cloud layers |
|
Default legend implementation for raster layers |
|
The |
|
Default legend implementation for vector layers |
|
Additional diagram settings for interpolated size rendering. |
|
Stores the settings for rendering of all diagrams for a layer. |
|
Evaluates and returns the diagram settings relating to a diagram for a specific feature. |
|
Stores the settings for rendering a single diagram. |
|
A general purpose distance and area calculator, capable of performing ellipsoid based calculations. |
|
|
|
Holder for the widget type and its configuration for a field. |
|
Stores digital elevation model in a raster image which may get updated as a part of map layer rendering process. |
|
This class can render elevation shading on an image with different methods (eye dome lighting, hillshading, …). |
|
Contains utility methods for working with elevation from layers and projects. |
|
A container for error messages. |
|
|
|
Defines a QGIS exception class. |
|
Expression contexts are used to encapsulate the parameters around which a |
|
Abstract interface for generating an expression context. |
|
Single scope for storing variables and functions for use within a |
|
Abstract interface for generating an expression context scope. |
|
Buffers information about expression fields for a vector layer. |
|
The feature class encapsulates a single feature including its unique ID, geometry and a list of field/values attributes. |
|
Provides a list of features based on filter conditions. Features are fetched asynchronously. |
|
Abstract interface for use by classes that filter the features or attributes of a layer. |
|
Wrapper for iterator of features from vector data provider or vector |
|
Provides a list of features based on filter conditions. Features are fetched asynchronously. |
|
Provides a list of features based on filter conditions. |
|
This class wraps a request for features to a vector layer (or directly its vector data provider). |
|
An interface for objects which accept features via addFeature(s) methods. |
|
An interface for objects which provide features via a getFeatures method. |
|
A container for features with the same fields and crs. |
|
Base class for feedback objects to be used for cancellation of something running in a worker thread. |
|
Encapsulate a field in an attribute table or data source. |
|
Stores information about constraints which may be present on a field. |
|
A field formatter helps to handle and display values for a field. |
|
A context for field formatter containing information like the project |
|
The |
|
The |
|
The |
|
Container of fields for a vector layer. |
|
Abstract interface for classes which generate a file filter string. |
|
Class for file utilities. |
|
Contains utility functions for working with fonts. |
|
|
|
The |
|
Constructor for QgsGeometryValidator. |
|
This class reads data from a WFS server or alternatively from a GML file. |
|
Description of feature class in GML |
|
A color scheme which stores its colors in a gpl palette file. |
|
Gradient color ramp, which smoothly interpolates between two colors and also supports optional extra color stops. |
|
Represents a color stop within a |
|
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. |
|
Calculator for a numeric histogram from a list of values. |
|
Class for HTML utilities. |
|
Contains utility functions for working with icons. |
|
Identify contexts are used to encapsulate the settings to be used to perform an identify action. |
|
A cache for images derived from raster files. |
|
|
|
A representation of the interval between two datetime values. |
|
Handles exporting |
|
Helper utilities for working with JSON and GeoJSON conversions. |
|
Label blocking region (in map coordinates and CRS). |
|
The |
|
Contains utility functions for working with layer notes. |
|
Renders a layout to an image and compares with an expected output |
|
Handles automatic layout and rendering of legends. |
|
The |
|
Contains detailed styling information relating to how a layout legend should be rendered. |
|
Constrained random color ramp, which returns random colors based on preset parameters. |
|
Alters the size of rendered diagrams using a linear scaling. |
|
Contains local default settings which should be respected when creating new objects such as |
|
A registry class to hold localized data paths which can be used for basemaps, logos, etc. |
|
|
|
A map clipping region (in map coordinates and CRS). |
|
Utility functions for use when clipping map renders. |
|
Interface for map decorations. |
|
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. |
|
Executes a |
|
Base class for all map layer types. This is the base class for all map layer types (vector, raster). |
|
This class models dependencies with or between map layers. |
|
Base class for storage of map layer elevation properties. |
|
Contains utility functions for creating map layers. |
|
The |
|
Miscellaneous utility functions for handling of map layer legend |
|
The |
|
The |
|
Base class for utility classes that encapsulate information necessary for rendering of map layers. |
|
Base class for storage of map layer selection properties. |
|
Manages QGIS Server properties for a map layer |
|
A storage object for map layers, in which the layers are owned by the store and have their lifetime bound to the store. |
|
Stores style information (renderer, opacity, labeling, diagrams etc.) applicable to a map layer. |
|
Management of styles for use with one map layer |
|
Restore overridden layer style on destruction. |
|
Base class for storage of map layer temporal properties. |
|
Contains utility functions for working with map layers. |
|
The |
|
Utilities for map settings. |
|
Container class that allows storage of map themes consisting of visible map layers and layer styles. |
|
Perform transforms between map coordinates and device coordinates. |
|
Implementation of GeometrySimplifier using the “MapToPixel” algorithm |
|
Struct for storing maximum and minimum scales for measurements in map |
|
Constructs a margins object with all margins set to 0. |
|
This class allows the creation of mask ids based on the different label layers and to give a mask id from a label layer. |
|
Contains settings regarding how masks are calculated and handled during a map render. |
|
A simple 4x4 matrix implementation useful for transformation in 3D space. |
|
Interface for logging messages from QGIS in GUI independent way. |
|
Default implementation of message logging interface |
|
Temporarily blocks the application |
|
Interface for showing messages from QGIS in GUI independent way. |
|
Default implementation of message output interface |
|
Contains utility functions for working with MIME data. |
|
This class allows checking rendered images against comparison images. |
|
Custom exception class which is raised when an operation is not supported. |
|
Simple key-value store (keys = strings, values = variants) that supports loading/saving to/from XML in verbatim <customproperties> endverbatim element. |
|
Handles logic relating to synchronizing online and offline copies of layer data. |
|
The |
|
An expression with an additional enabled flag. |
|
|
|
Connections management |
|
Resolves relative paths into absolute paths and vice versa. Used for |
|
Base class for plugin layers. These can be implemented by plugins and registered in |
|
A registry of plugin layers types. |
|
Class for creating plugin specific layers |
|
The class defines interface for querying point location: |
|
A class to represent a 2D point. |
|
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. |
|
The |
|
A scheme based color ramp consisting of a list of predefined colors. |
|
Custom exception class for processing related exceptions. |
|
Class allowing to manage the zip/unzip actions on project file |
|
A color scheme which contains project specific colors set through project properties dialog. |
|
A store for object properties. |
|
A grouped map of multiple |
|
An ordered stack of |
|
Definition for a property. |
|
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. |
|
Custom exception class for provider connection related exceptions. |
|
A model containing registered connection names for a specific data provider. |
|
A simple feature sink which proxies feature addition on to another feature sink. |
|
A |
|
Utility class for running Python commands from various parts of QGIS. |
|
The |
|
Totally random color ramp. Returns colors generated at random, but constrained to some hardcoded saturation and value ranges to prevent ugly color generation. |
|
A template based class for storing ranges (lower to upper values). |
|
A template based class for storing ranges (lower to upper values). |
|
The class is used as a container of context for various read/write operations on other objects. |
|
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. |
|
The |
|
A color scheme which contains the most recently used colors. |
|
Handles and tracks style items recently used in the QGIS GUI. |
|
Represents a relationship between two vector layers. |
|
Context for relations. Used to resolve layers from projects. |
|
This class manages a set of relations between layers. |
|
A |
|
Defines the parameters used to remap features when creating a |
|
This is a helper class for unit tests that need to write an image and compare it to an expected result or render time. |
|
Contains information about the context of a rendering operation. |
|
An interface for classes which provider custom handlers for features rendered as part of a map render job. |
|
Base class for detailed information about a rendered item. |
|
A class that executes an external program/script. |
|
Provides a method of recording run time profiles of operations, allowing easy recording of their overall run time. |
|
Class for parsing SQL statements. |
|
Class for parsing fragments of SQL statements, such as an expression or where clause. |
|
Calculates scale for a given combination of canvas size, map extent, and monitor dpi. |
|
Contains utility functions for working with map scales. |
|
Scoped |
|
Scoped object for logging of the runtime for a single operation or group of operations. |
|
Stores properties relating to a screen. |
|
Encapsulates the context of a layer selection operation. |
|
Manages QGIS Server properties for a map layer |
|
Manages QGIS Server properties for Wms dimensions |
|
Custom exception class for settings related exceptions. |
|
This class contains information about how to simplify geometries fetched from a |
|
Renders the diagrams for all features with the same settings |
|
A |
|
|
|
The |
|
This is a container for configuration of the snapping of the project |
|
This class has all the configuration of snapping and can return answers to snapping queries. |
|
A cache for source strings that returns a local file path containing the source content. |
|
A spatial index for |
|
A very fast static spatial index for 2D points based on a flat KD-tree. |
|
A container for data stored inside a |
|
Contains utilities for working with Sqlite data sources. |
|
Renders diagrams using mixed diagram render types. The size of the rendered diagram is given by a combination of subrenderers. |
|
Calculator for summary statistics for a list of doubles. |
|
Stored expression containing name, content (expression text) and a category tag. |
|
Manages stored expressions regarding creation, modification and storing in the project |
|
A representation of a single string replacement. |
|
A collection of string replacements (specified using |
|
Calculator for summary statistics and aggregates for a list of strings. |
|
Utility functions for working with strings. |
|
Encapsulates the contents and formatting of a single table cell. |
|
Abstract base class for long running background tasks. |
|
Task manager for managing a set of long-running |
|
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. |
|
A controller base class for temporal objects, contains a signal for notifying updates of the objects temporal range. |
|
Implements a temporal controller based on a frame by frame navigation and animation. |
|
Base class for temporal property. |
|
Base class for objects with an associated (optional) temporal range. |
|
Contains utility methods for working with temporal layers and projects. |
|
Class that takes care of tessellation of polygons into triangles. |
|
Defines a matrix of tiles for a single zoom level: it is defined by its size (width * height) and map extent that it covers. |
|
Defines a set of tile matrices for multiple zoom levels. |
|
Range of tiles in a tile matrix to be rendered. The selection is rectangular, given by start/end row and column numbers. |
|
Stores coordinates of a tile in a tile matrix set. |
|
This is the class is providing tolerance value in map unit values. |
|
Implementation of GeometrySimplifier using the Douglas-Peucker algorithm |
|
Utility class that construct a planar graph from the input vector layers and provides shortest path search for tracing of existing features. |
|
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. |
|
Constructor for QgsTransactionGroup |
|
Used for the collecting of strings from projects for translation and creation of ts files. |
|
Helper functions for various unit types. |
|
Represents a default, “not-specified” value for a feature attribute. |
|
A color scheme which stores its colors in a gpl palette file within the “palettes” subfolder off the user’s QGIS settings folder. |
|
User profile contains information about the user profile folders on the machine. |
|
User profile manager is used to manager list, and manage user profiles on the users machine. |
|
Contains utility functions for working with QVariants and QVariant types. |
|
A class to represent a vector. Currently no Z axis / 2.5D support is implemented. |
|
Class for storage of 3D vectors similar to QVector3D, with the difference that it uses double precision instead of single precision floating point numbers. |
|
A convenience class for writing vector layers to disk based formats (e.g. Shapefiles, GeoPackage). |
|
|
|
This class contains information how to simplify geometries fetched from a vector layer |
|
Class to manipulate the definition of a virtual layer |
|
Utils class for |
|
Initializes a virtual layer with postpone mode activated and reloads the data in a separated thread. |
|
The |
|
Assorted helper methods for reading and writing chunks of XML |
|
Push a category to the stack |
|
Context manager used to profile blocks of code in the QgsApplication.profiler() registry. |
|
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. |
|
Constructs QgsAbstractValidityChecks using a decorator. |
|
Compare two WKT strings with some tolerance |
|
Returns the QMetaEnum for an enum type. The enum must have declared using the Q_ENUM macro |
|
Returns the QMetaEnum for an enum value. The enum must have declared using the Q_ENUM macro |
|
Hash for QVariant |
|
Compare two doubles (but allow some difference) |
|
Compare two doubles using specified number of significant digits |
|
Returns a string representation of a double |
|
Compare two floats (but allow some difference) |
|
Compare two doubles, treating nan values as equal |
|
Converts a string to a double in a permissive way, e.g., allowing for incorrect numbers of digits between thousand separators |
|
Converts a string to an integer in a permissive way, e.g., allowing for incorrect numbers of digits between thousand separators |
|
Converts a string to an qlonglong in a permissive way, e.g., allowing for incorrect numbers of digits between thousand separators |
|
Returns a double |
|
Compares two QVariant values. |
|
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 |
|
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) |
|
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) |
|
Decorator function used to define a user expression function. |
|
Register a Python function to be used as a expression function. |
|
Utilitary function to parse a string originated from symbolLayerReferenceListToString into a |
|
Utilitary function to turn a |
3D¶
Base metadata class for 3D renderers. Instances of derived classes may be registered in Qgs3DRendererRegistry. |
|
Keeps track of available 3D renderers. Should be accessed through |
|
Stores metadata about one 3D symbol class. |
|
Registry of available 3D symbol classes. |
|
Base class for all renderers that may to participate in 3D view. |
|
Abstract base class for 3D symbols that are used by VectorLayer3DRenderer objects. |
|
Base class for point cloud 3D renderers. |
Annotations and Annotation Layers¶
Abstract base class for annotation item edit operations |
|
Abstract base class for annotation items which are drawn over a map. |
|
Abstract base class for annotation items which are drawn with |
|
Stores metadata about one annotation item class. |
|
Encapsulates the context for an annotation item edit operation. |
|
Annotation item edit operation consisting of adding a node |
|
Annotation item edit operation consisting of deleting a node |
|
Annotation item edit operation consisting of moving a node |
|
Encapsulates the transient results of an in-progress annotation edit operation. |
|
Annotation item edit operation consisting of translating (moving) an |
|
Contains information about a node used for editing an annotation item. |
|
Registry of available annotation item types. |
|
Represents a map layer containing a set of georeferenced annotations, e.g. markers, lines, polygons or text items. |
|
An annotation item which renders a line symbol along a line geometry. |
|
An annotation item which renders text along a line geometry. |
|
Manages storage of a set of |
|
An annotation item which renders a marker symbol at a point location. |
|
An annotation item which renders a picture. |
|
An annotation item which renders a text string at a point location. |
|
An annotation item which renders a fill symbol for a polygon geometry. |
|
Abstract base class for annotation items which render annotations in a rectangular shape. |
|
An annotation item which renders paragraphs of text within a rectangle. |
|
An annotation item that embeds HTML content. |
|
Contains information about a rendered annotation item. |
|
An annotation which renders the contents of an SVG file. |
|
An annotation item that displays formatted text from a QTextDocument document. |
Attribute Form Configuration¶
This element will load a layer action onto the form. |
|
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. |
|
This is an abstract base class for any elements of a drag and drop form. |
|
This element will load a field’s widget onto the form. |
|
An attribute editor widget that will represent arbitrary HTML code. |
|
An attribute editor widget that will represent arbitrary QML code. |
|
This element will load a relation editor onto the form. |
|
An attribute editor widget that will represent a spacer. |
|
An attribute editor widget that will represent arbitrary text code. |
|
Contains configuration settings for an editor form. |
Authentication Framework¶
Utilities for working with certificates and keys |
|
Configuration container for SSL server connection exceptions or |
|
Abstract class that defines the interface for all authentication configuration storage implementations. |
|
QSqlDatabase based implementation of |
|
Registry for authentication configuration storages. |
|
Singleton offering an interface to manage the authentication configuration database and to utilize configurations through various authentication method plugins |
|
Abstract base class for authentication method plugins |
|
Configuration storage class for authentication method configurations |
|
Storage set for PKI bundle: SSL certificate, key, optional CA cert chain |
|
Storage set for constructed SSL certificate, key, associated with an authentication config |
Browser¶
A model for showing available data sources and other items in a structured tree. |
|
A QSortFilterProxyModel subclass for filtering and sorting browser model items. |
|
A Collection that represents a root group of connections from a single data provider |
|
A Collection: logical collection of layers or subcollections, e.g. GRASS location/mapset, database? wms source? |
|
Base class for all items in the model. |
|
This is the interface for those who want to add custom data items to the browser tree. |
|
This class keeps a list of data item providers that may add items to the browser tree. |
|
A Collection that represents a database schema item |
|
A directory: contains subdirectories and layers |
|
Browser parameter widget implementation for directory items. |
|
Data item that can be used to report problems (e.g. network error) |
|
Contains various Favorites directories |
|
A browser item representing a field domain. |
|
Contains a collection of field domain items. |
|
A data item representing a single field from a layer. |
|
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. |
|
Item that represents a layer that can be opened with one of the |
|
Data item that can be used to represent QGIS projects. |
|
A browser item representing a relationship. |
|
Contains a collection of relationship items. |
|
A zip file: contains layers, using GDAL/OGR VSIFILE mechanism |
Classification Methods¶
|
|
|
|
Implementation of a fixed interval classification. |
|
|
|
Implementation of a logarithmic scale method |
|
|
|
This class manages all known classification methods |
|
|
|
|
|
|
|
|
Coordinate Systems and Transformations¶
Contains information about a celestial body. |
|
This class represents a coordinate reference system (CRS). |
|
A registry for known coordinate reference system (CRS) definitions, including any user-defined CRSes. |
|
Utility functions for working with |
|
Class for doing transforms between two map coordinate systems. |
|
Contains information about the context in which a coordinate transform is executed. |
|
Contains information about a datum ensemble. |
|
Contains information about a member of a datum ensemble. |
|
Contains methods and classes relating the datum transformations. |
|
Contains utility functions for working with ellipsoids and querying the ellipsoid database. |
|
Contains information about a PROJ operation. |
|
Utility functions for working with the proj library. |
|
contains various cartographic properties, such as scale factors, angular distortion and meridian convergence. |
DXF Exports¶
Exports QGIS layers to the DXF format. |
Data Providers¶
The |
|
The |
|
The |
|
Abstract base class for spatial data provider implementations. |
|
Holds metadata about mesh driver |
|
A registry / canonical manager of data providers. |
|
Provides an interface for provider-specific creation of SQL queries. |
|
Contains details about a sub layer available from a dataset. |
|
A model for representing the sublayers present in a URI. |
|
A QSortFilterProxyModel for filtering and sorting a |
|
A |
|
Contains utility functions for working with data providers. |
Data Providers - ArcGIS¶
Utility functions for working with ArcGIS REST services. |
|
Contains the context of a ArcGIS REST service operation. |
|
Utility functions for working with ArcGIS REST services. |
Data Providers - Memory¶
Utility functions for use with the memory vector data provider. |
Data Providers - OGC Sensorthings¶
Encapsulates information about how relationships in a SensorThings API service should be expanded. |
|
Utility functions for working with OGC SensorThings API services. |
Diagrams and Charts¶
Base class for all diagram types. |
|
A histogram style diagram. |
|
A pie chart diagram. |
|
A stacked bar chart diagram. |
|
A diagram composed of several subdiagrams, located side by side. |
|
A text based diagram. |
Elevation Handling¶
Abstract base class for objects which generate elevation profiles. |
|
Abstract base class for storage of elevation profiles. |
|
Interface for classes which can generate elevation profiles. |
|
Abstract base class for terrain providers |
|
A terrain provider where the terrain is a simple flat surface. |
|
A terrain provider that uses the Z values of a mesh layer to build a terrain surface. |
|
Handles exports of elevation profiles in various formats. |
|
Handles exports of elevation profiles in various formats in a background task. |
|
Encapsulates the context in which an elevation profile is to be generated. |
|
Encapsulates the context of identifying profile results. |
|
Stores identify results generated by a |
|
Generates and renders elevation profile plots. |
|
Encapsulates a point on a distance-elevation profile. |
|
Abstract base class for storage of elevation profiles. |
|
Encapsulates properties and constraints relating to fetching elevation profiles from different sources. |
|
Encapsulates the context of snapping a profile point. |
|
Encapsulates results of snapping a profile point. |
|
Registry of profile sources used by |
|
A terrain provider where the terrain source is a raster DEM layer. |
Expression Engine¶
Class for parsing and evaluation of expressions (formerly called “search strings”). The expressions try to follow both syntax and semantics of SQL expressions. |
|
Contains utilities for working with |
|
A abstract base class for defining |
|
Abstract base class for all nodes that can appear in an expression. |
|
SQL-like BETWEEN and NOT BETWEEN predicates. |
|
A binary expression operator, which operates on two values. |
|
An expression node which takes it value from a feature’s field. |
|
An expression node for CASE WHEN clauses. |
|
An expression node for expression functions. |
|
An expression node for value IN or NOT IN clauses. |
|
A indexing expression operator, which allows use of square brackets [] to reference map and array items. |
|
An expression node for literal values. |
|
A unary node is either negative as in boolean (not) or as in numbers (minus). |
|
Expression function for use within a |
External Storage¶
Abstract interface for external storage - to be implemented by various backends and registered in |
|
Base class for |
|
Class for |
|
Registry of external storage backends used by |
|
Class for |
Field Value Formating¶
Field formatter for a checkbox field. |
|
Field formatter for a date time field. |
|
A default fallback field formatter in case no specialized field formatter is defined. |
|
Field formatter for a key value field. |
|
Field formatter for a list field. |
|
Field formatter for a range (double) field with precision and locale. |
|
Field formatter for a relation reference field. |
|
Field formatter for a ValueMap field. |
|
Field formatter for a value relation field. |
GPS and GNSS¶
Abstract base class for babel GPS formats. |
|
A registry for |
|
A babel format capable of interacting directly with a GPS device. |
|
A babel format capable of converting input files to GPX files. |
|
Abstract base class for connection to a GPS device |
|
A class to register / unregister existing GPS connections such that the information is available to all classes and plugins. |
|
Class to detect the GPS port |
|
Encapsulates information relating to a GPS position fix. |
|
Base class for objects which log incoming GPS data. |
|
Evaluates NMEA sentences coming from gpsd |
|
Evaluates NMEA sentences coming from a GPS device |
|
A GPS connection subclass based on the Qt Location libraries. |
|
Encapsulates information relating to a GPS satellite. |
|
Handles logging of incoming GPS data to a vector layer. |
Geocoding¶
An abstract base class which implements a locator filter populated from a |
|
Encapsulates the context of a geocoding operation. |
|
Interface for geocoders. |
|
Represents a matching result from a geocoder search. |
|
A geocoder which uses the Google Map geocoding API to retrieve results. |
|
A geocoder which uses the Nominatim geocoding API to retrieve results. |
Geometry¶
Abstract base class for all geometries |
|
An abstract base class for classes which transform geometries by transforming input points to output points. |
|
A 3-dimensional box composed of x, y, z coordinates. |
|
Circle geometry type. |
|
Circular string geometry type |
|
Compound curve geometry type |
|
A const WKB pointer. |
|
Abstract base class for curved geometry type |
|
Curve polygon geometry type |
|
Ellipse geometry type. |
|
A geometry is the spatial representation of a feature. |
|
Geometry collection |
|
Java-style iterator for const traversal of parts of a geometry |
|
A geometry engine is a low-level representation of a |
|
Encapsulates parameters under which a geometry operation is performed. |
|
Java-style iterator for traversal of parts of a geometry |
|
Contains various geometry utility functions. |
|
Convenience functions for geometry utils. |
|
Represents a single 2D line segment, consisting of a 2D start and end vertex only. |
|
Line string geometry type, with support for z-dimension and m-values. |
|
Multi curve geometry collection. |
|
Multi line string geometry collection. |
|
Multi point geometry collection. |
|
Multi polygon geometry collection. |
|
Multi surface geometry collection. |
|
Represents a oriented (rotated) box in 3 dimensions. |
|
Point geometry type, with support for z-dimension and m-values. |
|
Polygon geometry type. |
|
Polyhedral surface geometry type. |
|
Quadrilateral geometry type. |
|
A representation of a ray in 3D. |
|
A rectangle specified with double values. |
|
A |
|
A base class for geometry primitives which are stored with an associated reference system. |
|
A |
|
A |
|
Regular Polygon geometry type. |
|
A spherical geometry object. |
|
Surface geometry type. |
|
Triangle geometry type. |
|
Triangulated surface geometry type. |
|
Utility class for identifying a unique vertex within a geometry. |
|
Java-style iterator for traversal of vertices of a geometry |
|
WKB pointer handler. |
|
Handles storage of information regarding WKB types and their properties. |
Label Callouts¶
A cartoon talking bubble callout style. |
|
Abstract base class for callout renderers. |
|
Stores metadata about one callout renderer class. |
|
Convenience metadata class that uses static functions to create callouts and their widgets. |
|
Registry of available callout classes. |
|
Draws curved lines as callouts. |
|
Draws straight (right angled) lines as callouts. |
|
A simple direct line callout style. |
Labeling¶
Abstract base class - its implementations define different approaches to the labeling of a vector layer. |
|
Represents the calculated placement of a map label callout line. |
|
Represents a label candidate. |
|
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). |
|
Contains settings related to how the label engine treats features as |
|
Contains general settings related to how labels are placed. |
|
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. |
|
Represents the calculated placement of a map label. |
|
A class to query the labeling structure at a given point (small wrapper around pal RTree class) |
|
Contains settings related to how the label engine removes candidate label positions and reduces the number of displayed labels. |
|
Contains constants and enums relating to labeling. |
|
Stores global configuration for labeling engine |
|
Class that stores computed placement from labeling engine. |
|
PAL labeling utilities. |
|
Contains settings for how a map layer will be labeled. |
|
Rule based labeling for a vector layer. |
|
Basic implementation of the labeling interface. |
Labeling - Advanced Rules¶
Abstract base class for labeling engine rules. |
|
Base class for labeling engine rules which prevents labels being placed too close or to far from features from a different layer. |
|
Encapsulates the context for a labeling engine run. |
|
A labeling engine rule which prevents labels being placed overlapping features from a different layer. |
|
A labeling engine rule which prevents labels being placed too far from features from a different layer. |
|
A labeling engine rule which prevents labels being placed too close to features from a different layer. |
|
A labeling engine rule which prevents labels being placed too close to labels from a different layer. |
|
A registry for labeling engine rules. |
Layer Tree and Legends¶
A legend node which renders a color ramp. |
|
Settings for a color ramp legend node. |
|
Produces legend node with a marker symbol |
|
Implementation of legend node interface for displaying arbitrary raster |
|
Namespace with helper functions for layer tree operations. |
|
|
|
Contains settings relating to filtering the contents of |
|
Layer tree group node serves as a container for layers and further groups. |
|
Layer tree node points to a map layer. |
|
The |
|
The |
|
This class is a base class for nodes in a layer tree. |
|
Listens to the updates in map layer registry and does changes in layer tree. |
|
Assorted functions for dealing with layer trees. |
|
Represents a patch shape for use in map legends. |
|
Implementation of legend node interface for displaying raster legend |
|
Implementation of legend node interface for displaying arbitrary label with icon. |
|
Implementation of legend node interface for displaying preview of vector symbols and their labels and allowing interaction with the symbol / renderer. |
|
Produces legend node for a labeling text symbol |
|
Implementation of legend node interface for displaying WMS legend |
Locator Bar¶
Handles the management of |
|
A |
|
Encapsulates the properties relating to the context of a locator search. |
|
Abstract base class for filters which collect locator results. |
|
An abstract list model for displaying the results of locator searches. |
|
The |
|
A sort proxy model for |
|
Encapsulates properties of an individual matching result found by a |
Map Actions¶
Utility class that encapsulates an action based on vector attributes. |
|
Storage and management of actions associated with a layer. |
|
An action scope defines a “place” for an action to be shown and may add additional expression variables. |
|
The action scope registry is an application wide registry that contains a list of available action scopes. |
Map Rendering¶
Abstract base class for map renderer jobs which use custom painters. |
|
This class is responsible for keeping cache of rendered images resulting from a map rendering job. |
|
Job implementation that renders everything sequentially using a custom painter. |
|
Abstract base class for map rendering implementations. |
|
Job implementation that renders all layers in parallel. |
|
Intermediate base class adding functionality that allows client to query the rendered image. |
|
Job implementation that renders everything sequentially in one thread. |
|
|
|
Stores collated details of rendered items during a map rendering operation. |
Mesh Layers¶
Abstract base class - its implementations define different approaches to the labeling of a mesh layer. |
|
Mesh - vertices, edges and faces |
|
Abstract class to interpolate 3d stacked mesh data to 2d data |
|
|
|
Abstract class that can be derived to implement advanced editing on mesh |
|
Performs mesh layer calculations. |
|
|
|
Base class for providing data for |
|
Class for handling properties relating to a mesh data provider’s temporal capabilities. |
|
Interface for mesh data sources |
|
Abstract class that represents a dataset |
|
Abstract class that represents a dataset group |
|
|
|
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) |
|
|
|
|
|
Interface for mesh datasets and dataset groups |
|
|
|
Class derived from |
|
Class derived from |
|
Class that can do a refinement of faces of a mesh. |
|
Class that represents an error during mesh editing |
|
Class that makes edit operation on a mesh |
|
Elevation averaging method averages the values based on range defined absolute value to the model’s datum |
|
Represents a mesh layer supporting display of data on structured or unstructured meshes |
|
Mesh layer specific subclass of |
|
Basic implementation of the labeling interface for mesh layer. |
|
Implementation of map layer temporal properties for mesh layers. |
|
Multi level averaging method specifies limits of vertical layers from the top layer down or reversed. |
|
Relative height averaging method averages the values based on range defined relative to bed elevation or surface (when |
|
Represents a mesh renderer settings for mesh object |
|
Represents a mesh renderer settings for scalar datasets |
|
Represents all mesh renderer settings |
|
Represents a mesh renderer settings for vector datasets displayed with |
|
Represents a renderer settings for vector datasets |
|
Represents a streamline renderer settings for vector datasets displayed by streamlines |
|
Represents a trace renderer settings for vector datasets displayed by particle traces |
|
Represents a mesh renderer settings for vector datasets displayed with wind barbs |
|
Sigma averages over the values between 0 (bed level) and 1 (surface). |
|
A spatial index for |
|
Represents a mesh time settings for mesh datasets |
|
Class that can transform vertices of a mesh by expression |
|
A wrapper for |
|
Class that wraps a |
Metadata Handling¶
Layer metadata provider backend interface. |
|
An abstract base class for metadata stores. |
|
Abstract base class for metadata validators. |
|
A structured metadata store for a map layer. |
|
Class for metadata formatter. |
|
Registry of layer metadata provider backends. |
|
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. |
|
Container of result records from a layer metadata search. |
|
Metadata search context |
|
Contains utility functions for working with metadata. |
|
A validator for the native base QGIS metadata schema definition. |
|
A validator for the native QGIS layer metadata schema definition. |
|
A validator for the native QGIS project metadata schema definition. |
|
A structured metadata store for a map layer. |
Network Access¶
A thread safe class for performing blocking (sync) network requests, with full support for QGIS proxy and authentication settings. |
|
FetchedContent holds useful information about a network content being |
|
|
|
This class implements simple http header management. |
|
network access manager for QGIS |
|
HTTP network content fetcher. A simple method for fetching remote HTTP content and converting the content to standard formats. |
|
Registry for temporary fetched files |
|
Handles HTTP network content fetching in a background task. |
|
Encapsulates a network reply within a container which is inexpensive to copy and safe to pass between threads. |
|
Encapsulates parameters and properties of a network request. |
|
A model for published QGIS news feeds. |
|
Parser for published QGIS news feeds. |
|
A proxy model for use with |
Numeric Formats¶
A numeric formatter which returns a simple text representation of a value. |
|
A numeric formatter which returns a text representation of a direction/bearing. |
|
A numeric formatter which returns a text representation of a currency value. |
|
A numeric formatter which uses a |
|
A basic numeric formatter which returns a simple text representation of a value. |
|
A numeric formatter which returns a vulgar fractional representation of a decimal value (e.g. “1/2” instead of 0.5). |
|
A numeric formatter which returns a text representation of a geographic coordinate (latitude or longitude). |
|
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) |
|
A context for numeric formats |
|
The |
|
A numeric formatter which returns a text representation of a percentage value. |
|
A numeric formatter which returns a scientific notation representation of a value. |
PDF Rendering¶
Utility class for rendering PDF documents. |
Paint Effects¶
A paint effect which blurs a source picture, using a number of different blur methods. |
|
A paint effect which alters the colors (e.g., brightness, contrast) in a source picture. |
|
A paint effect which draws the source picture with minor or no |
|
A paint effect which draws an offset and optionally blurred drop shadow |
|
A class to manager painter saving and restoring required for effect |
|
A paint effect which consists of a stack of other chained paint effects |
|
Base class for paint effect which draw a glow inside or outside a picture. |
|
Contains operations and filters which apply to QImages |
|
A paint effect which draws a glow within a picture. |
|
A paint effect which draws an offset and optionally blurred drop shadow within a picture. |
|
A paint effect which draws a glow outside of a picture. |
|
Base class for visual effects which can be applied to QPicture drawings |
|
Stores metadata about a paint effect class. |
|
Registry of available paint effects. |
|
Base class for paint effects which offset, blurred shadows |
|
A paint effect which applies transformations (such as move, scale and rotate) to a picture. |
Painting Operations¶
A paint device which converts everything renderer to a |
|
Mask painter device that can be used to register everything painted into a QPainterPath used later as clip path |
|
Null painter device that can be used for map renderer jobs which use custom painters. |
|
Hack to workaround Qt #5114 by disabling PatternTransform |
|
Contains miscellaneous painting utility functions. |
Plot and Graph Rendering¶
Base class for 2-dimensional plot/chart/graphs. |
|
Base class for plot/chart/graphs. |
|
Encapsulates the properties of a plot axis. |
|
Manages default settings for plot objects |
Point Cloud Layers¶
Attribute for point cloud data pair of name and size in bytes |
|
An RGB renderer for 2d visualisation of point clouds using embedded red, green and blue attributes. |
|
Collection of point cloud attributes |
|
A model for display of available attributes from a point cloud. |
|
A proxy model for filtering available attributes from a point cloud attribute model. |
|
Class used to store statistics of one attribute of a point cloud dataset. |
|
Base class for storing raw data from point cloud nodes |
|
Represents an individual category (class) from a |
|
Renders point clouds by a classification attribute. |
|
Base class for providing data for |
|
A renderer for 2d visualisation of point clouds which shows the dataset’s extents using a fill symbol. |
|
Represents a map layer supporting display of point clouds |
|
Point cloud layer specific subclass of |
|
Handles exporting point cloud layers to memory layers, OGR supported files and PDAL supported files. |
|
|
|
Encapsulates the render context for a 2D point cloud rendering operation. |
|
Abstract base class for 2d point cloud renderers. |
|
Stores metadata about one point cloud renderer class. |
|
Convenience metadata class that uses static functions to create point cloud renderer and its widget. |
|
Registry of 2D renderers for point clouds. |
|
An RGB renderer for 2d visualisation of point clouds using embedded red, green and blue attributes. |
|
Class used to store statistics of a point cloud dataset. |
Print Layouts and Reports¶
An abstract base class for |
|
Base class for commands to undo/redo layout and layout object changes. |
|
An abstract base class for |
|
Base class for layouts, which can contain items such as maps, labels, scalebars, etc. |
|
Handles aligning and distributing sets of layout items. |
|
Class used to render |
|
A QGraphicsEffect subclass used for rendering layout items onto a scene with custom composition modes. |
|
Handles rendering and exports of layouts to various formats. |
|
Base class for frame items, which form a layout multiframe item. |
|
Contains settings relating to the appearance, spacing and offset for layout grids. |
|
Contains the configuration for a single snap guide used by a layout. |
|
Stores and manages the snap guides used by a layout. |
|
Filters |
|
Base class for graphical items within a |
|
Stores metadata about one layout item class. |
|
A layout table subclass that displays attributes from a vector layer. |
|
A layout item subclass for elevation profile plots. |
|
A container for grouping several |
|
A layout multiframe subclass for HTML content. |
|
A layout item subclass for text labels. |
|
A layout item subclass for map legends. |
|
A layout table subclass that displays manually entered (and formatted) content. |
|
Layout graphical items for displaying a map. |
|
Contains settings relating to clipping a layout map by the current atlas feature. |
|
An individual grid which is drawn above the map content in a |
|
A collection of grids which is drawn above the map content in a |
|
An item which is drawn inside a |
|
Contains settings relating to clipping a layout map by another layout item. |
|
A collection of map items which are drawn above the map content in a |
|
An individual overview which is drawn above the map content in a |
|
A collection of overviews which are drawn above the map content in a |
|
A layout item for showing marker symbols. |
|
Item representing the paper in a layout. |
|
A layout item subclass that displays SVG files or raster format images (jpg, png, …). |
|
Layout item for node based polygon shapes. |
|
Layout item for node based polyline shapes. |
|
Registry of available layout item types. |
|
Contains settings and helpers relating to a render of a |
|
A layout item subclass for scale bars. |
|
Layout item for basic filled shapes (e.g. rectangles, ellipses). |
|
A text table item that reads text from string lists |
|
Manages storage of a set of layouts. |
|
List model representing the print layouts and reports available in a layout manager. |
|
QSortFilterProxyModel subclass for |
|
This class provides a method of storing measurements for use in QGIS layouts using a variety of different measurement units. |
|
This class provides a method of converting |
|
A model for items attached to a layout. The model also maintains the z-order for the layout, and must be notified whenever item stacking changes. |
|
Abstract base class for layout items with the ability to distribute the content to several frames ( |
|
Stores metadata about one layout multiframe class. |
|
An abstract layout item that provides generic methods for node based shapes such as polygon or polylines. |
|
An object which handles north-arrow type behavior for layout items. |
|
A base class for objects which belong to a layout. |
|
A manager for a collection of pages in a layout. |
|
This class provides a method of storing points, consisting of an x and y coordinate, for use in QGIS layouts. Measurement units are stored alongside the position. |
|
Allows for filtering a |
|
Stores information relating to the current rendering settings for a layout. |
|
Stores information relating to the current reporting context for a layout. |
|
An interface for layout objects which can be stored and read from DOM elements. |
|
This class provides a method of storing sizes, consisting of a width and height, for use in QGIS layouts. Measurement units are stored alongside the size. |
|
Manages snapping grids and preset snap lines in a layout, and handles snapping points to the nearest grid coordinate/snap line when possible. |
|
A class to display a table in the print layout, and allow the table to span over multiple frames |
|
Stores properties of a column for a |
|
Styling option for a layout table cell |
|
Interface for layout objects which support undo/redo commands. |
|
An undo stack for |
|
Utilities for layouts. |
|
Item model implementation based on layer tree model for layout legend. |
|
Interface for master layout type objects, such as print layouts and reports. |
|
A named page size for layouts. |
|
A registry for known page sizes. |
|
Print layout, a |
|
Represents a report for use with the |
|
Current context for a report section. |
|
A report section consisting of a features |
|
A report section consisting of a single |
Processing Framework¶
Contains enumerations and other constants for use in processing algorithms and parameters. |
|
|
|
Abstract base class for processing algorithms. |
|
Contains basic properties for a Processing algorithm. |
|
Processing feedback subclass for use when batch processing. |
|
Contains information about the context in which a processing algorithm is executed. |
|
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. |
|
An abstract |
|
|
|
Encapsulates settings relating to a feature source input to a processing algorithm. |
|
Base class for providing feedback from a processing algorithm. |
|
An interface for layer post-processing handlers for execution following a processing algorithm operation. |
|
Processing feedback object for multi-step operations. |
|
A boolean output for processing algorithms. |
|
A conditional branch output for processing algorithms, which represents a possible model logic flow which branches out from this algorithm. |
|
Base class for the definition of processing outputs. |
|
A file output for processing algorithms. |
|
A folder output for processing algorithms. |
|
A HTML file output for processing algorithms. |
|
Encapsulates settings relating to a feature sink or output raster layer for a processing algorithm. |
|
A map layer output for processing algorithms, where layers may be either vector or raster. |
|
A multi-layer output for processing algorithms which create map layers, when the number and nature of the output layers is not predefined. |
|
A numeric output for processing algorithms. |
|
A pointcloud layer output for processing algorithms. |
|
A raster layer output for processing algorithms. |
|
A string output for processing algorithms. |
|
A variant output for processing algorithms, capable of storing any QVariant value. |
|
A vector layer output for processing algorithms. |
|
A vector tile layer output for processing algorithms. |
|
A parameter for “aggregate” configurations, which consist of a definition of desired output fields, types, and aggregate used to populate then. |
|
A parameter for Processing algorithms that need a list of input raster layers to align - this parameter provides Processing framework’s adapter for QList< |
|
An annotation layer parameter for processing algorithms. |
|
A double numeric parameter for area values. Linked to a source layer or CRS parameter to determine what units the area values are in. |
|
A string parameter for authentication configuration ID values. |
|
A raster band parameter for Processing algorithms. |
|
A boolean parameter for processing algorithms. |
|
A color parameter for processing algorithms. |
|
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. |
|
A coordinate reference system parameter for processing algorithms. |
|
A database schema parameter for processing algorithms, allowing users to select from existing schemas on a registered database connection. |
|
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). |
|
A datetime (or pure date or time) parameter for processing algorithms. |
|
Base class for the definition of processing parameters. |
|
A double numeric parameter for distance values. Linked to a source layer or CRS parameter to determine what units the distance values are in. |
|
A double numeric parameter for duration values. The returned value will always be in milliseconds. |
|
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< |
|
An enum based parameter for processing algorithms, allowing for selection from predefined values. |
|
An expression parameter for processing algorithms. |
|
A rectangular map extent parameter for processing algorithms. |
|
A feature sink output for processing algorithms. |
|
An input feature source (such as vector layers) parameter for processing algorithms. |
|
A vector layer or feature source field parameter for processing algorithms. |
|
A parameter for “field mapping” configurations, which consist of a definition of desired output fields, types, and expressions used to populate then. |
|
An input file or folder parameter for processing algorithms. |
|
A generic file based destination parameter, for specifying the destination path for a file (non-map layer) created by the algorithm. |
|
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. |
|
A geometry parameter for processing algorithms. |
|
A print layout parameter, allowing users to select a print layout. |
|
A print layout item parameter, allowing users to select a particular item from a print layout. |
|
Can be inherited by parameters which require limits to their acceptable data types. |
|
A map layer parameter for processing algorithms. |
|
A map theme parameter for processing algorithms, allowing users to select an existing map theme from a project. |
|
A table (matrix) parameter for processing algorithms. |
|
A parameter for processing algorithms that need a list of mesh dataset groups. |
|
A parameter for processing algorithms that need a list of mesh dataset index from time parameter. |
|
A mesh layer parameter for processing algorithms. |
|
A parameter for processing algorithms which accepts multiple map layers. |
|
A numeric parameter for processing algorithms. |
|
A point parameter for processing algorithms. |
|
A point cloud layer attribute parameter for Processing algorithms. |
|
A point cloud layer destination parameter, for specifying the destination path for a point cloud layer created by the algorithm. |
|
A point cloud layer parameter for processing algorithms. |
|
A data provider connection parameter for processing algorithms, allowing users to select from available registered connections for a particular data provider. |
|
A numeric range parameter for processing algorithms. |
|
A raster layer destination parameter, for specifying the destination path for a raster layer created by the algorithm. |
|
A raster layer parameter for processing algorithms. |
|
A double numeric parameter for map scale values. |
|
A string parameter for processing algorithms. |
|
A parameter for processing algorithms that need a list of input vector layers to construct a TIN. |
|
Makes metadata of processing parameters available. |
|
A vector layer destination parameter, for specifying the destination path for a vector layer created by the algorithm. |
|
A vector layer (with or without geometry) parameter for processing algorithms. Consider using the more versatile |
|
A vector tile layer destination parameter, for specifying the destination path for a vector tile layer created by the algorithm. |
|
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< |
|
A double numeric parameter for volume values. Linked to a source layer or CRS parameter to determine what units the volume values are in. |
|
A collection of utilities for working with parameters when running a processing algorithm. |
|
Abstract base class for processing providers. |
|
Registry for various processing components, including providers, algorithms and various parameters and outputs. |
|
Utility functions for use with processing classes. |
Processing Framework - Models¶
Model based algorithm with processing. |
|
Child algorithm representing a single component of a |
|
Encapsulates the results of running a child algorithm within a model |
|
Contains details of a child algorithm dependency. |
|
Source for the value of a parameter for a child algorithm within a model. |
|
Represents a comment in a model. |
|
Represents a component of a model algorithm. |
|
Represents a group box in a model. |
|
Represents a final output created by the model. |
|
Represents an input parameter used by the model. |
|
Encapsulates the results of running a Processing model |
QGIS Projects¶
Manages storage of a set of views. |
|
Encapsulates a QGIS project, including sets of map layers and their styles, layouts, annotations, canvases, etc. |
|
Interface for classes that handle missing layer files when reading project file. |
|
Temporarily blocks |
|
Contains settings and properties relating to how a |
|
Contains elevation properties for a |
|
Class to convert from older project file versions to newer. |
|
Contains settings and properties relating to how a |
|
An Abstract Base Class for QGIS project property hierarchys. |
|
Project property key node. |
|
Project property value node, contains a |
|
Validates the server specific parts of the configuration of a QGIS project. |
|
Abstract interface for project storage - to be implemented by various backends and registered in |
|
Registry of storage backends that |
|
List model representing the style databases associated with a |
|
A proxy model for filtering |
|
Contains settings and properties relating to how a |
|
Contains temporal settings and properties for the project, this may be used when animating maps or showing temporal layers. |
|
An interface for objects which can translate project strings. |
|
Contains utility functions for working with QGIS projects. |
|
A class to describe the version of a project. |
|
Contains settings and properties relating to how a |
Raster Layers¶
Bilinear Raster Resampler |
|
Brightness/contrast and gamma correction filter pipe for rasters. |
|
A raster contrast enhancement that will clip a value to the specified min/max range. |
|
A ramp shader will color a raster pixel based on a list of values ranges in a ramp. |
|
Manipulates raster or point cloud pixel values so that they enhanceContrast or clip into a specified numerical range according to the specified ContrastEnhancementAlgorithm. |
|
A contrast enhancement function is the base class for all raster contrast enhancements. |
|
Cubic Raster Resampler. |
|
Contains utilities for working with EXIF tags in images. |
|
A renderer for generating live hillshade models. |
|
Color and saturation filter pipe for rasters. |
|
Handles asynchronous download of images |
|
A color enhancement function that performs a linear enhanceContrast between min and max. |
|
A linear enhanceContrast enhancement that first clips to min max and then enhanceContrastes linearly between min and max. |
|
Renderer for multiband images with the color components |
|
Renderer for paletted raster images. |
|
Raster namespace. |
|
The |
|
The RasterBandStats struct is a container for statistics about a single raster band. |
|
Raster data container. |
|
Feedback object tailored for raster block reading. |
|
This is a helper class for unit tests that need to write an image and compare it to an expected result or render time. |
|
Raster renderer that generates contours on the fly for a source raster band. |
|
Base class for raster data providers. |
|
Handles elevation related properties for a raster data provider. |
|
Implementation of data provider temporal properties for |
|
The drawing pipe for raster layers. |
|
The raster file writer which allows you to save a raster to a new file. |
|
|
|
The |
|
Raster identify results container. |
|
Base class for processing filters like renderers, reprojector, resampler etc. |
|
Iterator for sequentially processing raster cells. |
|
Represents a raster layer. |
|
Raster layer specific subclass of |
|
Implementation of map layer temporal properties for raster layers. |
|
Contains utility functions for working with raster layers. |
|
This class describes the origin of min/max values. It does not store by itself the min/max values. |
|
Raster pipe that deals with null values. |
|
Contains a pipeline of raster interfaces for sequential raster processing. |
|
Implements approximate projection support for optimised raster transformation. |
|
This struct is used to store pyramid info for the raster layer. |
|
Raster values range container. Represents range of values between min and max including min and max value. |
|
Raster renderer pipe that applies colors to a raster. |
|
Registry for raster renderers. |
|
Utility functions for raster renderers. |
|
Resample filter pipe for rasters. |
|
Interface for resampling rasters (e.g. to have a smoother appearance) |
|
Interface for resampling rasters (V2) (e.g. to have a smoother appearance), which provides a more efficient interface vs |
|
Interface for all raster shaders. |
|
The raster shade function applies a shader to a pixel at render time - typically used to render grayscale images as false color. |
|
Raster renderer which renders all data pixels using a single color. |
|
Defines the list of pixel values to be considered as transparent or semi transparent when rendering rasters. |
|
This class provides details of the viewable area that a raster will be rendered into. |
|
Raster renderer pipe for single band color. |
|
Raster renderer pipe for single band gray. |
|
Raster renderer pipe for single band pseudocolor. |
Scale Bars¶
Double box with alternating colors. |
|
Scalebar style that draws a single box with alternating color for the segments, with horizontal lines through alternating segments. AKA “South African” style. |
|
A scale bar style that draws text in the form of ‘1:XXXXX’. |
|
Abstract base class for scale bar renderers. |
|
The |
|
The |
|
Scalebar style that draws a single box with alternating color for the segments. |
|
Scalebar style that draws a stepped line representation of a scalebar. |
|
A scale bar that draws segments using short ticks. |
Sensor Handling¶
An abstract base class for sensor classes |
|
An abstract class QIODevice-based sensor classes |
|
Stores metadata about a sensor class. |
|
Manages sensors. |
|
A QAbstractItemModel subclass for showing sensors within a |
|
Registry of available sensor types. |
|
A serial port sensor class |
|
A TCP socket sensor class |
|
A UDP socket sensor class |
Settings Handling¶
class PyQgsSettingsEntryEnumFlag An enum settings entry. since QGIS 3.20 |
|
This class is a composition of two QSettings instances: |
|
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. |
|
Base abstract class for settings entries with typed get and set methods |
|
Base abstract class for settings entries with typed get and set methods |
|
Base abstract class for settings entries with typed get and set methods |
|
Base abstract class for settings entries with typed get and set methods |
|
Base abstract class for settings entries with typed get and set methods |
|
Base abstract class for settings entries with typed get and set methods |
|
Base abstract class for settings entries with typed get and set methods |
|
Base abstract class for settings entries with typed get and set methods |
|
A boolean settings entry. |
|
A color settings entry. |
|
A double settings entry. |
|
Creates a group of setting which have a common definition of base key |
|
An integer settings entry. |
|
A string settings entry. |
|
A string list settings entry. |
|
A variant settings entry. |
|
A string list settings entry. |
|
|
|
|
|
|
|
|
|
|
Symbology and Vector Renderers¶
A vector renderer which represents 3D features in an isometric view. |
|
Base class for line symbol layer types which draws line sections using a QBrush. |
|
Animated marker symbol layer class. |
|
Line symbol layer used for representing lines as arrows. |
|
Constructor for QgsCategorizedSymbolRenderer. |
|
A fill symbol layer which renders a marker symbol at the centroid of a polygon geometry. |
|
Contains utility functions for working with Color Brewer color schemes. |
|
A model which contains entities from multiple |
|
An “All ramps item”, which contains all items in a flat hierarchy |
|
Represents a CPT City color scheme. |
|
A custom item model for display of CPT City color palettes. |
|
A Collection: logical collection of subcollections and color ramps |
|
Item that represents a layer that can be opened with one of the |
|
Base class for all items in the model |
|
A directory: contains subdirectories and color ramps |
|
A selection: contains subdirectories and color ramps |
|
A symbol layer for rendering objects with major and minor axis (e.g. ellipse, rectangle, etc). |
|
A vector feature renderer which uses embedded feature symbology to render per-feature symbols. |
|
Abstract base class for all 2D vector feature renderers. |
|
An interface for objects which generate feature renderers for vector layers. |
|
A fill symbol type, for rendering Polygon and MultiPolygon geometries. |
|
Abstract base class for fill symbol layers. |
|
A line symbol layer type which fills a stroked line with a |
|
Filled marker symbol layer, consisting of a shape which is rendered using a |
|
Constructs a font marker symbol layer. |
|
A symbol layer subclass which alters rendered feature shapes through the use of QGIS expressions. |
|
A fill symbol layer which draws a smooth color gradient over a polygon. |
|
A vector feature renderer which uses numeric attributes to classify features into different ranges. |
|
Line symbol layer type which draws repeating line sections along a line feature. |
|
A renderer which draws points as a live heatmap |
|
Base class for polygon renderers generating texture images |
|
Class defining color to render mesh datasets. The color can vary depending on the dataset value. |
|
Represents a simple line renderer with width and color varying depending on values. |
|
A symbol layer that represents vector layer line feature as interpolated line The interpolation is done between two values defined at the |
|
Represents a width than can vary depending on values |
|
|
|
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. |
|
A symbol fill consisting of repeated parallel lines. |
|
A line symbol type, for rendering LineString and MultiLineString geometries. |
|
Abstract base class for line symbol layers. |
|
Line symbol layer used for decorating accordingly to linear referencing. |
|
Line symbol layer type which draws a gradient pattern perpendicularly along a line. |
|
Context for a MapInfo symbol conversion operation. |
|
Handles conversion of MapInfo symbols to QGIS symbology. |
|
Line symbol layer type which draws repeating marker symbols along a line feature. |
|
A marker symbol type, for rendering Point and MultiPoint geometries. |
|
Abstract base class for marker symbol layers. |
|
Special symbol layer that uses its sub symbol as a selective mask |
|
|
|
Null symbol renderer, which draws no symbols for features by default, but allows for labeling and diagrams for the layer. |
|
A renderer that automatically clusters points with the same geographic position. |
|
A renderer that automatically displaces points with the same geographic location. |
|
An abstract base class for distance based point renderers (e.g., clusterer and displacement renderers). |
|
A fill symbol layer which fills polygon shapes with repeating marker symbols. |
|
A fill symbol layer which places markers at random locations within polygons. |
|
A class for filling symbols with a repeated raster image. |
|
Line symbol layer type which draws line sections using a raster image file. |
|
Raster marker symbol layer class. |
|
Stores metadata about one renderer class. |
|
Represents an individual category (class) from a |
|
Convenience metadata class that uses static functions to create renderer and its widget. |
|
Creates a renderer symbol range |
|
Deprecated since version 3.10. |
|
Registry of renderers. |
|
Rule based renderer. |
|
A class for filling symbols with a repeated SVG file. |
|
Constructor for QgsShapeburstFillSymbolLayer. |
|
Renders polygons using a single fill and stroke color. |
|
A simple line symbol layer, which renders lines using a line in a variety of styles (e.g. solid, dotted, dashed). |
|
Simple marker symbol layer, consisting of a rendered shape with solid fill color and an stroke. |
|
Abstract base class for simple marker symbol layers. Handles creation of the symbol shapes but leaves the actual drawing of the symbols to subclasses. |
|
Constructor for QgsSingleSymbolRenderer. |
|
Constructor for QgsStyle, with the specified |
|
A color ramp entity for |
|
An interface for entities which can be placed in a |
|
An interface for classes which can visit style entity (e.g. symbol) nodes (using the visitor pattern). |
|
A label settings entity for |
|
A legend patch shape entity for |
|
A QAbstractItemModel subclass for showing symbol and color ramp entities contained within a |
|
A QSortFilterProxyModel subclass for showing filtered symbol and color ramps entries from a |
|
A 3d symbol entity for |
|
A symbol entity for |
|
A text format entity for |
|
A cache for images / pictures derived from SVG files |
|
Constructs SVG marker symbol layer with picture from given absolute path to a SVG file |
|
Abstract base class for all rendered symbols. |
|
Contains settings relating to symbol animation. |
|
Contains settings relating to symbol buffers, which draw a “halo” effect around the symbol. |
|
Constructor for QgsSymbolLayer. |
|
Stores metadata about one symbol layer class. |
|
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). |
|
Convenience metadata class that uses static functions to create symbol layer and its widget. |
|
Type used to refer to a specific symbol layer in a symbol of a layer. |
|
Registry of available symbol layer classes. |
|
Contains utility functions for working with symbols and symbol layers. |
|
Constructor for QgsSymbolRenderContext |
|
Base class for templated line symbols, e.g. line symbols which draw markers or hash lines at intervals along the line feature. |
|
A symbol layer class for displaying displacement arrows based on point layer attributes. |
Text Rendering¶
Encapsulates details required for downloading a font. |
|
Manages available fonts and font installation for a QGIS instance. |
|
Container for settings relating to a text background object. |
|
Represents a block of text consisting of one or more |
|
Stores information relating to individual block formatting. |
|
Container for settings relating to a text buffer. |
|
Stores information relating to individual character formatting. |
|
Represents a document consisting of one or more |
|
Contains pre-calculated metrics of a |
|
Encapsulates the context in which a text document is to be rendered. |
|
Container for all settings relating to text rendering. |
|
Stores a fragment of document along with formatting overrides to be used when rendering the fragment. |
|
Container for settings relating to a selective masking around a text. |
|
Handles rendering text using rich formatting options, including drop shadows, buffers and background shapes. |
|
Utility functions for text rendering. |
|
Container for settings relating to a text shadow. |
Tiled Scene Layers¶
Contains utilities for working with Cesium data. |
|
Represents a bounding volume for a tiled scene. |
|
Base class for data providers for |
|
An index for tiled scene data providers. |
|
Represents a map layer supporting display of tiled scene objects. |
|
Tiled scene layer specific subclass of |
|
Encapsulates the render context for a 2D tiled scene rendering operation. |
|
Abstract base class for 2d tiled scene renderers. |
|
Stores metadata about one tiled scene renderer class. |
|
Convenience metadata class that uses static functions to create tiled scene renderer and its widget. |
|
Registry of 2D renderers for tiled scenes. |
|
Tiled scene data request. |
|
Renders tiled scene layers using textures. |
|
Represents an individual tile from a tiled scene data source. |
|
Renders tiled scene layers using the raw primitive wireframes. |
Validity Checks¶
Abstract base class for individual validity checks. |
|
Validity check context for print layout validation. |
|
Base class for validity check contexts. |
|
This class keeps a list of |
|
Represents an individual result from a validity check run by a |
Vector Layers¶
Class allowing to manage the auxiliary storage for a vector layer. |
|
Definition of a coded / enumerated field domain. |
|
Associates a code and a value. |
|
Base class for field domains. |
|
Definition of a field domain for field content validated by a glob. |
|
Definition of a numeric field domain with a range of validity for values. |
|
This is the base class for vector data providers. |
|
Implementation of data provider temporal properties for |
|
Represents a vector layer which manages a vector based data sets. |
|
This class caches features of a given |
|
Stores queued vector layer edit operations prior to committing changes to the layer’s data provider. |
|
The edit buffer group manages a group of edit buffers. |
|
Contains utility functions for editing vector layers. |
|
Vector layer specific subclass of |
|
A convenience class for exporting vector layers to a destination data provider. |
|
|
|
Counts the features in a |
|
A feature iterator which iterates over features from a |
|
Partial snapshot of vector layer’s state (only the members necessary for access to features) |
|
Manages joined fields for a vector layer. |
|
Defines left outer join from our vector layer to some other vector layer. |
|
|
|
Implementation of layer selection properties for vector layers. |
|
Encapsulates the context in which a |
|
Implementation of map layer temporal properties for vector layers. |
|
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. |
|
Contains settings which reflect the context in which vector layer tool operations should consider. |
|
Base class for undo commands within a |
|
Undo command for adding a new attribute to a vector layer. |
|
Undo command for adding a feature to a vector layer. |
|
Undo command for modifying an attribute of a feature from a vector layer. |
|
Undo command for modifying the geometry of a feature from a vector layer. |
|
Undo command for removing an existing attribute from a vector layer. |
|
Undo command for deleting a feature from a vector layer. |
|
Undo command for renaming an existing attribute of a vector layer. |
|
Undo command for vector layer in transaction group mode. |
|
Undo command for adding attri to a vector layer in transaction group. |
|
Undo command for adding a feature to a vector layer in transaction group mode. |
|
Undo command for changing attr value from a vector layer in transaction group. |
|
Undo command for changing attributes’ values from a vector layer in transaction group. |
|
Undo command for changing feature geometry from a vector layer in transaction group. |
|
Undo command for deleting attri of a vector layer in transaction group. |
|
Undo command for deleting features from a vector layer in transaction group. |
|
Undo command for deleting attri of a vector layer in transaction group. |
|
Undo command for running a specific sql query in transaction group. |
|
Contains utility methods for working with |
Vector Tile Layers¶
Abstract base class for MapBox GL style sources. |
|
Context for a MapBox GL style conversion operation. |
|
Handles conversion of MapBox GL styles to QGIS vector tile renderers and labeling settings. |
|
Encapsulates a MapBox GL style raster source. |
|
Encapsulates a MapBox GL style raster sub layer. |
|
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. |
|
Configuration of a single style within |
|
The default vector tile renderer implementation. It has an ordered list of “styles”, each defines a rendering rule. |
|
Definition of map rendering of a subset of vector tile data. The subset of data is defined by: |
|
Base class for labeling configuration classes for vector tile layers. |
|
Implements a map layer that is dedicated to rendering of vector tiles. |
|
Encapsulates properties of a vector tile matrix set, including tile origins and scaling information. |
|
Abstract base class for all vector tile renderer implementations. |
|
Contains decoded features of a single vector tile and any other data necessary for rendering of it. |
|
Random utility functions for working with vector tiles |
|
Takes care of writing vector tiles. |
|
Utility class for reading and writing ESRI VTPK files. |