QGIS API Documentation 3.39.0-Master (e8f1b343c48)
|
Implements a map layer that is dedicated to rendering of vector tiles. More...
#include <qgsvectortilelayer.h>
Classes | |
struct | LayerOptions |
Setting options for loading vector tile layers. More... | |
Public Slots | |
void | removeSelection () |
Clear selection. | |
Public Slots inherited from QgsMapLayer | |
void | emitStyleChanged () |
Triggers an emission of the styleChanged() signal. | |
QgsProject * | project () const |
Returns the parent project if this map layer is added to a project. | |
virtual bool | setDependencies (const QSet< QgsMapLayerDependency > &layers) |
Sets the list of dependencies. | |
void | setMaximumScale (double scale) |
Sets the maximum map scale (i.e. | |
void | setMinimumScale (double scale) |
Sets the minimum map scale (i.e. | |
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. | |
void | setRefreshOnNotifyEnabled (bool enabled) |
Set whether provider notification is connected to triggerRepaint. | |
void | setScaleBasedVisibility (bool enabled) |
Sets whether scale based visibility is enabled for the layer. | |
void | trigger3DUpdate () |
Will advise any 3D maps that this layer requires to be updated in the scene. | |
void | triggerRepaint (bool deferredUpdate=false) |
Will advise the map canvas (and any other interested party) that this layer requires to be repainted. | |
Signals | |
void | selectionChanged () |
Emitted whenever the selected features in the layer are changed. | |
Signals inherited from QgsMapLayer | |
void | autoRefreshIntervalChanged (int interval) |
Emitted when the auto refresh interval changes. | |
void | beforeResolveReferences (QgsProject *project) |
Emitted when all layers are loaded and references can be resolved, just before the references of this layer are resolved. | |
void | blendModeChanged (QPainter::CompositionMode blendMode) |
Signal emitted when the blend mode is changed, through QgsMapLayer::setBlendMode() | |
void | configChanged () |
Emitted whenever the configuration is changed. | |
void | crs3DChanged () |
Emitted when the crs3D() of the layer has changed. | |
void | crsChanged () |
Emitted when the crs() of the layer has changed. | |
void | customPropertyChanged (const QString &key) |
Emitted when a custom property of the layer has been changed or removed. | |
void | dataChanged () |
Data of layer changed. | |
void | dataSourceChanged () |
Emitted whenever the layer's data source has been changed. | |
void | dependenciesChanged () |
Emitted when dependencies are changed. | |
void | editingStarted () |
Emitted when editing on this layer has started. | |
void | editingStopped () |
Emitted when edited changes have been successfully written to the data provider. | |
void | flagsChanged () |
Emitted when layer's flags have been modified. | |
void | idChanged (const QString &id) |
Emitted when the layer's ID has been changed. | |
void | isValidChanged () |
Emitted when the validity of this layer changed. | |
void | layerModified () |
Emitted when modifications has been done on layer. | |
void | legendChanged () |
Signal emitted when legend of the layer has changed. | |
void | mapTipsEnabledChanged () |
Emitted when map tips are enabled or disabled for the layer. | |
void | mapTipTemplateChanged () |
Emitted when the map tip template changes. | |
void | metadataChanged () |
Emitted when the layer's metadata is changed. | |
void | nameChanged () |
Emitted when the name has been changed. | |
void | opacityChanged (double opacity) |
Emitted when the layer's opacity is changed, where opacity is a value between 0 (transparent) and 1 (opaque). | |
void | recalculateExtents () const |
This is used to send a request that any mapcanvas using this layer update its extents. | |
void | renderer3DChanged () |
Signal emitted when 3D renderer associated with the layer has changed. | |
void | rendererChanged () |
Signal emitted when renderer is changed. | |
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. | |
void | request3DUpdate () |
Signal emitted when a layer requires an update in any 3D maps. | |
void | statusChanged (const QString &status) |
Emit a signal with status (e.g. to be caught by QgisApp and display a msg on status bar) | |
void | styleChanged () |
Signal emitted whenever a change affects the layer's style. | |
void | styleLoaded (QgsMapLayer::StyleCategories categories) |
Emitted when a style has been loaded. | |
void | verticalCrsChanged () |
Emitted when the verticalCrs() of the layer has changed. | |
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. | |
Public Member Functions | |
QgsVectorTileLayer (const QString &path=QString(), const QString &baseName=QString(), const QgsVectorTileLayer::LayerOptions &options=QgsVectorTileLayer::LayerOptions()) | |
Constructs a new vector tile layer. | |
~QgsVectorTileLayer () override | |
QgsVectorTileLayer * | clone () const override |
Returns a new instance equivalent to this one except for the id which is still unique. | |
QgsMapLayerRenderer * | createMapRenderer (QgsRenderContext &rendererContext) override |
Returns new instance of QgsMapLayerRenderer that will be used for rendering of given context. | |
const QgsDataProvider * | dataProvider () const override |
Returns the layer's data provider in a const-correct manner, it may be nullptr . | |
QgsDataProvider * | dataProvider () override |
Returns the layer's data provider, it may be nullptr . | |
QString | decodedSource (const QString &source, const QString &provider, const QgsReadWriteContext &context) const FINAL |
Called by readLayerXML(), used by derived classes to decode provider's specific data source from project files. | |
QString | encodedSource (const QString &source, const QgsReadWriteContext &context) const FINAL |
Called by writeLayerXML(), used by derived classes to encode provider's specific data source to project files. | |
QgsVectorTileRawData | getRawTile (QgsTileXYZ tileID) |
Fetches raw tile data for the give tile coordinates. | |
QString | htmlMetadata () const override |
Obtain a formatted HTML string containing assorted metadata for this layer. | |
bool | isTileBorderRenderingEnabled () const |
Returns whether to render also borders of tiles (useful for debugging) | |
QgsVectorTileLabeling * | labeling () const |
Returns currently assigned labeling. | |
bool | labelsEnabled () const |
Returns whether the layer contains labels which are enabled and should be drawn. | |
QString | loadDefaultMetadata (bool &resultFlag) override |
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) | |
QString | loadDefaultStyle (bool &resultFlag) override |
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) | |
bool | loadDefaultStyle (QString &error, QStringList &warnings) |
Loads the default style for the layer, and returns true if the style was successfully loaded. | |
bool | loadDefaultStyleAndSubLayers (QString &error, QStringList &warnings, QList< QgsMapLayer * > &subLayers) |
Loads the default style for the layer, and returns true if the style was successfully loaded. | |
Qgis::MapLayerProperties | properties () const override |
Returns the map layer properties of this layer. | |
bool | readSymbology (const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) override |
Read the symbology for the current layer from the DOM node supplied. | |
bool | readXml (const QDomNode &layerNode, QgsReadWriteContext &context) override |
Called by readLayerXML(), used by children to read state specific to them from project files. | |
QgsVectorTileRenderer * | renderer () const |
Returns currently assigned renderer. | |
void | selectByGeometry (const QgsGeometry &geometry, const QgsSelectionContext &context, Qgis::SelectBehavior behavior=Qgis::SelectBehavior::SetSelection, Qgis::SelectGeometryRelationship relationship=Qgis::SelectGeometryRelationship::Intersect, Qgis::SelectionFlags flags=Qgis::SelectionFlags(), QgsRenderContext *renderContext=nullptr) |
Selects features found within the search geometry (in layer's coordinates). | |
int | selectedFeatureCount () const |
Returns the number of features that are selected in this layer. | |
QList< QgsFeature > | selectedFeatures () const |
Returns the list of features currently selected in the layer. | |
void | setLabeling (QgsVectorTileLabeling *labeling) |
Sets labeling for the map layer. | |
void | setLabelsEnabled (bool enabled) |
Sets whether labels should be enabled for the layer. | |
void | setRenderer (QgsVectorTileRenderer *r) |
Sets renderer for the map layer. | |
void | setTileBorderRenderingEnabled (bool enabled) |
Sets whether to render also borders of tiles (useful for debugging) | |
void | setTransformContext (const QgsCoordinateTransformContext &transformContext) override |
Sets the coordinate transform context to transformContext. | |
int | sourceMaxZoom () const |
Returns maximum zoom level at which source has any valid tiles (negative = unconstrained) | |
int | sourceMinZoom () const |
Returns minimum zoom level at which source has any valid tiles (negative = unconstrained) | |
QString | sourcePath () const |
Returns URL/path of the data source (syntax different to each data source type) | |
QString | sourceType () const |
Returns type of the data source. | |
QgsVectorTileMatrixSet & | tileMatrixSet () |
Returns the vector tile matrix set. | |
bool | writeSymbology (QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) const override |
Write the style for the layer into the document provided. | |
bool | writeXml (QDomNode &layerNode, QDomDocument &doc, const QgsReadWriteContext &context) const override |
Called by writeLayerXML(), used by children to write state specific to them to project files. | |
Public Member Functions inherited from QgsMapLayer | |
QgsMapLayer (const QgsMapLayer &)=delete | |
QgsMapLayer (Qgis::LayerType type=Qgis::LayerType::Vector, const QString &name=QString(), const QString &source=QString()) | |
Constructor for QgsMapLayer. | |
~QgsMapLayer () override | |
Q_DECL_DEPRECATED QString | abstract () const |
Returns the abstract of the layer used by QGIS Server in GetCapabilities request. | |
virtual bool | accept (QgsStyleEntityVisitorInterface *visitor) const |
Accepts the specified symbology visitor, causing it to visit all symbols associated with the layer. | |
Q_DECL_DEPRECATED QString | attribution () const |
Returns the attribution of the layer used by QGIS Server in GetCapabilities request. | |
Q_DECL_DEPRECATED QString | attributionUrl () const |
Returns the attribution URL of the layer used by QGIS Server in GetCapabilities request. | |
int | autoRefreshInterval () const |
Returns the auto refresh interval (in milliseconds). | |
Qgis::AutoRefreshMode | autoRefreshMode () const |
Returns the layer's automatic refresh mode. | |
QPainter::CompositionMode | blendMode () const |
Returns the current blending mode for a layer. | |
QgsCoordinateReferenceSystem | crs () const |
Returns the layer's spatial reference system. | |
QgsCoordinateReferenceSystem | crs3D () const |
Returns the CRS to use for the layer when transforming 3D data, or when z/elevation value handling is important. | |
template<class T > | |
T | customEnumProperty (const QString &key, const T &defaultValue) |
Returns the property value for a property based on an enum. | |
template<class T > | |
T | customFlagProperty (const QString &key, const T &defaultValue) |
Returns the property value for a property based on a flag. | |
const QgsObjectCustomProperties & | customProperties () const |
Read all custom properties from layer. | |
Q_INVOKABLE QVariant | customProperty (const QString &value, const QVariant &defaultValue=QVariant()) const |
Read a custom property from layer. | |
Q_INVOKABLE QStringList | customPropertyKeys () const |
Returns list of all keys within custom properties. | |
Q_DECL_DEPRECATED QString | dataUrl () const |
Returns the DataUrl of the layer used by QGIS Server in GetCapabilities request. | |
Q_DECL_DEPRECATED QString | dataUrlFormat () const |
Returns the DataUrl format of the layer used by QGIS Server in GetCapabilities request. | |
virtual bool | deleteStyleFromDatabase (const QString &styleId, QString &msgError) |
Deletes a style from the database. | |
virtual QSet< QgsMapLayerDependency > | dependencies () const |
Gets the list of dependencies. | |
virtual QgsMapLayerElevationProperties * | elevationProperties () |
Returns the layer's elevation properties. | |
virtual QgsError | error () const |
Gets current status error. | |
void | exportNamedMetadata (QDomDocument &doc, QString &errorMsg) const |
Export the current metadata of this layer as named metadata in a QDomDocument. | |
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. | |
virtual void | exportSldStyle (QDomDocument &doc, QString &errorMsg) const |
Export the properties of this layer as SLD style in a QDomDocument. | |
virtual void | exportSldStyleV2 (QDomDocument &doc, QString &errorMsg, const QgsSldExportContext &exportContext) const |
Export the properties of this layer as SLD style in a QDomDocument. | |
virtual QgsRectangle | extent () const |
Returns the extent of the layer. | |
virtual QgsBox3D | extent3D () const |
Returns the 3D extent of the layer. | |
QgsMapLayer::LayerFlags | flags () const |
Returns the flags for this layer. | |
virtual QString | getStyleFromDatabase (const QString &styleId, QString &msgError) |
Returns the named style corresponding to style id provided. | |
Q_DECL_DEPRECATED bool | hasAutoRefreshEnabled () const |
Returns true if auto refresh is enabled for the layer. | |
virtual bool | hasMapTips () const |
Returns true if the layer contains map tips. | |
bool | hasScaleBasedVisibility () const |
Returns whether scale based visibility is enabled for the layer. | |
QString | id () const |
Returns the layer's unique ID, which is used to access this layer from QgsProject. | |
bool | importNamedMetadata (QDomDocument &document, QString &errorMessage) |
Import the metadata of this layer from a QDomDocument. | |
virtual bool | importNamedStyle (QDomDocument &doc, QString &errorMsg, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) |
Import the properties of this layer from a QDomDocument. | |
virtual bool | isEditable () const |
Returns true if the layer can be edited. | |
bool | isInScaleRange (double scale) const |
Tests whether the layer should be visible at the specified scale. | |
virtual bool | isModified () const |
Returns true if the layer has been modified since last commit/save. | |
bool | isRefreshOnNotifyEnabled () const |
Returns true if the refresh on provider nofification is enabled. | |
virtual bool | isSpatial () const |
Returns true if the layer is considered a spatial layer, ie it has some form of geometry associated with it. | |
virtual bool | isTemporary () const |
Returns true if the layer is considered a temporary layer. | |
bool | isValid () const |
Returns the status of the layer. | |
Q_DECL_DEPRECATED QString | keywordList () const |
Returns the keyword list of the layer used by QGIS Server in GetCapabilities request. | |
QgsMapLayerLegend * | legend () const |
Can be nullptr . | |
QString | legendPlaceholderImage () const |
Returns path to the placeholder image or an empty string if a generated legend is shown. | |
QString | legendUrl () const |
Returns the URL for the layer's legend. | |
QString | legendUrlFormat () const |
Returns the format for a URL based layer legend. | |
virtual int | listStylesInDatabase (QStringList &ids, QStringList &names, QStringList &descriptions, QString &msgError) |
Lists all the style in db split into related to the layer and not related to. | |
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) | |
bool | loadNamedMetadataFromDatabase (const QString &db, const QString &uri, QString &qmd) |
Retrieve a named metadata for this layer from a sqlite database. | |
virtual QString | loadNamedStyle (const QString &theURI, bool &resultFlag, bool loadFromLocalDb, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories, Qgis::LoadStyleFlags flags=Qgis::LoadStyleFlags()) |
Loads a named style from file/local db/datasource db. | |
virtual QString | loadNamedStyle (const QString &uri, bool &resultFlag, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories, Qgis::LoadStyleFlags flags=Qgis::LoadStyleFlags()) |
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) | |
virtual bool | loadNamedStyleFromDatabase (const QString &db, const QString &uri, QString &qml) |
Retrieve a named style for this layer from a sqlite database. | |
virtual QString | loadSldStyle (const QString &uri, bool &resultFlag) |
Attempts to style the layer using the formatting from an SLD type file. | |
bool | mapTipsEnabled () const |
Returns true if map tips are enabled for this layer. | |
QString | mapTipTemplate () const |
The mapTip is a pretty, html representation for feature information. | |
double | maximumScale () const |
Returns the maximum map scale (i.e. | |
virtual const QgsLayerMetadata & | metadata () const |
Returns a reference to the layer's metadata store. | |
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) | |
Q_DECL_DEPRECATED QString | metadataUrl () const |
Returns the metadata URL of the layer used by QGIS Server in GetCapabilities request. | |
Q_DECL_DEPRECATED QString | metadataUrlFormat () const |
Returns the metadata format of the layer used by QGIS Server in GetCapabilities request. | |
Q_DECL_DEPRECATED QString | metadataUrlType () const |
Returns the metadata type of the layer used by QGIS Server in GetCapabilities request. | |
double | minimumScale () const |
Returns the minimum map scale (i.e. | |
QString | name () const |
Returns the display name of the layer. | |
virtual double | opacity () const |
Returns the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque). | |
QgsMapLayer & | operator= (const QgsMapLayer &)=delete |
QString | originalXmlProperties () const |
Returns the XML properties of the original layer as they were when the layer was first read from the project file. | |
QgsProviderMetadata * | providerMetadata () const |
Returns the layer data provider's metadata, it may be nullptr . | |
QString | providerType () const |
Returns the provider type (provider key) for this layer. | |
QString | publicSource (bool hidePassword=false) const |
Gets a version of the internal layer definition that has sensitive bits removed (for example, the password). | |
bool | readLayerXml (const QDomElement &layerElement, QgsReadWriteContext &context, QgsMapLayer::ReadFlags flags=QgsMapLayer::ReadFlags(), QgsDataProvider *preloadedProvider=nullptr) |
Sets state from DOM document. | |
bool | readOnly () const |
Returns if this layer is read only. | |
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. | |
QString | refreshOnNotifyMessage () const |
Returns the message that should be notified by the provider to triggerRepaint. | |
virtual Q_INVOKABLE void | reload () |
Synchronises with changes in the datasource. | |
void | removeCustomProperty (const QString &key) |
Remove a custom property from layer. | |
QgsAbstract3DRenderer * | renderer3D () const |
Returns 3D renderer associated with the layer. | |
virtual void | resolveReferences (QgsProject *project) |
Resolve references to other layers (kept as layer IDs after reading XML) into layer objects. | |
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) | |
virtual Q_DECL_DEPRECATED 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) | |
virtual QString | saveDefaultStyle (bool &resultFlag, StyleCategories categories) |
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) | |
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) | |
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) | |
virtual QString | saveSldStyle (const QString &uri, bool &resultFlag) const |
Saves the properties of this layer to an SLD format file. | |
virtual QString | saveSldStyleV2 (bool &resultFlag, const QgsSldExportContext &exportContext) const |
Saves the properties of this layer to an SLD format file. | |
virtual void | saveStyleToDatabase (const QString &name, const QString &description, bool useAsDefault, const QString &uiFileContent, QString &msgError, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) |
Saves named and sld style of the layer to the style table in the db. | |
virtual QgsMapLayerSelectionProperties * | selectionProperties () |
Returns the layer's selection properties. | |
QgsMapLayerServerProperties * | serverProperties () |
Returns QGIS Server Properties for the map layer. | |
const QgsMapLayerServerProperties * | serverProperties () const |
Returns QGIS Server Properties const for the map layer. | |
Q_DECL_DEPRECATED void | setAbstract (const QString &abstract) |
Sets the abstract of the layer used by QGIS Server in GetCapabilities request. | |
Q_DECL_DEPRECATED void | setAttribution (const QString &attrib) |
Sets the attribution of the layerused by QGIS Server in GetCapabilities request. | |
Q_DECL_DEPRECATED void | setAttributionUrl (const QString &attribUrl) |
Sets the attribution URL of the layer used by QGIS Server in GetCapabilities request. | |
Q_DECL_DEPRECATED void | setAutoRefreshEnabled (bool enabled) |
Sets whether auto refresh is enabled for the layer. | |
void | setAutoRefreshInterval (int interval) |
Sets the auto refresh interval (in milliseconds) for the layer. | |
void | setAutoRefreshMode (Qgis::AutoRefreshMode mode) |
Sets the automatic refresh mode for the layer. | |
void | setBlendMode (QPainter::CompositionMode blendMode) |
Set the blending mode used for rendering a layer. | |
void | setCrs (const QgsCoordinateReferenceSystem &srs, bool emitSignal=true) |
Sets layer's spatial reference system. | |
template<class T > | |
void | setCustomEnumProperty (const QString &key, const T &value) |
Set the value of a property based on an enum. | |
template<class T > | |
void | setCustomFlagProperty (const QString &key, const T &value) |
Set the value of a property based on a flag. | |
void | setCustomProperties (const QgsObjectCustomProperties &properties) |
Set custom properties for layer. | |
Q_INVOKABLE void | setCustomProperty (const QString &key, const QVariant &value) |
Set a custom property for layer. | |
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. | |
void | setDataSource (const QString &dataSource, const QString &baseName, const QString &provider, const QgsDataProvider::ProviderOptions &options, Qgis::DataProviderReadFlags flags) |
Updates the data source of the layer. | |
void | setDataSource (const QString &dataSource, const QString &baseName=QString(), const QString &provider=QString(), bool loadDefaultStyleFlag=false) |
Updates the data source of the layer. | |
Q_DECL_DEPRECATED void | setDataUrl (const QString &dataUrl) |
Sets the DataUrl of the layer used by QGIS Server in GetCapabilities request. | |
Q_DECL_DEPRECATED void | setDataUrlFormat (const QString &dataUrlFormat) |
Sets the DataUrl format of the layer used by QGIS Server in GetCapabilities request. | |
void | setFlags (QgsMapLayer::LayerFlags flags) |
Returns the flags for this layer. | |
bool | setId (const QString &id) |
Sets the layer's id. | |
Q_DECL_DEPRECATED void | setKeywordList (const QString &keywords) |
Sets the keyword list of the layerused by QGIS Server in GetCapabilities request. | |
virtual void | setLayerOrder (const QStringList &layers) |
Reorders the previously selected sublayers of this layer from bottom to top. | |
void | setLegend (QgsMapLayerLegend *legend) |
Assign a legend controller to the map layer. | |
void | setLegendPlaceholderImage (const QString &imgPath) |
Set placeholder image for legend. | |
void | setLegendUrl (const QString &legendUrl) |
Sets the URL for the layer's legend. | |
void | setLegendUrlFormat (const QString &legendUrlFormat) |
Sets the format for a URL based layer legend. | |
void | setMapTipsEnabled (bool enabled) |
Enable or disable map tips for this layer. | |
void | setMapTipTemplate (const QString &mapTipTemplate) |
The mapTip is a pretty, html representation for feature information. | |
virtual void | setMetadata (const QgsLayerMetadata &metadata) |
Sets the layer's metadata store. | |
Q_DECL_DEPRECATED void | setMetadataUrl (const QString &metaUrl) |
Sets the metadata URL of the layer used by QGIS Server in GetCapabilities request. | |
Q_DECL_DEPRECATED void | setMetadataUrlFormat (const QString &metaUrlFormat) |
Sets the metadata format of the layer used by QGIS Server in GetCapabilities request. | |
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. | |
void | setName (const QString &name) |
Set the display name of the layer. | |
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). | |
void | setOriginalXmlProperties (const QString &originalXmlProperties) |
Sets the original XML properties for the layer to originalXmlProperties. | |
void | setRenderer3D (QgsAbstract3DRenderer *renderer) |
Sets 3D renderer for the layer. | |
Q_DECL_DEPRECATED void | setShortName (const QString &shortName) |
Sets the short name of the layer used by QGIS Server to identify the layer. | |
virtual void | setSubLayerVisibility (const QString &name, bool visible) |
Set the visibility of the given sublayer name. | |
Q_DECL_DEPRECATED void | setTitle (const QString &title) |
Sets the title of the layer used by QGIS Server in GetCapabilities request. | |
bool | setVerticalCrs (const QgsCoordinateReferenceSystem &crs, QString *errorMessage=nullptr) |
Sets the layer's vertical coordinate reference system. | |
Q_DECL_DEPRECATED QString | shortName () const |
Returns the short name of the layer used by QGIS Server to identify the layer. | |
QString | source () const |
Returns the source for the layer. | |
QgsMapLayerStyleManager * | styleManager () const |
Gets access to the layer's style manager. | |
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) | |
virtual QStringList | subLayers () const |
Returns the sublayers of this layer. | |
virtual bool | supportsEditing () const |
Returns whether the layer supports editing or not. | |
virtual QgsMapLayerTemporalProperties * | temporalProperties () |
Returns the layer's temporal properties. | |
virtual QDateTime | timestamp () const |
Time stamp of data source in the moment when data/metadata were loaded by provider. | |
Q_DECL_DEPRECATED QString | title () const |
Returns the title of the layer used by QGIS Server in GetCapabilities request. | |
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. | |
Qgis::LayerType | type () const |
Returns the type of the layer. | |
QUndoStack * | undoStack () |
Returns pointer to layer's undo stack. | |
QUndoStack * | undoStackStyles () |
Returns pointer to layer's style undo stack. | |
QgsCoordinateReferenceSystem | verticalCrs () const |
Returns the layer's vertical coordinate reference system. | |
QgsRectangle | wgs84Extent (bool forceRecalculate=false) const |
Returns the WGS84 extent (EPSG:4326) of the layer according to ReadFlag::FlagTrustLayerMetadata. | |
bool | writeLayerXml (QDomElement &layerElement, QDomDocument &document, const QgsReadWriteContext &context) const |
Stores state in DOM node. | |
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. | |
Additional Inherited Members | |
Public Types inherited from QgsMapLayer | |
enum | LayerFlag { Identifiable = 1 << 0 , Removable = 1 << 1 , Searchable = 1 << 2 , Private = 1 << 3 } |
Flags for the map layer. More... | |
typedef QFlags< LayerFlag > | LayerFlags |
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 , FlagForceReadOnly = 1 << 3 } |
Flags which control project read behavior. More... | |
typedef QFlags< ReadFlag > | ReadFlags |
typedef QFlags< StyleCategory > | StyleCategories |
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... | |
Static Public Member Functions inherited from QgsMapLayer | |
static QString | extensionPropertyType (PropertyType type) |
Returns the extension of a Property. | |
static QString | formatLayerName (const QString &name) |
A convenience function to capitalize and format a layer name. | |
static QString | generateId (const QString &layerName) |
Generates an unique identifier for this layer, the generate ID is prefixed by layerName. | |
static Qgis::DataProviderReadFlags | providerReadFlags (const QDomNode &layerNode, QgsMapLayer::ReadFlags layerReadFlags) |
Returns provider read flag deduced from layer read flags layerReadFlags and a dom node layerNode that describes a layer (corresponding to maplayer tag in a DOM document project file read by QgsProject). | |
Protected Member Functions inherited from QgsMapLayer | |
void | appendError (const QgsErrorMessage &error) |
Add error message. | |
void | clone (QgsMapLayer *layer) const |
Copies attributes like name, short name, ... into another layer. | |
QString | crsHtmlMetadata () const |
Returns a HTML fragment containing the layer's CRS metadata, for use in the htmlMetadata() method. | |
QString | customPropertyHtmlMetadata () const |
Returns an HTML fragment containing custom property information, for use in the htmlMetadata() method. | |
QString | generalHtmlMetadata () const |
Returns an HTML fragment containing general metadata information, for use in the htmlMetadata() method. | |
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. | |
void | invalidateWgs84Extent () |
Invalidates the WGS84 extent. | |
void | readCommonStyle (const QDomElement &layerElement, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) |
Read style data common to all layer types. | |
void | readCustomProperties (const QDomNode &layerNode, const QString &keyStartsWith=QString()) |
Read custom properties from project file. | |
void | readStyleManager (const QDomNode &layerNode) |
Read style manager's configuration (if any). To be called by subclasses. | |
void | setError (const QgsError &error) |
Sets error message. | |
virtual void | setExtent (const QgsRectangle &rect) |
Sets the extent. | |
virtual void | setExtent3D (const QgsBox3D &box) |
Sets the extent. | |
void | setProviderType (const QString &providerType) |
Sets the providerType (provider key) | |
void | setValid (bool valid) |
Sets whether layer is valid or not. | |
void | writeCommonStyle (QDomElement &layerElement, QDomDocument &document, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) const |
Write style data common to all layer types. | |
void | writeCustomProperties (QDomNode &layerNode, QDomDocument &doc) const |
Write custom properties to project file. | |
void | writeStyleManager (QDomNode &layerNode, QDomDocument &doc) const |
Write style manager's configuration (if exists). To be called by subclasses. | |
Protected Attributes inherited from QgsMapLayer | |
int | mBlockStyleChangedSignal = 0 |
If non-zero, the styleChanged signal should not be emitted. | |
QString | mDataSource |
Data source description string, varies by layer type. | |
QSet< QgsMapLayerDependency > | mDependencies |
List of layers that may modify this layer on modification. | |
QgsError | mError |
Error. | |
bool | mIsRefreshOnNofifyEnabled = false |
QString | mLayerName |
Name of the layer - used for display. | |
double | mLayerOpacity = 1.0 |
Layer opacity. | |
QString | mLegendUrl |
WMS legend. | |
QString | mLegendUrlFormat |
std::unique_ptr< QgsDataProvider > | mPreloadedProvider |
Optionally used when loading a project, it is released when the layer is effectively created. | |
QString | mProviderKey |
Data provider key (name of the data provider) | |
QgsMapLayer::ReadFlags | mReadFlags = QgsMapLayer::ReadFlags() |
Read flags. It's up to the subclass to respect these when restoring state from XML. | |
QString | mRefreshOnNofifyMessage |
bool | mShouldValidateCrs = true |
true if the layer's CRS should be validated and invalid CRSes are not permitted. | |
bool | mValid = false |
Indicates if the layer is valid and can be drawn. | |
Properties inherited from QgsMapLayer | |
int | autoRefreshInterval |
QgsCoordinateReferenceSystem | crs |
QgsCoordinateReferenceSystem | crs3D |
QString | id |
bool | isValid |
bool | mapTipsEnabled |
QString | mapTipTemplate |
QgsLayerMetadata | metadata |
QString | name |
double | opacity |
Qgis::LayerType | type |
QgsCoordinateReferenceSystem | verticalCrs |
Implements a map layer that is dedicated to rendering of vector tiles.
Vector tiles compared to "ordinary" vector layers are pre-processed data optimized for fast rendering. A dataset is provided with a series of zoom levels for different map scales. Each zoom level has a matrix of tiles that contain actual data. A single vector tile may be a a file stored on a local drive, requested over HTTP request or retrieved from a database.
Content of a vector tile is divided into one or more named sub-layers. Each such sub-layer may contain many features which consist of geometry and attributes. Contrary to traditional vector layers, these sub-layers do not need to have a rigid schema where geometry type and attributes are the same for all features. A single sub-layer may have multiple geometry types in a single tile or have some attributes defined only at particular zoom levels.
Vector tile layer currently does not use the concept of data providers that other layer types use. The process of rendering of vector tiles looks like this:
+-----—+ +---—+ +------—+ | DATA | | RAW | | DECODED | | | --> LOADER --> | | --> DECODER --> | | --> RENDERER | SOURCE | | TILE | | TILE | +-----—+ +---—+ +------—+
Data source is a place from where tiles are fetched from (URL for HTTP access, local files, MBTiles file, GeoPackage file or others. Loader (QgsVectorTileLoader) class takes care of loading data from the data source. The "raw tile" data is just a blob (QByteArray) that is encoded in some way. There are multiple ways how vector tiles are encoded just like there are different formats how to store images. For example, tiles can be encoded using Mapbox Vector Tiles (MVT) format or in GeoJSON. Decoder (QgsVectorTileDecoder) takes care of decoding raw tile data into QgsFeature objects. A decoded tile is essentially an array of vector features for each sub-layer found in the tile - this is what vector tile renderer (QgsVectorTileRenderer) expects and does the map rendering.
To construct a vector tile layer, it is best to use QgsDataSourceUri class and set the following parameters to get a valid encoded URI:
Currently supported data source types:
Currently supported decoders:
Definition at line 87 of file qgsvectortilelayer.h.
|
explicit |
Constructs a new vector tile layer.
Definition at line 43 of file qgsvectortilelayer.cpp.
|
overridedefault |
|
overridevirtual |
Returns a new instance equivalent to this one except for the id which is still unique.
Implements QgsMapLayer.
Definition at line 122 of file qgsvectortilelayer.cpp.
|
overridevirtual |
Returns new instance of QgsMapLayerRenderer that will be used for rendering of given context.
Implements QgsMapLayer.
Definition at line 147 of file qgsvectortilelayer.cpp.
|
overridevirtual |
Returns the layer's data provider in a const-correct manner, it may be nullptr
.
Reimplemented from QgsMapLayer.
Definition at line 140 of file qgsvectortilelayer.cpp.
|
overridevirtual |
Returns the layer's data provider, it may be nullptr
.
Reimplemented from QgsMapLayer.
Definition at line 133 of file qgsvectortilelayer.cpp.
|
virtual |
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 from QgsMapLayer.
Definition at line 512 of file qgsvectortilelayer.cpp.
|
virtual |
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 from QgsMapLayer.
Definition at line 505 of file qgsvectortilelayer.cpp.
QgsVectorTileRawData QgsVectorTileLayer::getRawTile | ( | QgsTileXYZ | tileID | ) |
Fetches raw tile data for the give tile coordinates.
If failed to fetch tile data, it will return an empty byte array.
Definition at line 590 of file qgsvectortilelayer.cpp.
|
overridevirtual |
Obtain a formatted HTML string containing assorted metadata for this layer.
Reimplemented from QgsMapLayer.
Definition at line 519 of file qgsvectortilelayer.cpp.
|
inline |
Returns whether to render also borders of tiles (useful for debugging)
Definition at line 244 of file qgsvectortilelayer.h.
QgsVectorTileLabeling * QgsVectorTileLayer::labeling | ( | ) | const |
Returns currently assigned labeling.
Definition at line 624 of file qgsvectortilelayer.cpp.
bool QgsVectorTileLayer::labelsEnabled | ( | ) | const |
Returns whether the layer contains labels which are enabled and should be drawn.
true
if layer contains enabled labelsDefinition at line 631 of file qgsvectortilelayer.cpp.
|
overridevirtual |
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 from QgsMapLayer.
Definition at line 485 of file qgsvectortilelayer.cpp.
|
overridevirtual |
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 from QgsMapLayer.
Definition at line 350 of file qgsvectortilelayer.cpp.
bool QgsVectorTileLayer::loadDefaultStyle | ( | QString & | error, |
QStringList & | warnings | ||
) |
Loads the default style for the layer, and returns true
if the style was successfully loaded.
The error string will be filled with a translated error message if an error occurs during the style load. The warnings list will be populated with any warning messages generated during the style load (e.g. default style properties which could not be converted).
Definition at line 378 of file qgsvectortilelayer.cpp.
bool QgsVectorTileLayer::loadDefaultStyleAndSubLayers | ( | QString & | error, |
QStringList & | warnings, | ||
QList< QgsMapLayer * > & | subLayers | ||
) |
Loads the default style for the layer, and returns true
if the style was successfully loaded.
Also loads any sub layers (such as raster terrain layers) associated with the layer's default style.
The error string will be filled with a translated error message if an error occurs during the style load. The warnings list will be populated with any warning messages generated during the style load (e.g. default style properties which could not be converted).
Ownership of the subLayers is transferrred to the caller.
Definition at line 385 of file qgsvectortilelayer.cpp.
|
overridevirtual |
Returns the map layer properties of this layer.
Reimplemented from QgsMapLayer.
Definition at line 360 of file qgsvectortilelayer.cpp.
|
overridevirtual |
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. Implements QgsMapLayer.
Definition at line 205 of file qgsvectortilelayer.cpp.
|
overridevirtual |
Called by readLayerXML(), used by children to read state specific to them from project files.
Reimplemented from QgsMapLayer.
Definition at line 154 of file qgsvectortilelayer.cpp.
|
slot |
Clear selection.
Definition at line 1001 of file qgsvectortilelayer.cpp.
QgsVectorTileRenderer * QgsVectorTileLayer::renderer | ( | ) | const |
Returns currently assigned renderer.
Definition at line 609 of file qgsvectortilelayer.cpp.
void QgsVectorTileLayer::selectByGeometry | ( | const QgsGeometry & | geometry, |
const QgsSelectionContext & | context, | ||
Qgis::SelectBehavior | behavior = Qgis::SelectBehavior::SetSelection , |
||
Qgis::SelectGeometryRelationship | relationship = Qgis::SelectGeometryRelationship::Intersect , |
||
Qgis::SelectionFlags | flags = Qgis::SelectionFlags() , |
||
QgsRenderContext * | renderContext = nullptr |
||
) |
Selects features found within the search geometry (in layer's coordinates).
A render context can optionally be specified in order to avoid selecting features which are not currently rendered.
Definition at line 665 of file qgsvectortilelayer.cpp.
int QgsVectorTileLayer::selectedFeatureCount | ( | ) | const |
Returns the number of features that are selected in this layer.
Definition at line 658 of file qgsvectortilelayer.cpp.
QList< QgsFeature > QgsVectorTileLayer::selectedFeatures | ( | ) | const |
Returns the list of features currently selected in the layer.
Definition at line 646 of file qgsvectortilelayer.cpp.
|
signal |
Emitted whenever the selected features in the layer are changed.
void QgsVectorTileLayer::setLabeling | ( | QgsVectorTileLabeling * | labeling | ) |
Sets labeling for the map layer.
Definition at line 616 of file qgsvectortilelayer.cpp.
void QgsVectorTileLayer::setLabelsEnabled | ( | bool | enabled | ) |
Sets whether labels should be enabled for the layer.
true
and a labeling object is returned by labeling().Definition at line 639 of file qgsvectortilelayer.cpp.
void QgsVectorTileLayer::setRenderer | ( | QgsVectorTileRenderer * | r | ) |
Sets renderer for the map layer.
Definition at line 601 of file qgsvectortilelayer.cpp.
|
inline |
Sets whether to render also borders of tiles (useful for debugging)
Definition at line 242 of file qgsvectortilelayer.h.
|
overridevirtual |
Sets the coordinate transform context to transformContext.
Implements QgsMapLayer.
Definition at line 339 of file qgsvectortilelayer.cpp.
|
inline |
Returns maximum zoom level at which source has any valid tiles (negative = unconstrained)
Definition at line 193 of file qgsvectortilelayer.h.
|
inline |
Returns minimum zoom level at which source has any valid tiles (negative = unconstrained)
Definition at line 191 of file qgsvectortilelayer.h.
QString QgsVectorTileLayer::sourcePath | ( | ) | const |
Returns URL/path of the data source (syntax different to each data source type)
Definition at line 582 of file qgsvectortilelayer.cpp.
|
inline |
Returns type of the data source.
Definition at line 186 of file qgsvectortilelayer.h.
|
inline |
Returns the vector tile matrix set.
Definition at line 183 of file qgsvectortilelayer.h.
|
overridevirtual |
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. Implements QgsMapLayer.
Definition at line 289 of file qgsvectortilelayer.cpp.
|
overridevirtual |
Called by writeLayerXML(), used by children to write state specific to them to project files.
Reimplemented from QgsMapLayer.
Definition at line 178 of file qgsvectortilelayer.cpp.