QGIS API Documentation 3.99.0-Master (c22de0620c0)
Loading...
Searching...
No Matches
Static Public Member Functions | List of all members
QgsMapLayerUtils Class Reference
core library

Contains utility functions for working with map layers. More...

#include <qgsmaplayerutils.h>

Static Public Member Functions

static QgsRectangle combinedExtent (const QList< QgsMapLayer * > &layers, const QgsCoordinateReferenceSystem &crs, const QgsCoordinateTransformContext &transformContext)
 Returns the combined extent of a list of layers.
static QgsAbstractDatabaseProviderConnection * databaseConnection (const QgsMapLayer *layer)
 Creates and returns the (possibly nullptr) database connection for a layer.
static bool isOpenStreetMapLayer (QgsMapLayer *layer)
 Returns true if the layer is served by OpenStreetMap server.
static QString launderLayerName (const QString &name)
 Launders a layer's name, converting it into a format which is general suitable for file names or database layer names.
static bool layerRefersToUri (const QgsMapLayer *layer, const QString &uri, Qgis::SourceHierarchyLevel level=Qgis::SourceHierarchyLevel::Object)
 Returns true if a layer and uri point to the same resource at the specified hierarchy level.
static bool layerSourceMatchesPath (const QgsMapLayer *layer, const QString &path)
 Returns true if the source of the specified layer matches the given path.
static QString layerTypeToString (Qgis::LayerType type)
 Returns the translated name of the type for a given layer type.
static QList< QgsMapLayer * > sortLayersByType (const QList< QgsMapLayer * > &layers, const QList< Qgis::LayerType > &order)
 Sorts a list of map layers by their layer type, respecting the order of types specified.
static bool updateLayerSourcePath (QgsMapLayer *layer, const QString &newPath)
 Updates a layer's data source, replacing its data source with a path referring to newPath.

Detailed Description

Contains utility functions for working with map layers.

Since
QGIS 3.20

Definition at line 38 of file qgsmaplayerutils.h.

Member Function Documentation

◆ combinedExtent()

QgsRectangle QgsMapLayerUtils::combinedExtent ( const QList< QgsMapLayer * > & layers,
const QgsCoordinateReferenceSystem & crs,
const QgsCoordinateTransformContext & transformContext )
static

Returns the combined extent of a list of layers.

The crs argument specifies the desired coordinate reference system for the combined extent.

Definition at line 35 of file qgsmaplayerutils.cpp.

◆ databaseConnection()

QgsAbstractDatabaseProviderConnection * QgsMapLayerUtils::databaseConnection ( const QgsMapLayer * layer)
static

Creates and returns the (possibly nullptr) database connection for a layer.

Ownership is transferred to the caller.

Since
QGIS 3.22

Definition at line 97 of file qgsmaplayerutils.cpp.

◆ isOpenStreetMapLayer()

bool QgsMapLayerUtils::isOpenStreetMapLayer ( QgsMapLayer * layer)
static

Returns true if the layer is served by OpenStreetMap server.

Since
QGIS 3.40

Definition at line 197 of file qgsmaplayerutils.cpp.

◆ launderLayerName()

QString QgsMapLayerUtils::launderLayerName ( const QString & name)
static

Launders a layer's name, converting it into a format which is general suitable for file names or database layer names.

Specifically this method:

  • Converts the name to lowercase
  • Replaces spaces by underscore characters
  • Removes any characters which are not alphanumeric or '_'.
Since
QGIS 3.28

Definition at line 185 of file qgsmaplayerutils.cpp.

◆ layerRefersToUri()

bool QgsMapLayerUtils::layerRefersToUri ( const QgsMapLayer * layer,
const QString & uri,
Qgis::SourceHierarchyLevel level = Qgis::SourceHierarchyLevel::Object )
static

Returns true if a layer and uri point to the same resource at the specified hierarchy level.

This method parses the underlying connection parameters of the layer and uri to check if they share the same scope defined by level.

Note
This method is only valid for a uri from the same data provider as layer.
Warning
Not all providers implement this functionality. Check whether the provider's metadata capabilities returns the QgsProviderMetadata::ProviderMetadataCapability::UrisReferToSame to determine whether a specific provider metadata object supports this method.
Exceptions
QgsNotSupportedExceptionif the layer's provider does not implement the QgsProviderMetadata::ProviderMetadataCapability::UrisReferToSame capability.
Since
QGIS 4.0

Definition at line 134 of file qgsmaplayerutils.cpp.

◆ layerSourceMatchesPath()

bool QgsMapLayerUtils::layerSourceMatchesPath ( const QgsMapLayer * layer,
const QString & path )
static

Returns true if the source of the specified layer matches the given path.

This method can be used to test whether a layer is associated with a file path.

Since
QGIS 3.22

Definition at line 125 of file qgsmaplayerutils.cpp.

◆ layerTypeToString()

QString QgsMapLayerUtils::layerTypeToString ( Qgis::LayerType type)
static

Returns the translated name of the type for a given layer type.

Since
QGIS 4.0

Definition at line 214 of file qgsmaplayerutils.cpp.

◆ sortLayersByType()

QList< QgsMapLayer * > QgsMapLayerUtils::sortLayersByType ( const QList< QgsMapLayer * > & layers,
const QList< Qgis::LayerType > & order )
static

Sorts a list of map layers by their layer type, respecting the order of types specified.

Layer types which appear earlier in the order list will result in matching layers appearing earlier in the result list.

Since
QGIS 3.26

Definition at line 168 of file qgsmaplayerutils.cpp.

◆ updateLayerSourcePath()

bool QgsMapLayerUtils::updateLayerSourcePath ( QgsMapLayer * layer,
const QString & newPath )
static

Updates a layer's data source, replacing its data source with a path referring to newPath.

Returns true if the layer was updated, or false if the layer was not updated (e.g. it uses a data provider which does not specify paths in a layer URI.

Since
QGIS 3.22

Definition at line 153 of file qgsmaplayerutils.cpp.

The documentation for this class was generated from the following files:
Generated on for QGIS API Documentation by doxygen 1.15.0