QGIS API Documentation
Classes
QGIS core library

Contains all basic GIS functionality. More...

Classes

class  QGis
 The QGis class provides global constants for use throughout the application. More...
 
class  QgsAbstractFeatureIterator
 Internal feature iterator to be implemented within data providers. More...
 
class  QgsAbstractGeometryV2
 Abstract base class for all geometries. More...
 
class  QgsAction
 Utility class that encapsulates an action based on vector attributes. More...
 
class  QgsApplication
 Extends QApplication to provide access to QGIS specific resources such as theme paths, database paths etc. More...
 
class  QgsAuthCertUtils
 Utilities for working with certificates and keys. More...
 
class  QgsAuthConfigSslServer
 Configuration container for SSL server connection exceptions or overrides. More...
 
class  QgsAuthCrypto
 Funtions for hashing/checking master password and encrypt/decrypting data with password. More...
 
class  QgsAuthManager
 Singleton offering an interface to manage the authentication configuration database and to utilize configurations through various authentication method plugins. More...
 
class  QgsAuthMethod
 Abstract base class for authentication method plugins. More...
 
class  QgsAuthMethodConfig
 Configuration storage class for authentication method configurations. More...
 
class  QgsAuthMethodMetadata
 Holds data auth method key, description, and associated shared library file information. More...
 
class  QgsAuthMethodRegistry
 A registry / canonical manager of authentication methods. More...
 
class  QgsBilinearRasterResampler
 Bilinear Raster Resampler. More...
 
class  QgsBlurEffect
 A paint effect which blurs a source picture, using a number of different blur methods. More...
 
class  QgsBrightnessContrastFilter
 Brightness/contrast filter pipe for rasters. More...
 
class  QgsCircularStringV2
 Circular string geometry type. More...
 
class  QgsClipper
 A class to trim lines and polygons to within a rectangular region. More...
 
class  QgsClipToMinMaxEnhancement
 A raster contrast enhancement that will clip a value to the specified min/max range. More...
 
class  QgsColorEffect
 A paint effect which alters the colors (eg brightness, contrast) in a source picture. More...
 
class  QgsColorRampShader
 A ramp shader will color a raster pixel based on a list of values ranges in a ramp. More...
 
class  QgsColorScheme
 Abstract base class for color schemes. More...
 
class  QgsColorSchemeRegistry
 Registry of color schemes. More...
 
class  QgsCompoundCurveV2
 Compound curve geometry type. More...
 
class  QgsConditionalStyle
 Conditional styling for a rule. More...
 
class  QgsContextHelp
 Provides a context based help browser for a dialog. More...
 
class  QgsContrastEnhancement
 Manipulates raster pixel values so that they enhanceContrast or clip into a specified numerical range according to the specified ContrastEnhancementAlgorithm. More...
 
class  QgsContrastEnhancementFunction
 A contrast enhancement funcion is the base class for all raster contrast enhancements. More...
 
class  QgsCoordinateReferenceSystem
 Class for storing a coordinate reference system (CRS) More...
 
class  QgsCoordinateTransform
 Class for doing transforms between two map coordinate systems. More...
 
class  QgsCredentials
 Interface for requesting credentials in QGIS in GUI independent way. More...
 
class  QgsCsException
 Custom exception class for Coordinate Reference System related exceptions. More...
 
class  QgsCubicRasterResampler
 Cubic Raster Resampler. More...
 
class  QgsCurvePolygonV2
 Curve polygon geometry type. More...
 
class  QgsCurveV2
 Abstract base class for curved geometry type. More...
 
class  QgsCustomColorScheme
 A color scheme which contains custom colors set through QGIS app options dialog. More...
 
class  QgsDataDefined
 A container class for data source field mapping or expression. More...
 
class  QgsDataProvider
 Abstract base class for spatial data provider implementations. More...
 
class  QgsDataSourceURI
 Class for storing the component parts of a PostgreSQL/RDBMS datasource URI. More...
 
class  QgsDiagramLayerSettings
 Stores the settings for rendering of all diagrams for a layer. More...
 
class  QgsDiagramRendererV2
 Evaluates and returns the diagram settings relating to a diagram for a specific feature. More...
 
class  QgsDiagramSettings
 Stores the settings for rendering a single diagram. More...
 
