QGIS API Documentation
3.22.4-Białowieża (ce8e65e95e)
|
Base class for all map layer types. More...
#include <qgsmaplayer.h>
Public Types | |
enum | LayerFlag { Identifiable = 1 << 0 , Removable = 1 << 1 , Searchable = 1 << 2 , Private = 1 << 3 } |
Flags for the map layer. More... | |
enum | PropertyType { Style = 0 , Metadata } |
Maplayer has a style and a metadata property. More... | |
enum | ReadFlag { FlagDontResolveLayers = 1 << 0 , FlagTrustLayerMetadata = 1 << 1 , FlagReadExtentFromXml = 1 << 2 } |
Flags which control project read behavior. More... | |
enum | StyleCategory { LayerConfiguration = 1 << 0 , Symbology = 1 << 1 , Symbology3D = 1 << 2 , Labeling = 1 << 3 , Fields = 1 << 4 , Forms = 1 << 5 , Actions = 1 << 6 , MapTips = 1 << 7 , Diagrams = 1 << 8 , AttributeTable = 1 << 9 , Rendering = 1 << 10 , CustomProperties = 1 << 11 , GeometryOptions = 1 << 12 , Relations = 1 << 13 , Temporal = 1 << 14 , Legend = 1 << 15 , Elevation = 1 << 16 , Notes = 1 << 17 , AllStyleCategories } |
Categories of style to distinguish appropriate sections for import/export. More... | |
Public Slots | |
void | emitStyleChanged () |
Triggers an emission of the styleChanged() signal. More... | |
QgsProject * | project () const |
Returns the parent project if this map layer is added to a project. More... | |
virtual bool | setDependencies (const QSet< QgsMapLayerDependency > &layers) |
Sets the list of dependencies. More... | |
void | setMaximumScale (double scale) |
Sets the maximum map scale (i.e. More... | |
void | setMinimumScale (double scale) |
Sets the minimum map scale (i.e. More... | |
void | setRefreshOnNofifyMessage (const QString &message) |
Set the notification message that triggers repaint If refresh on notification is enabled, the notification will triggerRepaint only if the notification message is equal to. More... | |
void | setRefreshOnNotifyEnabled (bool enabled) |
Set whether provider notification is connected to triggerRepaint. More... | |
void | setScaleBasedVisibility (bool enabled) |
Sets whether scale based visibility is enabled for the layer. More... | |
virtual void | setTransformContext (const QgsCoordinateTransformContext &transformContext)=0 |
Sets the coordinate transform context to transformContext. More... | |
void | trigger3DUpdate () |
Will advise any 3D maps that this layer requires to be updated in the scene. More... | |
void | triggerRepaint (bool deferredUpdate=false) |
Will advise the map canvas (and any other interested party) that this layer requires to be repainted. More... | |
Signals | |
void | autoRefreshIntervalChanged (int interval) |
Emitted when the auto refresh interval changes. More... | |
void | beforeResolveReferences (QgsProject *project) |
Emitted when all layers are loaded and references can be resolved, just before the references of this layer are resolved. More... | |
void | blendModeChanged (QPainter::CompositionMode blendMode) |
Signal emitted when the blend mode is changed, through QgsMapLayer::setBlendMode() More... | |
void | configChanged () |
Emitted whenever the configuration is changed. More... | |
void | crsChanged () |
Emit a signal that layer's CRS has been reset. More... | |
void | customPropertyChanged (const QString &key) |
Emitted when a custom property of the layer has been changed or removed. More... | |
void | dataChanged () |
Data of layer changed. More... | |
void | dataSourceChanged () |
Emitted whenever the layer's data source has been changed. More... | |
void | dependenciesChanged () |
Emitted when dependencies are changed. More... | |
void | editingStarted () |
Emitted when editing on this layer has started. More... | |
void | editingStopped () |
Emitted when edited changes have been successfully written to the data provider. More... | |
void | flagsChanged () |
Emitted when layer's flags have been modified. More... | |
void | isValidChanged () |
Emitted when the validity of this layer changed. More... | |
void | layerModified () |
Emitted when modifications has been done on layer. More... | |
void | legendChanged () |
Signal emitted when legend of the layer has changed. More... | |
void | metadataChanged () |
Emitted when the layer's metadata is changed. More... | |
void | nameChanged () |
Emitted when the name has been changed. More... | |
void | opacityChanged (double opacity) |
Emitted when the layer's opacity is changed, where opacity is a value between 0 (transparent) and 1 (opaque). More... | |
void | recalculateExtents () const |
This is used to send a request that any mapcanvas using this layer update its extents. More... | |
void | renderer3DChanged () |
Signal emitted when 3D renderer associated with the layer has changed. More... | |
void | rendererChanged () |
Signal emitted when renderer is changed. More... | |
void | repaintRequested (bool deferredUpdate=false) |
By emitting this signal the layer tells that either appearance or content have been changed and any view showing the rendered layer should refresh itself. More... | |
void | request3DUpdate () |
Signal emitted when a layer requires an update in any 3D maps. More... | |
void | statusChanged (const QString &status) |
Emit a signal with status (e.g. to be caught by QgisApp and display a msg on status bar) More... | |
void | styleChanged () |
Signal emitted whenever a change affects the layer's style. More... | |
void | styleLoaded (QgsMapLayer::StyleCategories categories) |
Emitted when a style has been loaded. More... | |
void | willBeDeleted () |
Emitted in the destructor when the layer is about to be deleted, but it is still in a perfectly valid state: the last chance for other pieces of code for some cleanup if they use the layer. More... | |
Public Member Functions | |
QgsMapLayer (QgsMapLayer const &)=delete | |
QgsMapLayer cannot be copied. More... | |
QgsMapLayer (QgsMapLayerType type=QgsMapLayerType::VectorLayer, const QString &name=QString(), const QString &source=QString()) | |
Constructor for QgsMapLayer. More... | |
~QgsMapLayer () override | |
QString | abstract () const |
Returns the abstract of the layer used by QGIS Server in GetCapabilities request. More... | |
virtual bool | accept (QgsStyleEntityVisitorInterface *visitor) const |
Accepts the specified symbology visitor, causing it to visit all symbols associated with the layer. More... | |
QString | attribution () const |
Returns the attribution of the layer used by QGIS Server in GetCapabilities request. More... | |
QString | attributionUrl () const |
Returns the attribution URL of the layer used by QGIS Server in GetCapabilities request. More... | |
int | autoRefreshInterval () const |
Returns the auto refresh interval (in milliseconds). More... | |
QPainter::CompositionMode | blendMode () const |
Returns the current blending mode for a layer. More... | |
virtual QgsMapLayer * | clone () const =0 |
Returns a new instance equivalent to this one except for the id which is still unique. More... | |
virtual QgsMapLayerRenderer * | createMapRenderer (QgsRenderContext &rendererContext)=0 |
Returns new instance of QgsMapLayerRenderer that will be used for rendering of given context. More... | |
QgsCoordinateReferenceSystem | crs () const |
Returns the layer's spatial reference system. More... | |
template<class T > | |
T | customEnumProperty (const QString &key, const T &defaultValue) |
Returns the property value for a property based on an enum. More... | |
template<class T > | |
T | customFlagProperty (const QString &key, const T &defaultValue) |
Returns the property value for a property based on a flag. More... | |
const QgsObjectCustomProperties & | customProperties () const |
Read all custom properties from layer. More... | |
Q_INVOKABLE QVariant | customProperty (const QString &value, const QVariant &defaultValue=QVariant()) const |
Read a custom property from layer. More... | |
Q_INVOKABLE QStringList | customPropertyKeys () const |
Returns list of all keys within custom properties. More... | |
virtual Q_INVOKABLE QgsDataProvider * | dataProvider () |
Returns the layer's data provider, it may be nullptr . More... | |
virtual const QgsDataProvider * | dataProvider () const |
Returns the layer's data provider in a const-correct manner, it may be nullptr . More... | |
QString | dataUrl () const |
Returns the DataUrl of the layer used by QGIS Server in GetCapabilities request. More... | |
QString | dataUrlFormat () const |
Returns the DataUrl format of the layer used by QGIS Server in GetCapabilities request. More... | |
virtual QSet< QgsMapLayerDependency > | dependencies () const |
Gets the list of dependencies. More... | |
virtual QgsMapLayerElevationProperties * | elevationProperties () |
Returns the layer's elevation properties. More... | |
virtual QgsError | error () const |
Gets current status error. More... | |
void | exportNamedMetadata (QDomDocument &doc, QString &errorMsg) const |
Export the current metadata of this layer as named metadata in a QDomDocument. More... | |
virtual void | exportNamedStyle (QDomDocument &doc, QString &errorMsg, const QgsReadWriteContext &context=QgsReadWriteContext(), QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) const |
Export the properties of this layer as named style in a QDomDocument. More... | |
virtual void | exportSldStyle (QDomDocument &doc, QString &errorMsg) const |
Export the properties of this layer as SLD style in a QDomDocument. More... | |
virtual QgsRectangle | extent () const |
Returns the extent of the layer. More... | |
QgsMapLayer::LayerFlags | flags () const |
Returns the flags for this layer. More... | |
bool | hasAutoRefreshEnabled () const |
Returns true if auto refresh is enabled for the layer. More... | |
bool | hasScaleBasedVisibility () const |
Returns whether scale based visibility is enabled for the layer. More... | |
virtual QString | htmlMetadata () const |
Obtain a formatted HTML string containing assorted metadata for this layer. More... | |
QString | id () const |
Returns the layer's unique ID, which is used to access this layer from QgsProject. More... | |
bool | importNamedMetadata (QDomDocument &document, QString &errorMessage) |
Import the metadata of this layer from a QDomDocument. More... | |
virtual bool | importNamedStyle (QDomDocument &doc, QString &errorMsg, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) |
Import the properties of this layer from a QDomDocument. More... | |
virtual bool | isEditable () const |
Returns true if the layer can be edited. More... | |
bool | isInScaleRange (double scale) const |
Tests whether the layer should be visible at the specified scale. More... | |
virtual bool | isModified () const |
Returns true if the layer has been modified since last commit/save. More... | |
bool | isRefreshOnNotifyEnabled () const |
Returns true if the refresh on provider nofification is enabled. More... | |
virtual bool | isSpatial () const |
Returns true if the layer is considered a spatial layer, ie it has some form of geometry associated with it. More... | |
virtual bool | isTemporary () const |
Returns true if the layer is considered a temporary layer. More... | |
bool | isValid () const |
Returns the status of the layer. More... | |
QString | keywordList () const |
Returns the keyword list of the layer used by QGIS Server in GetCapabilities request. More... | |
QgsMapLayerLegend * | legend () const |
Can be nullptr . More... | |
QString | legendPlaceholderImage () const |
Returns path to the placeholder image or an empty string if a generated legend is shown. More... | |
QString | legendUrl () const |
Returns the URL for the layer's legend. More... | |
QString | legendUrlFormat () const |
Returns the format for a URL based layer legend. More... | |
virtual QString | loadDefaultMetadata (bool &resultFlag) |
Retrieve the default metadata for this layer if one exists (either as a .qmd file on disk or as a record in the users metadata table in their personal qgis.db) More... | |
virtual QString | loadDefaultStyle (bool &resultFlag) |
Retrieve the default style for this layer if one exists (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) More... | |
virtual QString | loadNamedMetadata (const QString &uri, bool &resultFlag) |
Retrieve a named metadata for this layer if one exists (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db) More... | |
bool | loadNamedMetadataFromDatabase (const QString &db, const QString &uri, QString &qmd) |
Retrieve a named metadata for this layer from a sqlite database. More... | |
virtual QString | loadNamedStyle (const QString &uri, bool &resultFlag, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) |
Retrieve a named style for this layer if one exists (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) More... | |
virtual bool | loadNamedStyleFromDatabase (const QString &db, const QString &uri, QString &qml) |
Retrieve a named style for this layer from a sqlite database. More... | |
virtual QString | loadSldStyle (const QString &uri, bool &resultFlag) |
Attempts to style the layer using the formatting from an SLD type file. More... | |
double | maximumScale () const |
Returns the maximum map scale (i.e. More... | |
virtual const QgsLayerMetadata & | metadata () const |
Returns a reference to the layer's metadata store. More... | |
virtual QString | metadataUri () const |
Retrieve the metadata URI for this layer (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db) More... | |
Q_DECL_DEPRECATED QString | metadataUrl () const |
Returns the metadata URL of the layer used by QGIS Server in GetCapabilities request. More... | |
Q_DECL_DEPRECATED QString | metadataUrlFormat () const |
Returns the metadata format of the layer used by QGIS Server in GetCapabilities request. More... | |
Q_DECL_DEPRECATED QString | metadataUrlType () const |
Returns the metadata type of the layer used by QGIS Server in GetCapabilities request. More... | |
double | minimumScale () const |
Returns the minimum map scale (i.e. More... | |
QString | name () const |
Returns the display name of the layer. More... | |
virtual double | opacity () const |
Returns the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque). More... | |
QgsMapLayer & | operator= (QgsMapLayer const &)=delete |
QgsMapLayer cannot be copied. More... | |
QString | originalXmlProperties () const |
Returns the XML properties of the original layer as they were when the layer was first read from the project file. More... | |
virtual Qgis::MapLayerProperties | properties () const |
Returns the map layer properties of this layer. More... | |
QString | providerType () const |
Returns the provider type (provider key) for this layer. More... | |
QString | publicSource () const |
Gets a version of the internal layer definition that has sensitive bits removed (for example, the password). More... | |
bool | readLayerXml (const QDomElement &layerElement, QgsReadWriteContext &context, QgsMapLayer::ReadFlags flags=QgsMapLayer::ReadFlags()) |
Sets state from DOM document. More... | |
bool | readOnly () const |
Returns if this layer is read only. More... | |
virtual bool | readSld (const QDomNode &node, QString &errorMessage) |
virtual bool | readStyle (const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) |
Read the style for the current layer from the DOM node supplied. More... | |
virtual bool | readSymbology (const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories)=0 |
Read the symbology for the current layer from the DOM node supplied. More... | |
QString | refreshOnNotifyMessage () const |
Returns the message that should be notified by the provider to triggerRepaint. More... | |
virtual Q_INVOKABLE void | reload () |
Synchronises with changes in the datasource. More... | |
void | removeCustomProperty (const QString &key) |
Remove a custom property from layer. More... | |
QgsAbstract3DRenderer * | renderer3D () const |
Returns 3D renderer associated with the layer. More... | |
virtual void | resolveReferences (QgsProject *project) |
Resolve references to other layers (kept as layer IDs after reading XML) into layer objects. More... | |
virtual QString | saveDefaultMetadata (bool &resultFlag) |
Save the current metadata of this layer as the default metadata (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db) More... | |
virtual QString | saveDefaultStyle (bool &resultFlag) |
Save the properties of this layer as the default style (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) More... | |
QString | saveNamedMetadata (const QString &uri, bool &resultFlag) |
Save the current metadata of this layer as a named metadata (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db) More... | |
virtual QString | saveNamedStyle (const QString &uri, bool &resultFlag, StyleCategories categories=AllStyleCategories) |
Save the properties of this layer as a named style (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) More... | |
virtual QString | saveSldStyle (const QString &uri, bool &resultFlag) const |
Saves the properties of this layer to an SLD format file. More... | |
QgsMapLayerServerProperties * | serverProperties () |
Returns QGIS Server Properties for the map layer. More... | |
const QgsMapLayerServerProperties * | serverProperties () const |
Returns QGIS Server Properties const for the map layer. More... | |
void | setAbstract (const QString &abstract) |
Sets the abstract of the layer used by QGIS Server in GetCapabilities request. More... | |
void | setAttribution (const QString &attrib) |
Sets the attribution of the layer used by QGIS Server in GetCapabilities request. More... | |
void | setAttributionUrl (const QString &attribUrl) |
Sets the attribution URL of the layer used by QGIS Server in GetCapabilities request. More... | |
void | setAutoRefreshEnabled (bool enabled) |
Sets whether auto refresh is enabled for the layer. More... | |
void | setAutoRefreshInterval (int interval) |
Sets the auto refresh interval (in milliseconds) for the layer. More... | |
void | setBlendMode (QPainter::CompositionMode blendMode) |
Set the blending mode used for rendering a layer. More... | |
void | setCrs (const QgsCoordinateReferenceSystem &srs, bool emitSignal=true) |
Sets layer's spatial reference system. More... | |
template<class T > | |
void | setCustomEnumProperty (const QString &key, const T &value) |
Set the value of a property based on an enum. More... | |
template<class T > | |
void | setCustomFlagProperty (const QString &key, const T &value) |
Set the value of a property based on a flag. More... | |
void | setCustomProperties (const QgsObjectCustomProperties &properties) |
Set custom properties for layer. More... | |
Q_INVOKABLE void | setCustomProperty (const QString &key, const QVariant &value) |
Set a custom property for layer. More... | |
void | setDataSource (const QString &dataSource, const QString &baseName, const QString &provider, bool loadDefaultStyleFlag=false) |
Updates the data source of the layer. More... | |
void | setDataSource (const QString &dataSource, const QString &baseName, const QString &provider, const QgsDataProvider::ProviderOptions &options, bool loadDefaultStyleFlag=false) |
Updates the data source of the layer. More... | |
void | setDataSource (const QString &dataSource, const QString &baseName, const QString &provider, const QgsDataProvider::ProviderOptions &options, QgsDataProvider::ReadFlags flags) |
Updates the data source of the layer. More... | |
void | setDataUrl (const QString &dataUrl) |
Sets the DataUrl of the layer used by QGIS Server in GetCapabilities request. More... | |
void | setDataUrlFormat (const QString &dataUrlFormat) |
Sets the DataUrl format of the layer used by QGIS Server in GetCapabilities request. More... | |
void | setFlags (QgsMapLayer::LayerFlags flags) |
Returns the flags for this layer. More... | |
void | setKeywordList (const QString &keywords) |
Sets the keyword list of the layer used by QGIS Server in GetCapabilities request. More... | |
virtual void | setLayerOrder (const QStringList &layers) |
Reorders the previously selected sublayers of this layer from bottom to top. More... | |
void | setLegend (QgsMapLayerLegend *legend) |
Assign a legend controller to the map layer. More... | |
void | setLegendPlaceholderImage (const QString &imgPath) |
Set placeholder image for legend. More... | |
void | setLegendUrl (const QString &legendUrl) |
Sets the URL for the layer's legend. More... | |
void | setLegendUrlFormat (const QString &legendUrlFormat) |
Sets the format for a URL based layer legend. More... | |
virtual void | setMetadata (const QgsLayerMetadata &metadata) |
Sets the layer's metadata store. More... | |
Q_DECL_DEPRECATED void | setMetadataUrl (const QString &metaUrl) |
Sets the metadata URL of the layer used by QGIS Server in GetCapabilities request. More... | |
Q_DECL_DEPRECATED void | setMetadataUrlFormat (const QString &metaUrlFormat) |
Sets the metadata format of the layer used by QGIS Server in GetCapabilities request. More... | |
Q_DECL_DEPRECATED void | setMetadataUrlType (const QString &metaUrlType) |
Set the metadata type of the layer used by QGIS Server in GetCapabilities request MetadataUrlType indicates the standard to which the metadata complies. More... | |
void | setName (const QString &name) |
Set the display name of the layer. More... | |
virtual void | setOpacity (double opacity) |
Sets the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque). More... | |
void | setOriginalXmlProperties (const QString &originalXmlProperties) |
Sets the original XML properties for the layer to originalXmlProperties. More... | |
void | setRenderer3D (QgsAbstract3DRenderer *renderer) |
Sets 3D renderer for the layer. More... | |
void | setShortName (const QString &shortName) |
Sets the short name of the layer used by QGIS Server to identify the layer. More... | |
virtual void | setSubLayerVisibility (const QString &name, bool visible) |
Set the visibility of the given sublayer name. More... | |
void | setTitle (const QString &title) |
Sets the title of the layer used by QGIS Server in GetCapabilities request. More... | |
QString | shortName () const |
Returns the short name of the layer used by QGIS Server to identify the layer. More... | |
QString | source () const |
Returns the source for the layer. More... | |
QgsMapLayerStyleManager * | styleManager () const |
Gets access to the layer's style manager. More... | |
virtual QString | styleURI () const |
Retrieve the style URI for this layer (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) More... | |
virtual QStringList | subLayers () const |
Returns the sublayers of this layer. More... | |
virtual bool | supportsEditing () const |
Returns whether the layer supports editing or not. More... | |
virtual QgsMapLayerTemporalProperties * | temporalProperties () |
Returns the layer's temporal properties. More... | |
virtual QDateTime | timestamp () const |
Time stamp of data source in the moment when data/metadata were loaded by provider. More... | |
QString | title () const |
Returns the title of the layer used by QGIS Server in GetCapabilities request. More... | |
QgsCoordinateTransformContext | transformContext () const |
Returns the layer data provider coordinate transform context or a default transform context if the layer does not have a valid data provider. More... | |
QgsMapLayerType | type () const |
Returns the type of the layer. More... | |
QUndoStack * | undoStack () |
Returns pointer to layer's undo stack. More... | |
QUndoStack * | undoStackStyles () |
Returns pointer to layer's style undo stack. More... | |
QgsRectangle | wgs84Extent (bool forceRecalculate=false) const |
Returns the WGS84 extent (EPSG:4326) of the layer according to ReadFlag::FlagTrustLayerMetadata. More... | |
bool | writeLayerXml (QDomElement &layerElement, QDomDocument &document, const QgsReadWriteContext &context) const |
Stores state in DOM node. More... | |
virtual bool | writeStyle (QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) const |
Write just the symbology information for the layer into the document. More... | |
virtual bool | writeSymbology (QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) const =0 |
Write the style for the layer into the document provided. More... | |
Static Public Member Functions | |
static QString | extensionPropertyType (PropertyType type) |
Returns the extension of a Property. More... | |
static QString | formatLayerName (const QString &name) |
A convenience function to capitalize and format a layer name. More... | |
static QString | generateId (const QString &layerName) |
Generates an unique identifier for this layer, the generate ID is prefixed by layerName. More... | |
Protected Member Functions | |
void | appendError (const QgsErrorMessage &error) |
Add error message. More... | |
void | clone (QgsMapLayer *layer) const |
Copies attributes like name, short name, ... More... | |
QString | crsHtmlMetadata () const |
Returns a HTML fragment containing the layer's CRS metadata, for use in the htmlMetadata() method. More... | |
virtual QString | decodedSource (const QString &source, const QString &dataProvider, const QgsReadWriteContext &context) const |
Called by readLayerXML(), used by derived classes to decode provider's specific data source from project files. More... | |
virtual QString | encodedSource (const QString &source, const QgsReadWriteContext &context) const |
Called by writeLayerXML(), used by derived classes to encode provider's specific data source to project files. More... | |
QString | generalHtmlMetadata () const |
Returns an HTML fragment containing general metadata information, for use in the htmlMetadata() method. More... | |
Q_DECL_DEPRECATED bool | hasDependencyCycle (const QSet< QgsMapLayerDependency > &) const |
Checks whether a new set of dependencies will introduce a cycle this method is now deprecated and always return false , because circular dependencies are now correctly managed. More... | |
void | invalidateWgs84Extent () |
Invalidates the WGS84 extent. More... | |
void | readCommonStyle (const QDomElement &layerElement, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) |
Read style data common to all layer types. More... | |
void | readCustomProperties (const QDomNode &layerNode, const QString &keyStartsWith=QString()) |
Read custom properties from project file. More... | |
void | readStyleManager (const QDomNode &layerNode) |
Read style manager's configuration (if any). To be called by subclasses. More... | |
virtual bool | readXml (const QDomNode &layer_node, QgsReadWriteContext &context) |
Called by readLayerXML(), used by children to read state specific to them from project files. More... | |
void | setError (const QgsError &error) |
Sets error message. More... | |
virtual void | setExtent (const QgsRectangle &rect) |
Sets the extent. More... | |
void | setProviderType (const QString &providerType) |
Sets the providerType (provider key) More... | |
void | setValid (bool valid) |
Sets whether layer is valid or not. More... | |
void | writeCommonStyle (QDomElement &layerElement, QDomDocument &document, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) const |
Write style data common to all layer types. More... | |
void | writeCustomProperties (QDomNode &layerNode, QDomDocument &doc) const |
Write custom properties to project file. More... | |
void | writeStyleManager (QDomNode &layerNode, QDomDocument &doc) const |
Write style manager's configuration (if exists). To be called by subclasses. More... | |
virtual bool | writeXml (QDomNode &layer_node, QDomDocument &document, const QgsReadWriteContext &context) const |
Called by writeLayerXML(), used by children to write state specific to them to project files. More... | |
Protected Attributes | |
QString | mAbstract |
Description of the layer. More... | |
QString | mAttribution |
Attribution of the layer. More... | |
QString | mAttributionUrl |
int | mBlockStyleChangedSignal = 0 |
If non-zero, the styleChanged signal should not be emitted. More... | |
QString | mDataSource |
Data source description string, varies by layer type. More... | |
QString | mDataUrl |
DataUrl of the layer. More... | |
QString | mDataUrlFormat |
QSet< QgsMapLayerDependency > | mDependencies |
List of layers that may modify this layer on modification. More... | |
QgsError | mError |
Error. More... | |
bool | mIsRefreshOnNofifyEnabled = false |
QString | mKeywordList |
QString | mLayerName |
Name of the layer - used for display. More... | |
double | mLayerOpacity = 1.0 |
Layer opacity. More... | |
QString | mLegendUrl |
WMS legend. More... | |
QString | mLegendUrlFormat |
QString | mProviderKey |
Data provider key (name of the data provider) More... | |
QgsMapLayer::ReadFlags | mReadFlags = QgsMapLayer::ReadFlags() |
Read flags. It's up to the subclass to respect these when restoring state from XML. More... | |
QString | mRefreshOnNofifyMessage |
QString | mShortName |
bool | mShouldValidateCrs = true |
true if the layer's CRS should be validated and invalid CRSes are not permitted. More... | |
QString | mTitle |
bool | mValid = false |
Indicates if the layer is valid and can be drawn. More... | |
Properties | |
int | autoRefreshInterval |
QgsCoordinateReferenceSystem | crs |
bool | isValid |
QgsLayerMetadata | metadata |
QString | name |
double | opacity |
QgsMapLayerType | type |
Friends | |
class | QgsVectorLayer |
class | TestQgsMapLayer |
Base class for all map layer types.
This is the base class for all map layer types (vector, raster).
Definition at line 72 of file qgsmaplayer.h.
Flags for the map layer.
Definition at line 140 of file qgsmaplayer.h.
Maplayer has a style and a metadata property.
Enumerator | |
---|---|
Style | |
Metadata |
Definition at line 129 of file qgsmaplayer.h.
Flags which control project read behavior.
Definition at line 635 of file qgsmaplayer.h.
Categories of style to distinguish appropriate sections for import/export.
Definition at line 155 of file qgsmaplayer.h.
QgsMapLayer::QgsMapLayer | ( | QgsMapLayerType | type = QgsMapLayerType::VectorLayer , |
const QString & | name = QString() , |
||
const QString & | source = QString() |
||
) |
Constructor for QgsMapLayer.
type | layer type |
name | display name for the layer |
source | datasource of layer |
Definition at line 81 of file qgsmaplayer.cpp.
|
override |
Definition at line 99 of file qgsmaplayer.cpp.
|
delete |
QgsMapLayer cannot be copied.
|
inline |
Returns the abstract of the layer used by QGIS Server in GetCapabilities request.
Definition at line 323 of file qgsmaplayer.h.
|
virtual |
Accepts the specified symbology visitor, causing it to visit all symbols associated with the layer.
Returns true
if the visitor should continue visiting other objects, or false
if visiting should be canceled.
Reimplemented in QgsRasterLayer.
Definition at line 2175 of file qgsmaplayer.cpp.
|
inlineprotected |
Add error message.
Definition at line 1909 of file qgsmaplayer.h.
|
inline |
Returns the attribution of the layer used by QGIS Server in GetCapabilities request.
Attribution indicates the provider of a layer or collection of layers.
Definition at line 397 of file qgsmaplayer.h.
|
inline |
Returns the attribution URL of the layer used by QGIS Server in GetCapabilities request.
Attribution indicates the provider of a layer or collection of layers.
Definition at line 415 of file qgsmaplayer.h.
int QgsMapLayer::autoRefreshInterval | ( | ) | const |
Returns the auto refresh interval (in milliseconds).
Note that auto refresh is only active when hasAutoRefreshEnabled() is true
.
Definition at line 844 of file qgsmaplayer.cpp.
|
signal |
|
signal |
Emitted when all layers are loaded and references can be resolved, just before the references of this layer are resolved.
QPainter::CompositionMode QgsMapLayer::blendMode | ( | ) | const |
Returns the current blending mode for a layer.
Definition at line 315 of file qgsmaplayer.cpp.
|
signal |
Signal emitted when the blend mode is changed, through QgsMapLayer::setBlendMode()
|
pure virtual |
Returns a new instance equivalent to this one except for the id which is still unique.
Implemented in QgsPluginLayer, QgsVectorTileLayer, QgsVectorLayer, QgsRasterLayer, QgsPointCloudLayer, QgsMeshLayer, and QgsAnnotationLayer.
|
protected |
Copies attributes like name, short name, ...
into another layer.
layer | The copy recipient |
Definition at line 106 of file qgsmaplayer.cpp.
|
signal |
Emitted whenever the configuration is changed.
The project listens to this signal to be marked as dirty.
|
pure virtual |
Returns new instance of QgsMapLayerRenderer that will be used for rendering of given context.
Implemented in QgsVectorTileLayer, QgsRasterLayer, QgsPointCloudLayer, QgsMeshLayer, QgsAnnotationLayer, and QgsVectorLayer.
QgsCoordinateReferenceSystem QgsMapLayer::crs | ( | ) | const |
Returns the layer's spatial reference system.
Definition at line 927 of file qgsmaplayer.cpp.
|
signal |
Emit a signal that layer's CRS has been reset.
|
protected |
Returns a HTML fragment containing the layer's CRS metadata, for use in the htmlMetadata() method.
Definition at line 2360 of file qgsmaplayer.cpp.
|
inline |
Returns the property value for a property based on an enum.
This forces the output to be a valid and existing entry of the enum. Hence if the property value is incorrect, the given default value is returned. This tries first with property as a string (as the enum) and then as an integer value.
Definition at line 733 of file qgsmaplayer.h.
|
inline |
Returns the property value for a property based on a flag.
This forces the output to be a valid and existing entry of the flag. Hence if the property value is incorrect, the given default value is returned. This tries first with property as a string (using a byte array) and then as an integer value.
Definition at line 811 of file qgsmaplayer.h.
const QgsObjectCustomProperties & QgsMapLayer::customProperties | ( | ) | const |
Read all custom properties from layer.
Properties are stored in a map and saved in project file.
Definition at line 1982 of file qgsmaplayer.cpp.
QVariant QgsMapLayer::customProperty | ( | const QString & | value, |
const QVariant & | defaultValue = QVariant() |
||
) | const |
Read a custom property from layer.
Properties are stored in a map and saved in project file.
Definition at line 1987 of file qgsmaplayer.cpp.
|
signal |
Emitted when a custom property of the layer has been changed or removed.
QStringList QgsMapLayer::customPropertyKeys | ( | ) | const |
Returns list of all keys within custom properties.
Properties are stored in a map and saved in project file.
Definition at line 1959 of file qgsmaplayer.cpp.
|
signal |
Data of layer changed.
|
virtual |
Returns the layer's data provider, it may be nullptr
.
Reimplemented in QgsVectorTileLayer, QgsRasterLayer, QgsPluginLayer, QgsPointCloudLayer, QgsMeshLayer, QgsAnnotationLayer, and QgsVectorLayer.
Definition at line 185 of file qgsmaplayer.cpp.
|
virtual |
Returns the layer's data provider in a const-correct manner, it may be nullptr
.
Reimplemented in QgsVectorTileLayer, QgsRasterLayer, QgsPluginLayer, QgsPointCloudLayer, QgsMeshLayer, QgsAnnotationLayer, and QgsVectorLayer.
Definition at line 190 of file qgsmaplayer.cpp.
|
signal |
|
inline |
Returns the DataUrl of the layer used by QGIS Server in GetCapabilities request.
DataUrl is a a link to the underlying data represented by a particular layer.
Definition at line 359 of file qgsmaplayer.h.
|
inline |
Returns the DataUrl format of the layer used by QGIS Server in GetCapabilities request.
DataUrl is a a link to the underlying data represented by a particular layer.
Definition at line 377 of file qgsmaplayer.h.
|
protectedvirtual |
Called by readLayerXML(), used by derived classes to decode provider's specific data source from project files.
Typically resolving absolute or relative paths, usernames and passwords or drivers prefixes ("HDF5:")
source | data source to decode, typically read from layer's DOM element "datasource" |
dataProvider | string identification of data provider (e.g. "ogr"), typically read from layer's DOM element |
context | reading context (e.g. for conversion between relative and absolute paths) |
Reimplemented in QgsRasterLayer, QgsMeshLayer, QgsVectorTileLayer, QgsVectorLayer, and QgsPointCloudLayer.
Definition at line 760 of file qgsmaplayer.cpp.
|
virtual |
Gets the list of dependencies.
This includes data dependencies set by the user (
Reimplemented in QgsVectorLayer.
Definition at line 2185 of file qgsmaplayer.cpp.
|
signal |
Emitted when dependencies are changed.
|
signal |
Emitted when editing on this layer has started.
|
signal |
Emitted when edited changes have been successfully written to the data provider.
|
inlinevirtual |
Returns the layer's elevation properties.
This may be nullptr
, depending on the layer type.
Reimplemented in QgsPointCloudLayer.
Definition at line 1493 of file qgsmaplayer.h.
|
slot |
Triggers an emission of the styleChanged() signal.
Definition at line 2133 of file qgsmaplayer.cpp.
|
protectedvirtual |
Called by writeLayerXML(), used by derived classes to encode provider's specific data source to project files.
Typically resolving absolute or relative paths, usernames and passwords or drivers prefixes ("HDF5:")
source | data source to encode, typically QgsMapLayer::source() |
context | writing context (e.g. for conversion between relative and absolute paths) |
Reimplemented in QgsRasterLayer, QgsPointCloudLayer, QgsMeshLayer, QgsVectorTileLayer, and QgsVectorLayer.
Definition at line 754 of file qgsmaplayer.cpp.
|
virtual |
Gets current status error.
This error describes some principal problem for which layer cannot work and thus is not valid. It is not last error after accessing data by draw() etc.
Definition at line 2002 of file qgsmaplayer.cpp.
void QgsMapLayer::exportNamedMetadata | ( | QDomDocument & | doc, |
QString & | errorMsg | ||
) | const |
Export the current metadata of this layer as named metadata in a QDomDocument.
doc | the target QDomDocument |
errorMsg | this QString will be initialized on error |
Definition at line 1262 of file qgsmaplayer.cpp.
|
virtual |
Export the properties of this layer as named style in a QDomDocument.
doc | the target QDomDocument |
errorMsg | this QString will be initialized on error |
context | read write context |
categories | the style categories to export during the execution of writeSymbology |
Definition at line 1281 of file qgsmaplayer.cpp.
|
virtual |
Export the properties of this layer as SLD style in a QDomDocument.
doc | the target QDomDocument |
errorMsg | this QString will be initialized on error during the execution of writeSymbology |
Definition at line 1569 of file qgsmaplayer.cpp.
|
static |
Returns the extension of a Property.
Definition at line 68 of file qgsmaplayer.cpp.
|
virtual |
Returns the extent of the layer.
Reimplemented in QgsPointCloudLayer, QgsMeshLayer, QgsAnnotationLayer, and QgsVectorLayer.
Definition at line 300 of file qgsmaplayer.cpp.
QgsMapLayer::LayerFlags QgsMapLayer::flags | ( | ) | const |
Returns the flags for this layer.
Definition at line 145 of file qgsmaplayer.cpp.
|
signal |
|
static |
A convenience function to capitalize and format a layer name.
Definition at line 952 of file qgsmaplayer.cpp.
|
protected |
Returns an HTML fragment containing general metadata information, for use in the htmlMetadata() method.
Definition at line 2291 of file qgsmaplayer.cpp.
|
static |
Generates an unique identifier for this layer, the generate ID is prefixed by layerName.
Definition at line 2159 of file qgsmaplayer.cpp.
bool QgsMapLayer::hasAutoRefreshEnabled | ( | ) | const |
Returns true
if auto refresh is enabled for the layer.
Definition at line 839 of file qgsmaplayer.cpp.
|
inlineprotected |
Checks whether a new set of dependencies will introduce a cycle this method is now deprecated and always return false
, because circular dependencies are now correctly managed.
Definition at line 1960 of file qgsmaplayer.h.
bool QgsMapLayer::hasScaleBasedVisibility | ( | ) | const |
Returns whether scale based visibility is enabled for the layer.
true
if scale based visibility is enabled Definition at line 834 of file qgsmaplayer.cpp.
|
virtual |
Obtain a formatted HTML string containing assorted metadata for this layer.
Reimplemented in QgsVectorTileLayer, QgsRasterLayer, QgsPointCloudLayer, QgsMeshLayer, QgsAnnotationLayer, and QgsVectorLayer.
Definition at line 2123 of file qgsmaplayer.cpp.
QString QgsMapLayer::id | ( | ) | const |
Returns the layer's unique ID, which is used to access this layer from QgsProject.
Definition at line 164 of file qgsmaplayer.cpp.
bool QgsMapLayer::importNamedMetadata | ( | QDomDocument & | document, |
QString & | errorMessage | ||
) |
Import the metadata of this layer from a QDomDocument.
document | source QDomDocument |
errorMessage | this QString will be initialized on error |
true
on success Definition at line 1208 of file qgsmaplayer.cpp.
|
virtual |
Import the properties of this layer from a QDomDocument.
doc | source QDomDocument |
errorMsg | this QString will be initialized on error during the execution of readSymbology |
categories | the style categories to import |
true
on success Definition at line 1220 of file qgsmaplayer.cpp.
|
protected |
Invalidates the WGS84 extent.
If FlagTrustLayerMetadata is enabled, the extent is not invalidated because we want to trust metadata whatever happens.
Definition at line 2282 of file qgsmaplayer.cpp.
|
virtual |
Returns true
if the layer can be edited.
Reimplemented in QgsMeshLayer, QgsAnnotationLayer, and QgsVectorLayer.
Definition at line 2009 of file qgsmaplayer.cpp.
bool QgsMapLayer::isInScaleRange | ( | double | scale | ) | const |
Tests whether the layer should be visible at the specified scale.
The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
true
if the layer is visible at the given scale. Definition at line 827 of file qgsmaplayer.cpp.
|
virtual |
Returns true
if the layer has been modified since last commit/save.
false
. Reimplemented in QgsVectorLayer, and QgsMeshLayer.
Definition at line 2014 of file qgsmaplayer.cpp.
|
inline |
Returns true
if the refresh on provider nofification is enabled.
Definition at line 1443 of file qgsmaplayer.h.
|
virtual |
Returns true
if the layer is considered a spatial layer, ie it has some form of geometry associated with it.
Reimplemented in QgsRasterLayer, and QgsVectorLayer.
Definition at line 2019 of file qgsmaplayer.cpp.
|
virtual |
Returns true
if the layer is considered a temporary layer.
These include memory-only layers such as those created by the "memory" data provider, layers stored inside a local temporary folder (such as the "/tmp" folder on Linux) or layer with temporary data (as temporary mesh layer dataset)
Definition at line 2024 of file qgsmaplayer.cpp.
bool QgsMapLayer::isValid | ( | ) | const |
Returns the status of the layer.
An invalid layer is one which has a bad datasource or other problem. Child classes set this flag when initialized.
true
if the layer is valid and can be accessed Definition at line 814 of file qgsmaplayer.cpp.
|
signal |
Emitted when the validity of this layer changed.
|
inline |
Returns the keyword list of the layer used by QGIS Server in GetCapabilities request.
Definition at line 339 of file qgsmaplayer.h.
|
signal |
Emitted when modifications has been done on layer.
QgsMapLayerLegend * QgsMapLayer::legend | ( | ) | const |
|
signal |
Signal emitted when legend of the layer has changed.
|
inline |
Returns path to the placeholder image or an empty string if a generated legend is shown.
Definition at line 1500 of file qgsmaplayer.h.
|
inline |
Returns the URL for the layer's legend.
Definition at line 1271 of file qgsmaplayer.h.
|
inline |
Returns the format for a URL based layer legend.
Definition at line 1281 of file qgsmaplayer.h.
|
virtual |
Retrieve the default metadata for this layer if one exists (either as a .qmd file on disk or as a record in the users metadata table in their personal qgis.db)
resultFlag | a reference to a flag that will be set to false if we did not manage to load the default metadata. |
Reimplemented in QgsVectorTileLayer.
Definition at line 1035 of file qgsmaplayer.cpp.
|
virtual |
Retrieve the default style for this layer if one exists (either as a .qml file on disk or as a record in the users style table in their personal qgis.db)
resultFlag | a reference to a flag that will be set to false if we did not manage to load the default style. |
Reimplemented in QgsVectorTileLayer, QgsVectorLayer, QgsPointCloudLayer, and QgsMeshLayer.
Definition at line 1045 of file qgsmaplayer.cpp.
|
virtual |
Retrieve a named metadata for this layer if one exists (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db)
uri | - the file name or other URI for the metadata file. First an attempt will be made to see if this is a file and load that, if that fails the qgis.db metadata table will be consulted to see if there is a metadata who's key matches the URI. |
resultFlag | a reference to a flag that will be set to false if we did not manage to load the default metadata. |
Definition at line 1328 of file qgsmaplayer.cpp.
bool QgsMapLayer::loadNamedMetadataFromDatabase | ( | const QString & | db, |
const QString & | uri, | ||
QString & | qmd | ||
) |
Retrieve a named metadata for this layer from a sqlite database.
db | path to sqlite database |
uri | uri for table |
qmd | will be set to QMD xml metadata content from database |
true
if style was successfully loaded Definition at line 1050 of file qgsmaplayer.cpp.
|
virtual |
Retrieve a named style for this layer if one exists (either as a .qml file on disk or as a record in the users style table in their personal qgis.db)
uri | - the file name or other URI for the style file. First an attempt will be made to see if this is a file and load that, if that fails the qgis.db styles table will be consulted to see if there is a style who's key matches the URI. |
resultFlag | a reference to a flag that will be set to false if we did not manage to load the default style. |
categories | the style categories to be loaded. |
Reimplemented in QgsVectorLayer.
Definition at line 1111 of file qgsmaplayer.cpp.
|
virtual |
Retrieve a named style for this layer from a sqlite database.
db | path to sqlite database |
uri | uri for table |
qml | will be set to QML style content from database |
true
if style was successfully loaded Definition at line 1055 of file qgsmaplayer.cpp.
|
virtual |
Attempts to style the layer using the formatting from an SLD type file.
uri | uri of source SLD file |
resultFlag | a reference to a flag that will be set to false if the SLD file could not be loaded |
Definition at line 1711 of file qgsmaplayer.cpp.
double QgsMapLayer::maximumScale | ( | ) | const |
Returns the maximum map scale (i.e.
most "zoomed in" scale) at which the layer will be visible. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. A scale of 0 indicates no maximum scale visibility.
true
. Definition at line 883 of file qgsmaplayer.cpp.
|
virtual |
Returns a reference to the layer's metadata store.
Definition at line 873 of file qgsmaplayer.cpp.
|
signal |
|
virtual |
Retrieve the metadata URI for this layer (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db)
Definition at line 1003 of file qgsmaplayer.cpp.
QString QgsMapLayer::metadataUrl | ( | ) | const |
Returns the metadata URL of the layer used by QGIS Server in GetCapabilities request.
MetadataUrl is a a link to the detailed, standardized metadata about the data. Since QGIS 3.22, it returns the first metadata URL link.
Definition at line 217 of file qgsmaplayer.cpp.
QString QgsMapLayer::metadataUrlFormat | ( | ) | const |
Returns the metadata format of the layer used by QGIS Server in GetCapabilities request.
MetadataUrlType indicates how the metadata is structured. Since QGIS 3.22, it returns the first metadata URL format.
Definition at line 275 of file qgsmaplayer.cpp.
QString QgsMapLayer::metadataUrlType | ( | ) | const |
Returns the metadata type of the layer used by QGIS Server in GetCapabilities request.
MetadataUrlType indicates the standard to which the metadata complies. Since QGIS 3.22, it returns the first metadata URL type.
Definition at line 246 of file qgsmaplayer.cpp.
double QgsMapLayer::minimumScale | ( | ) | const |
Returns the minimum map scale (i.e.
most "zoomed out" scale) at which the layer will be visible. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. A scale of 0 indicates no minimum scale visibility.
true
. Definition at line 899 of file qgsmaplayer.cpp.
QString QgsMapLayer::name | ( | ) | const |
Returns the display name of the layer.
Definition at line 179 of file qgsmaplayer.cpp.
|
signal |
Emitted when the name has been changed.
|
virtual |
Returns the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque).
Reimplemented in QgsRasterLayer.
Definition at line 329 of file qgsmaplayer.cpp.
|
signal |
Emitted when the layer's opacity is changed, where opacity is a value between 0 (transparent) and 1 (opaque).
|
delete |
QgsMapLayer cannot be copied.
QString QgsMapLayer::originalXmlProperties | ( | ) | const |
Returns the XML properties of the original layer as they were when the layer was first read from the project file.
In case of new layers this is normally empty.
The storage format for the XML is qlr
Definition at line 2149 of file qgsmaplayer.cpp.
|
slot |
Returns the parent project if this map layer is added to a project.
Otherwise returns nullptr
Definition at line 2225 of file qgsmaplayer.cpp.
|
virtual |
Returns the map layer properties of this layer.
Reimplemented in QgsAnnotationLayer.
Definition at line 159 of file qgsmaplayer.cpp.
QString QgsMapLayer::providerType | ( | ) | const |
Returns the provider type (provider key) for this layer.
Definition at line 1852 of file qgsmaplayer.cpp.
QString QgsMapLayer::publicSource | ( | ) | const |
Gets a version of the internal layer definition that has sensitive bits removed (for example, the password).
This function should be used when displaying the source name for general viewing.
Definition at line 287 of file qgsmaplayer.cpp.
|
protected |
Read style data common to all layer types.
Definition at line 1857 of file qgsmaplayer.cpp.
|
protected |
Read custom properties from project file.
layerNode | note to read from |
keyStartsWith | reads only properties starting with the specified string (or all if the string is empty) |
Definition at line 775 of file qgsmaplayer.cpp.
bool QgsMapLayer::readLayerXml | ( | const QDomElement & | layerElement, |
QgsReadWriteContext & | context, | ||
QgsMapLayer::ReadFlags | flags = QgsMapLayer::ReadFlags() |
||
) |
Sets state from DOM document.
layerElement | The DOM element corresponding to `‘maplayer’' tag |
context | writing context (e.g. for conversion between relative and absolute paths) |
flags | optional argument which can be used to control layer reading behavior. |
The DOM node corresponds to a DOM document project file XML element read by QgsProject.
This, in turn, calls readXml() (and then readSymbology()), which is overridable by sub-classes so that they can read their own specific state from the given DOM node.
Invoked by QgsProject::read().
true
if successful Definition at line 334 of file qgsmaplayer.cpp.
|
inline |
Returns if this layer is read only.
Definition at line 529 of file qgsmaplayer.h.
|
inlinevirtual |
Reimplemented in QgsVectorLayer.
Definition at line 1144 of file qgsmaplayer.h.
|
virtual |
Read the style for the current layer from the DOM node supplied.
node | node that will contain the style definition for this layer. |
errorMessage | reference to string that will be updated with any error messages |
context | reading context (used for transform from relative to absolute paths) |
categories | the style categories to be read |
true
in case of success. false
. Reimplemented in QgsMeshLayer, and QgsPointCloudLayer.
Definition at line 1770 of file qgsmaplayer.cpp.
|
protected |
Read style manager's configuration (if any). To be called by subclasses.
Definition at line 795 of file qgsmaplayer.cpp.
|
pure virtual |
Read the symbology for the current layer from the DOM node supplied.
node | node that will contain the symbology definition for this layer. |
errorMessage | reference to string that will be updated with any error messages |
context | reading context (used for transform from relative to absolute paths) |
categories | the style categories to be read |
true
in case of success. Implemented in QgsVectorTileLayer, QgsPointCloudLayer, and QgsAnnotationLayer.
|
protectedvirtual |
Called by readLayerXML(), used by children to read state specific to them from project files.
Reimplemented in QgsVectorTileLayer, QgsPointCloudLayer, QgsAnnotationLayer, QgsRasterLayer, QgsMeshLayer, and QgsVectorLayer.
Definition at line 515 of file qgsmaplayer.cpp.
|
signal |
This is used to send a request that any mapcanvas using this layer update its extents.
|
inline |
Returns the message that should be notified by the provider to triggerRepaint.
Definition at line 1436 of file qgsmaplayer.h.
|
inlinevirtual |
Synchronises with changes in the datasource.
Reimplemented in QgsRasterLayer, QgsMeshLayer, and QgsVectorLayer.
Definition at line 534 of file qgsmaplayer.h.
void QgsMapLayer::removeCustomProperty | ( | const QString & | key | ) |
Remove a custom property from layer.
Properties are stored in a map and saved in project file.
Definition at line 1992 of file qgsmaplayer.cpp.
QgsAbstract3DRenderer * QgsMapLayer::renderer3D | ( | ) | const |
Returns 3D renderer associated with the layer.
May be nullptr
.
Definition at line 2097 of file qgsmaplayer.cpp.
|
signal |
Signal emitted when 3D renderer associated with the layer has changed.
|
signal |
Signal emitted when renderer is changed.
|
signal |
By emitting this signal the layer tells that either appearance or content have been changed and any view showing the rendered layer should refresh itself.
If deferredUpdate is true
then the layer will only be repainted when the canvas is next re-rendered, and will not trigger any canvas redraws itself.
|
signal |
Signal emitted when a layer requires an update in any 3D maps.
|
virtual |
Resolve references to other layers (kept as layer IDs after reading XML) into layer objects.
Reimplemented in QgsVectorLayer.
Definition at line 767 of file qgsmaplayer.cpp.
|
virtual |
Save the current metadata of this layer as the default metadata (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db)
resultFlag | a reference to a flag that will be set to false if we did not manage to save the default metadata. |
Definition at line 1008 of file qgsmaplayer.cpp.
|
virtual |
Save the properties of this layer as the default style (either as a .qml file on disk or as a record in the users style table in their personal qgis.db)
resultFlag | a reference to a flag that will be set to false if we did not manage to save the default style. |
Definition at line 1318 of file qgsmaplayer.cpp.
QString QgsMapLayer::saveNamedMetadata | ( | const QString & | uri, |
bool & | resultFlag | ||
) |
Save the current metadata of this layer as a named metadata (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db)
uri | the file name or other URI for the metadata file. First an attempt will be made to see if this is a file and save to that, if that fails the qgis.db metadata table will be used to create a metadata entry who's key matches the URI. |
resultFlag | a reference to a flag that will be set to false if we did not manage to save the default metadata. |
Definition at line 1323 of file qgsmaplayer.cpp.
|
virtual |
Save the properties of this layer as a named style (either as a .qml file on disk or as a record in the users style table in their personal qgis.db)
uri | the file name or other URI for the style file. First an attempt will be made to see if this is a file and save to that, if that fails the qgis.db styles table will be used to create a style entry who's key matches the URI. |
resultFlag | a reference to a flag that will be set to false if we did not manage to save the default style. |
categories | the style categories to be saved. |
Definition at line 1564 of file qgsmaplayer.cpp.
|
virtual |
Saves the properties of this layer to an SLD format file.
uri | uri of destination for exported SLD file. |
resultFlag | a reference to a flag that will be set to false if the SLD file could not be generated |
Definition at line 1646 of file qgsmaplayer.cpp.
|
inline |
Returns QGIS Server Properties for the map layer.
Definition at line 423 of file qgsmaplayer.h.
|
inline |
Returns QGIS Server Properties const for the map layer.
Definition at line 429 of file qgsmaplayer.h.
|
inline |
Sets the abstract of the layer used by QGIS Server in GetCapabilities request.
Definition at line 315 of file qgsmaplayer.h.
|
inline |
Sets the attribution of the layer used by QGIS Server in GetCapabilities request.
Attribution indicates the provider of a layer or collection of layers.
Definition at line 388 of file qgsmaplayer.h.
|
inline |
Sets the attribution URL of the layer used by QGIS Server in GetCapabilities request.
Attribution indicates the provider of a layer or collection of layers.
Definition at line 406 of file qgsmaplayer.h.
void QgsMapLayer::setAutoRefreshEnabled | ( | bool | enabled | ) |
Sets whether auto refresh is enabled for the layer.
Definition at line 863 of file qgsmaplayer.cpp.
void QgsMapLayer::setAutoRefreshInterval | ( | int | interval | ) |
Sets the auto refresh interval (in milliseconds) for the layer.
This will cause the layer to be automatically redrawn on a matching interval. Note that auto refresh must be enabled by calling setAutoRefreshEnabled().
Note that auto refresh triggers deferred repaints of the layer. Any map canvas must be refreshed separately in order to view the refreshed layer.
Definition at line 849 of file qgsmaplayer.cpp.
void QgsMapLayer::setBlendMode | ( | QPainter::CompositionMode | blendMode | ) |
Set the blending mode used for rendering a layer.
blendMode | new blending mode |
Definition at line 305 of file qgsmaplayer.cpp.
void QgsMapLayer::setCrs | ( | const QgsCoordinateReferenceSystem & | srs, |
bool | emitSignal = true |
||
) |
Sets layer's spatial reference system.
Definition at line 932 of file qgsmaplayer.cpp.
|
inline |
Set the value of a property based on an enum.
The property will be saved as string.
Definition at line 785 of file qgsmaplayer.h.
|
inline |
Set the value of a property based on a flag.
The property will be saved as string.
Definition at line 875 of file qgsmaplayer.h.
void QgsMapLayer::setCustomProperties | ( | const QgsObjectCustomProperties & | properties | ) |
Set custom properties for layer.
Current properties are dropped.
Definition at line 1973 of file qgsmaplayer.cpp.
void QgsMapLayer::setCustomProperty | ( | const QString & | key, |
const QVariant & | value | ||
) |
Set a custom property for layer.
Properties are stored in a map and saved in project file.
Definition at line 1964 of file qgsmaplayer.cpp.
void QgsMapLayer::setDataSource | ( | const QString & | dataSource, |
const QString & | baseName, | ||
const QString & | provider, | ||
bool | loadDefaultStyleFlag = false |
||
) |
Updates the data source of the layer.
The layer's renderer and legend will be preserved only if the geometry type of the new data source matches the current geometry type of the layer.
This method was defined in QgsVectorLayer since 2.10 and was marked as deprecated since 3.2
dataSource | new layer data source |
baseName | base name of the layer |
provider | provider string |
loadDefaultStyleFlag | set to true to reset the layer's style to the default for the data source |
Definition at line 1791 of file qgsmaplayer.cpp.
void QgsMapLayer::setDataSource | ( | const QString & | dataSource, |
const QString & | baseName, | ||
const QString & | provider, | ||
const QgsDataProvider::ProviderOptions & | options, | ||
bool | loadDefaultStyleFlag = false |
||
) |
Updates the data source of the layer.
The layer's renderer and legend will be preserved only if the geometry type of the new data source matches the current geometry type of the layer.
dataSource | new layer data source |
baseName | base name of the layer |
provider | provider string |
options | provider options |
loadDefaultStyleFlag | set to true to reset the layer's style to the default for the data source |
Definition at line 1809 of file qgsmaplayer.cpp.
void QgsMapLayer::setDataSource | ( | const QString & | dataSource, |
const QString & | baseName, | ||
const QString & | provider, | ||
const QgsDataProvider::ProviderOptions & | options, | ||
QgsDataProvider::ReadFlags | flags | ||
) |
Updates the data source of the layer.
The layer's renderer and legend will be preserved only if the geometry type of the new data source matches the current geometry type of the layer.
Subclasses should override setDataSourcePrivate: default implementation does nothing.
dataSource | new layer data source |
baseName | base name of the layer |
provider | provider string |
options | provider options |
flags | provider read flags which control dataprovider construction like FlagTrustDataSource, FlagLoadDefaultStyle, etc |
Definition at line 1825 of file qgsmaplayer.cpp.
|
inline |
Sets the DataUrl of the layer used by QGIS Server in GetCapabilities request.
DataUrl is a a link to the underlying data represented by a particular layer.
Definition at line 350 of file qgsmaplayer.h.
|
inline |
Sets the DataUrl format of the layer used by QGIS Server in GetCapabilities request.
DataUrl is a a link to the underlying data represented by a particular layer.
Definition at line 368 of file qgsmaplayer.h.
|
virtualslot |
Sets the list of dependencies.
layers | set of QgsMapLayerDependency. Only user-defined dependencies will be added |
false
if a dependency cycle has been detected Reimplemented in QgsVectorLayer.
Definition at line 2190 of file qgsmaplayer.cpp.
|
inlineprotected |
Sets error message.
Definition at line 1911 of file qgsmaplayer.h.
|
protectedvirtual |
Sets the extent.
Reimplemented in QgsVectorLayer, and QgsPluginLayer.
Definition at line 2139 of file qgsmaplayer.cpp.
void QgsMapLayer::setFlags | ( | QgsMapLayer::LayerFlags | flags | ) |
Returns the flags for this layer.
Definition at line 150 of file qgsmaplayer.cpp.
|
inline |
Sets the keyword list of the layer used by QGIS Server in GetCapabilities request.
Definition at line 331 of file qgsmaplayer.h.
|
virtual |
Reorders the previously selected sublayers of this layer from bottom to top.
(Useful for providers that manage their own layers, such as WMS).
Reimplemented in QgsRasterLayer.
Definition at line 909 of file qgsmaplayer.cpp.
void QgsMapLayer::setLegend | ( | QgsMapLayerLegend * | legend | ) |
Assign a legend controller to the map layer.
The object will be responsible for providing legend items.
legend | Takes ownership of the object. Can be nullptr . |
Definition at line 2058 of file qgsmaplayer.cpp.
|
inline |
Set placeholder image for legend.
If the string is empty, a generated legend will be shown.
imgPath | file path to the placeholder image |
Definition at line 1507 of file qgsmaplayer.h.
|
inline |
Sets the URL for the layer's legend.
Definition at line 1266 of file qgsmaplayer.h.
|
inline |
Sets the format for a URL based layer legend.
Definition at line 1276 of file qgsmaplayer.h.
|
slot |
Sets the maximum map scale (i.e.
most "zoomed in" scale) at which the layer will be visible. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. A scale of 0 indicates no maximum scale visibility.
true
. Definition at line 878 of file qgsmaplayer.cpp.
|
virtual |
Sets the layer's metadata store.
Definition at line 2116 of file qgsmaplayer.cpp.
void QgsMapLayer::setMetadataUrl | ( | const QString & | metaUrl | ) |
Sets the metadata URL of the layer used by QGIS Server in GetCapabilities request.
MetadataUrl is a a link to the detailed, standardized metadata about the data. Since QGIS 3.22, it edits the first metadata URL link.
Definition at line 200 of file qgsmaplayer.cpp.
void QgsMapLayer::setMetadataUrlFormat | ( | const QString & | metaUrlFormat | ) |
Sets the metadata format of the layer used by QGIS Server in GetCapabilities request.
MetadataUrlType indicates how the metadata is structured. Since QGIS 3.22, it edits the first metadata URL format.
Definition at line 258 of file qgsmaplayer.cpp.
void QgsMapLayer::setMetadataUrlType | ( | const QString & | metaUrlType | ) |
Set the metadata type of the layer used by QGIS Server in GetCapabilities request MetadataUrlType indicates the standard to which the metadata complies.
Since QGIS 3.22, it edits the first metadata URL type.
Definition at line 229 of file qgsmaplayer.cpp.
|
slot |
Sets the minimum map scale (i.e.
most "zoomed out" scale) at which the layer will be visible. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. A scale of 0 indicates no minimum scale visibility.
true
. Definition at line 889 of file qgsmaplayer.cpp.
void QgsMapLayer::setName | ( | const QString & | name | ) |
Set the display name of the layer.
Definition at line 169 of file qgsmaplayer.cpp.
|
virtual |
Sets the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque).
Reimplemented in QgsRasterLayer.
Definition at line 320 of file qgsmaplayer.cpp.
void QgsMapLayer::setOriginalXmlProperties | ( | const QString & | originalXmlProperties | ) |
Sets the original XML properties for the layer to originalXmlProperties.
The storage format for the XML is qlr
Definition at line 2154 of file qgsmaplayer.cpp.
|
protected |
Sets the providerType (provider key)
Definition at line 2180 of file qgsmaplayer.cpp.
|
inlineslot |
Set the notification message that triggers repaint If refresh on notification is enabled, the notification will triggerRepaint only if the notification message is equal to.
message |
Definition at line 1590 of file qgsmaplayer.h.
|
slot |
Set whether provider notification is connected to triggerRepaint.
Definition at line 2205 of file qgsmaplayer.cpp.
void QgsMapLayer::setRenderer3D | ( | QgsAbstract3DRenderer * | renderer | ) |
Sets 3D renderer for the layer.
Takes ownership of the renderer.
Definition at line 2085 of file qgsmaplayer.cpp.
|
slot |
Sets whether scale based visibility is enabled for the layer.
enabled | set to true to enable scale based visibility |
Definition at line 894 of file qgsmaplayer.cpp.
|
inline |
Sets the short name of the layer used by QGIS Server to identify the layer.
Definition at line 285 of file qgsmaplayer.h.
|
virtual |
Set the visibility of the given sublayer name.
name | sublayer name |
visible | sublayer visibility |
Reimplemented in QgsRasterLayer.
Definition at line 915 of file qgsmaplayer.cpp.
|
inline |
Sets the title of the layer used by QGIS Server in GetCapabilities request.
Definition at line 299 of file qgsmaplayer.h.
|
pure virtualslot |
Sets the coordinate transform context to transformContext.
Implemented in QgsVectorTileLayer, QgsPointCloudLayer, and QgsAnnotationLayer.
|
protected |
Sets whether layer is valid or not.
Definition at line 2049 of file qgsmaplayer.cpp.
QString QgsMapLayer::shortName | ( | ) | const |
Returns the short name of the layer used by QGIS Server to identify the layer.
Definition at line 195 of file qgsmaplayer.cpp.
QString QgsMapLayer::source | ( | ) | const |
Returns the source for the layer.
This source may contain usernames, passwords and other sensitive information.
Definition at line 295 of file qgsmaplayer.cpp.
|
signal |
Emit a signal with status (e.g. to be caught by QgisApp and display a msg on status bar)
|
signal |
Signal emitted whenever a change affects the layer's style.
Ie this may be triggered by renderer changes, label style changes, or other style changes such as blend mode or layer opacity changes.
|
signal |
Emitted when a style has been loaded.
categories | style categories |
QgsMapLayerStyleManager * QgsMapLayer::styleManager | ( | ) | const |
Gets access to the layer's style manager.
Style manager allows switching between multiple styles.
Definition at line 2080 of file qgsmaplayer.cpp.
|
virtual |
Retrieve the style URI for this layer (either as a .qml file on disk or as a record in the users style table in their personal qgis.db)
Definition at line 1040 of file qgsmaplayer.cpp.
|
virtual |
Returns the sublayers of this layer.
(Useful for providers that manage their own layers, such as WMS).
Reimplemented in QgsRasterLayer, and QgsMeshLayer.
Definition at line 904 of file qgsmaplayer.cpp.
|
virtual |
Returns whether the layer supports editing or not.
false
if the layer is read only or the data provider has no editing capabilities. false
. Reimplemented in QgsVectorLayer, QgsMeshLayer, and QgsAnnotationLayer.
Definition at line 922 of file qgsmaplayer.cpp.
|
inlinevirtual |
Returns the layer's temporal properties.
This may be nullptr
, depending on the layer type.
Reimplemented in QgsVectorLayer, QgsRasterLayer, and QgsMeshLayer.
Definition at line 1486 of file qgsmaplayer.h.
|
virtual |
Time stamp of data source in the moment when data/metadata were loaded by provider.
Reimplemented in QgsRasterLayer.
Definition at line 2128 of file qgsmaplayer.cpp.
|
inline |
Returns the title of the layer used by QGIS Server in GetCapabilities request.
Definition at line 307 of file qgsmaplayer.h.
QgsCoordinateTransformContext QgsMapLayer::transformContext | ( | ) | const |
Returns the layer data provider coordinate transform context or a default transform context if the layer does not have a valid data provider.
Definition at line 946 of file qgsmaplayer.cpp.
|
slot |
Will advise any 3D maps that this layer requires to be updated in the scene.
Will emit a request3DUpdate() signal.
Definition at line 2111 of file qgsmaplayer.cpp.
|
slot |
Will advise the map canvas (and any other interested party) that this layer requires to be repainted.
Will emit a repaintRequested() signal. If deferredUpdate is true
then the layer will only be repainted when the canvas is next re-rendered, and will not trigger any canvas redraws itself.
Definition at line 2102 of file qgsmaplayer.cpp.
QgsMapLayerType QgsMapLayer::type | ( | ) | const |
Returns the type of the layer.
Definition at line 140 of file qgsmaplayer.cpp.
QUndoStack * QgsMapLayer::undoStack | ( | ) |
Returns pointer to layer's undo stack.
Definition at line 1949 of file qgsmaplayer.cpp.
QUndoStack * QgsMapLayer::undoStackStyles | ( | ) |
Returns pointer to layer's style undo stack.
Definition at line 1954 of file qgsmaplayer.cpp.
QgsRectangle QgsMapLayer::wgs84Extent | ( | bool | forceRecalculate = false | ) | const |
Returns the WGS84 extent (EPSG:4326) of the layer according to ReadFlag::FlagTrustLayerMetadata.
If that flag is activated, then the WGS84 extent read in the qgs project is returned. Otherwise, the actual WGS84 extent is returned.
forceRecalculate | True to return the current WGS84 extent whatever the read flags |
Definition at line 2243 of file qgsmaplayer.cpp.
|
signal |
Emitted in the destructor when the layer is about to be deleted, but it is still in a perfectly valid state: the last chance for other pieces of code for some cleanup if they use the layer.
|
protected |
Write style data common to all layer types.
Definition at line 674 of file qgsmaplayer.cpp.
|
protected |
Write custom properties to project file.
Definition at line 790 of file qgsmaplayer.cpp.
bool QgsMapLayer::writeLayerXml | ( | QDomElement & | layerElement, |
QDomDocument & | document, | ||
const QgsReadWriteContext & | context | ||
) | const |
Stores state in DOM node.
layerElement | is a DOM element corresponding to `‘maplayer’' tag |
document | is a the DOM document being written |
context | reading context (e.g. for conversion between relative and absolute paths) |
The DOM node corresponds to a DOM document project file XML element to be written by QgsProject.
This, in turn, calls writeXml() (and then writeSymbology), which is over-rideable by sub-classes so that they can write their own specific state to the given DOM node.
Invoked by QgsProject::write().
true
if successful Definition at line 535 of file qgsmaplayer.cpp.
|
virtual |
Write just the symbology information for the layer into the document.
node | the node that will have the style element added to it. |
doc | the document that will have the QDomNode added. |
errorMessage | reference to string that will be updated with any error messages |
context | writing context (used for transform from absolute to relative paths) |
categories | the style categories to be written |
true
in case of success. false
. Reimplemented in QgsMeshLayer, and QgsPointCloudLayer.
Definition at line 1779 of file qgsmaplayer.cpp.
|
protected |
Write style manager's configuration (if exists). To be called by subclasses.
Definition at line 804 of file qgsmaplayer.cpp.
|
pure virtual |
Write the style for the layer into the document provided.
node | the node that will have the style element added to it. |
doc | the document that will have the QDomNode added. |
errorMessage | reference to string that will be updated with any error messages |
context | writing context (used for transform from absolute to relative paths) |
categories | the style categories to be written |
true
in case of success. Implemented in QgsVectorTileLayer, QgsPointCloudLayer, and QgsAnnotationLayer.
|
protectedvirtual |
Called by writeLayerXML(), used by children to write state specific to them to project files.
Reimplemented in QgsVectorTileLayer, QgsPointCloudLayer, QgsRasterLayer, QgsMeshLayer, QgsAnnotationLayer, and QgsVectorLayer.
Definition at line 744 of file qgsmaplayer.cpp.
|
friend |
Definition at line 2113 of file qgsmaplayer.h.
|
friend |
Definition at line 2114 of file qgsmaplayer.h.
|
protected |
Description of the layer.
Definition at line 1934 of file qgsmaplayer.h.
|
protected |
Attribution of the layer.
Definition at line 1942 of file qgsmaplayer.h.
|
protected |
Definition at line 1943 of file qgsmaplayer.h.
|
protected |
If non-zero, the styleChanged signal should not be emitted.
Definition at line 1992 of file qgsmaplayer.h.
|
protected |
Data source description string, varies by layer type.
Definition at line 1925 of file qgsmaplayer.h.
|
protected |
DataUrl of the layer.
Definition at line 1938 of file qgsmaplayer.h.
|
protected |
Definition at line 1939 of file qgsmaplayer.h.
|
protected |
List of layers that may modify this layer on modification.
Definition at line 1953 of file qgsmaplayer.h.
|
protected |
Error.
Definition at line 1950 of file qgsmaplayer.h.
|
protected |
Definition at line 1962 of file qgsmaplayer.h.
|
protected |
Definition at line 1935 of file qgsmaplayer.h.
|
protected |
Name of the layer - used for display.
Definition at line 1928 of file qgsmaplayer.h.
|
protected |
|
protected |
WMS legend.
Definition at line 1946 of file qgsmaplayer.h.
|
protected |
Definition at line 1947 of file qgsmaplayer.h.
|
protected |
Data provider key (name of the data provider)
Definition at line 1966 of file qgsmaplayer.h.
|
protected |
Read flags. It's up to the subclass to respect these when restoring state from XML.
Definition at line 1971 of file qgsmaplayer.h.
|
protected |
Definition at line 1963 of file qgsmaplayer.h.
|
protected |
Definition at line 1930 of file qgsmaplayer.h.
|
protected |
true
if the layer's CRS should be validated and invalid CRSes are not permitted.
Definition at line 1978 of file qgsmaplayer.h.
|
protected |
Definition at line 1931 of file qgsmaplayer.h.
|
protected |
Indicates if the layer is valid and can be drawn.
Definition at line 1922 of file qgsmaplayer.h.
|
readwrite |
Definition at line 2137 of file qgsmaplayer.h.
|
readwrite |
Definition at line 2137 of file qgsmaplayer.h.
|
read |
Definition at line 2137 of file qgsmaplayer.h.
|
readwrite |
Definition at line 2137 of file qgsmaplayer.h.
|
readwrite |
Definition at line 2137 of file qgsmaplayer.h.
|
readwrite |
Definition at line 2137 of file qgsmaplayer.h.
|
read |
Definition at line 2137 of file qgsmaplayer.h.