class  QgsDistanceArea
 General purpose distance and area calculator. More...
 
class  QgsDrawSourceEffect
 A paint effect which draws the source picture with minor or no alterations. More...
 
class  QgsDropShadowEffect
 A paint effect which draws an offset and optionally blurred drop shadow. More...
 
class  QgsEffectStack
 A paint effect which consists of a stack of other chained paint effects. More...
 
class  QgsError
 QgsError is container for error messages (report). More...
 
class  QgsErrorMessage
 QgsErrorMessage represents single error message. More...
 
class  QgsException
 Defines a qgis exception class. More...
 
class  QgsExpressionContext
 Expression contexts are used to encapsulate the parameters around which a QgsExpression should be evaluated. More...
 
class  QgsExpressionContextScope
 Single scope for storing variables and functions for use within a QgsExpressionContext. More...
 
class  QgsExpressionContextUtils
 Contains utilities for working with QgsExpressionContext objects, including methods for creating scopes for specific uses (eg project scopes, layer scopes). More...
 
class  QgsFeature
 The feature class encapsulates a single feature including its id, geometry and a list of field/values attributes. More...
 
class  QgsFeatureFilterProvider
 Abstract interface for use by classes that filter the features of a layer. More...
 
class  QgsFeatureIterator
 Wrapper for iterator of features from vector data provider or vector layer. More...
 
class  QgsFeatureStore
 Container for features with the same fields and crs. More...
 
class  QgsField
 Encapsulate a field in an attribute table or data source. More...
 
class  QgsFields
 Container of fields for a vector layer. More...
 
class  QgsGeometry
 A geometry is the spatial representation of a feature. More...
 
class  QgsGeometryCollectionV2
 Geometry collection. More...
 
class  QgsGeometryEditUtils
 Convenience functions for geometry editing. More...
 
class  QgsGeometryEngine
 Contains geometry relation and modification algorithms. More...
 
class  QgsGeometryFactory
 Contains geometry creation routines. More...
 
class  QgsGeometryUtils
 Contains various geometry utility functions. More...
 
class  QgsGlowEffect
 Base class for paint effect which draw a glow inside or outside a picture. More...
 
class  QgsGplColorScheme
 A color scheme which stores its colors in a gpl palette file. More...
 
class  QgsGradientStop
 Represents a color stop within a gradient color ramp. More...
 
class  QgsHeatmapRenderer
 A renderer which draws points as a live heatmap. More...
 
class  QgsHistogram
 Calculator for a numeric histogram from a list of values. More...
 
class  QgsHttpTransaction
 HTTP request/response manager that is redirect-aware. More...
 
class  QgsHueSaturationFilter
 Color and saturation filter pipe for rasters. More...
 
class  QgsImageOperation
 Contains operations and filters which apply to QImages. More...
 
class  QgsInnerGlowEffect
 A paint effect which draws a glow within a picture. More...
 
class  QgsInnerShadowEffect
 A paint effect which draws an offset and optionally blurred drop shadow within a picture. More...
 
class  QgsInterruptionChecker
 Interface that can be optionaly attached to an iterator so its nextFeature() implementaton can check if it must stop as soon as possible. More...
 
class  QgsLabel
 A class to render labels. More...
 
class  QgsLabelAttributes
 A class to store attributes needed for label rendering. More...
 
class  QgsLabelComponent
 Maintains current state of more grainular and temporal values when creating/painting component parts of an individual label (e.g. More...
 
class  QgsLinearMinMaxEnhancement
 A color enhancement function that performs a linear enhanceContrast between min and max. More...
 
class  QgsLinearMinMaxEnhancementWithClip
 A linear enhanceContrast enhancement that first clips to min max and then enhanceContrastes linearly between min and max. More...
 
class  QgsLineStringV2
 Line string geometry type, with support for z-dimension and m-values. More...
 
class  QgsLogger
 QgsLogger is a class to print debug/warning/error messages to the console. More...
 
class  QgsMapLayer
 Base class for all map layer types. More...
 
class  QgsMapLayerRegistry
 This class tracks map layers that are currently loaded and provides a means to fetch a pointer to a map layer and delete it. More...
 
class  QgsMapRenderer
 A non GUI class for rendering a map layer set onto a QPainter. More...
 
class  QgsMapToPixel
 Perform transforms between map coordinates and device coordinates. More...
 
class  QgsMessageLog
 Interface for logging messages from QGIS in GUI independent way. More...
 
class  QgsMessageOutput
 Interface for showing messages from QGIS in GUI independent way. More...
 
class  QgsMultiBandColorRenderer
 Renderer for multiband images with the color components. More...
 
class  QgsMultiCurveV2
 Multi curve geometry collection. More...
 
class  QgsMultiLineStringV2
 Multi line string geometry collection. More...
 
class  QgsMultiPointV2
 Multi point geometry collection. More...
 
class  QgsMultiPolygonV2
 Multi polygon geometry collection. More...
 
class  QgsMultiSurfaceV2
 Multi surface geometry collection. More...
 
class  QgsNetworkContentFetcher
 HTTP network content fetcher. More...
 
class  QgsNullSymbolRenderer
 Null symbol renderer. More...
 
class  QgsOgrUtils
 Utilities for working with OGR features and layers. More...
 
class  QgsOuterGlowEffect
 A paint effect which draws a glow outside of a picture. More...
 
class  QgsPaintEffect
 Base class for visual effects which can be applied to QPicture drawings. More...
 
class  QgsPaintEffectAbstractMetadata
 Stores metadata about a paint effect class. More...
 
class  QgsPaintEffectMetadata
 Convenience metadata class that uses static functions to create an effect and its widget. More...
 
class  QgsPaintEffectRegistry
 Singleton registry of available paint effects. More...
 
class  QgsPalettedRasterRenderer
 Renderer for paletted raster images. More...
 
class  QgsPkiBundle
 Storage set for PKI bundle: SSL certificate, key, optional CA cert chain. More...
 
class  QgsPkiConfigBundle
 Storage set for constructed SSL certificate, key, associated with an authentication config. More...
 
class  QgsPluginLayer
 Base class for plugin layers. More...
 
class  QgsPluginLayerRegistry
 a registry of plugin layers types More...
 
class  QgsPluginLayerType
 class for creating plugin specific layers More...
 
class  QgsPoint
 A class to represent a point. More...
 
class  QgsPointV2
 Point geometry type, with support for z-dimension and m-values. More...
 
class  QgsPolygonV2
 Polygon geometry type. More...
 
class  QgsProject
 Reads and writes project states. More...
 
class  QgsProjectColorScheme
 A color scheme which contains project specific colors set through project properties dialog. More...
 
class  QgsProjectVersion
 A class to describe the version of a project. More...
 
class  QgsProperty
 An Abstract Base Class for QGIS project property hierarchies. More...
 
class  QgsProviderCountCalcEvent
 A custom event that is designed to be fired when a layer count has been fully calculated. More...
 
class  QgsProviderExtentCalcEvent
 A custom event that is designed to be fired when a layer extent has been fully calculated. More...
 
class  QgsProviderMetadata
 Holds data provider key, description, and associated shared library file information. More...
 
class  QgsProviderRegistry
 A registry / canonical manager of data providers. More...
 
class  QgsPseudoColorShader
 A raster color shader that highlighs low values in blue and high values in red. More...
 
class  QgsRaster
 Raster namespace. More...
 
class  QgsRasterBandStats
 The RasterBandStats struct is a container for statistics about a single raster band. More...
 
class  QgsRasterBlock
 Raster data container. More...
 
class  QgsRasterDataProvider
 Base class for raster data providers. More...
 
class  QgsRasterDrawer
 The drawing pipe for raster layers. More...
 
class  QgsRasterFileWriter
 The raster file writer which allows you to save a raster to a new file. More...
 
class  QgsRasterFillSymbolLayer
 A class for filling symbols with a repeated raster image. More...
 
class  QgsRasterHistogram
 The QgsRasterHistogram is a container for histogram of a single raster band. More...
 
class  QgsRasterIdentifyResult
 Raster identify results container. More...
 
class  QgsRasterInterface
 Base class for processing filters like renderers, reprojector, resampler etc. More...
 
class  QgsRasterIterator
 Iterator for sequentially processing raster cells. More...
 
class  QgsRasterLayer
 This class provides qgis with the ability to render raster datasets onto the mapcanvas. More...
 
class  QgsRasterNuller
 Raster pipe that deals with null values. More...
 
class  QgsRasterPipe
 Base class for processing modules. More...
 
class  QgsRasterPyramid
 This struct is used to store pyramid info for the raster layer. More...
 
class  QgsRasterRange
 Raster values range container. More...
 
class  QgsRasterRenderer
 Raster renderer pipe that applies colors to a raster. More...
 
class  QgsRasterRendererRegistry
 Registry for raster renderers. More...
 
struct  QgsRasterRendererRegistryEntry
 Registry for raster renderer entries. More...
 
class  QgsRasterResampleFilter
 Resample filter pipe for rasters. More...
 
class  QgsRasterResampler
 Interface for resampling rasters (e.g. More...
 
class  QgsRasterShader
 Interface for all raster shaders. More...
 
class  QgsRasterShaderFunction
 The raster shade function applies a shader to a pixel at render time - typically used to render grayscale images as false color. More...
 
class  QgsRasterTransparency
 Defines the list of pixel values to be considered as transparent or semi transparent when rendering rasters. More...
 
struct  QgsRasterViewPort
 This class provides details of the viewable area that a raster will be rendered into. More...
 
class  QgsRecentColorScheme
 A color scheme which contains the most recently used colors. More...
 
class  QgsRectangle
 A rectangle specified with double values. More...
 
class  QgsRenderContext
 Contains information about the context of a rendering operation. More...
 
class  QgsRunProcess
 A class that executes an external program/script. More...
 
class  QgsScaleCalculator
 Calculates scale for a given combination of canvas size, map extent, and monitor dpi. More...
 
class  QgsScaleExpression
 Class storing parameters of a scale expression, which is a subclass of QgsExpression for expressions which return a size or width. More...
 
class  QgsScopedExpressionFunction
 Expression function for use within a QgsExpressionContextScope. More...
 
class  QgsShadowEffect
 Base class for paint effects which offset, blurred shadows. More...
 
class  QgsSingleBandColorDataRenderer
 Raster renderer pipe for single band color. More...
 
class  QgsSingleBandGrayRenderer
 Raster renderer pipe for single band gray. More...
 
class  QgsSingleBandPseudoColorRenderer
 Raster renderer pipe for single band pseudocolor. More...
 
struct  QgsSnappingResult
 Represents the result of a snapping operation. More...
 
class  QgsSqlExpressionCompiler
 Generic expression compiler for translation to provider specific SQL WHERE clauses. More...
 
class  QgsStatisticalSummary
 Calculator for summary statistics for a list of doubles. More...
 
class  QgsStringUtils
 Utility functions for working with strings. More...
 
class  QgsTolerance
 This is the class is providing tolerance value in map unit values. More...
 
class  QgsTracer
 Utility class that construct a planar graph from the input vector layers and provides shortest path search for tracing of existing features. More...
 
class  QgsTransformEffect
 A paint effect which applies transformations (such as move, scale and rotate) to a picture. More...
 
class  QgsUnitTypes
 Helper functions for various unit types. More...
 
class  QgsUserColorScheme
 A color scheme which stores its colors in a gpl palette file within the "palettes" subfolder off the user's QGIS settings folder. More...
 
class  QgsVector
 A class to represent a vector. More...
 
class  QgsVectorColorRampV2
 Abstract base class for color ramps. More...
 
class  QgsVectorDataProvider
 This is the base class for vector data providers. More...
 
class  QgsVectorFileWriter
 A convenience class for writing vector files to disk. More...
 
class  QgsVectorGradientColorRampV2
 Gradient color ramp, which smoothly interpolates between two colors and also supports optional extra color stops. More...
 
class  QgsVectorLayer
 Represents a vector layer which manages a vector based data sets. More...
 
class  QgsVectorLayerImport
 A convenience class for writing vector files to disk. More...
 
class  QgsVectorRandomColorRampV2
 Random color ramp, which returns random colors based on preset parameters. More...
 
class  QgsVertexId
 Utility class for identifying a unique vertex within a geometry. More...
 
class  QgsVisibilityPresetCollection
 Container class that allows storage of visibility presets consisting of visible map layers and layer styles. More...
 
class  QgsWkbException
 
class  QgsWKBTypes
 Handles storage of information regarding WKB types and their properties. More...
 

Detailed Description

Contains all basic GIS functionality.