Class allowing to manage the auxiliary storage for a vector layer. More...
#include <qgsauxiliarystorage.h>
Inheritance diagram for QgsAuxiliaryLayer:
Public Member Functions | |
| QgsAuxiliaryLayer (const QgsAuxiliaryLayer &rhs)=delete | |
| Copy constructor deactivated. More... | |
| QgsAuxiliaryLayer (const QString &pkField, const QString &filename, const QString &table, QgsVectorLayer *vlayer) | |
| Constructor. More... | |
| bool | addAuxiliaryField (const QgsPropertyDefinition &definition) |
| Adds an auxiliary field for the given property. More... | |
| QgsFields | auxiliaryFields () const |
| Returns a list of all auxiliary fields currently managed by the layer. More... | |
| bool | clear () |
| Deletes all features from the layer. More... | |
| QgsAuxiliaryLayer * | clone (QgsVectorLayer *layer) const |
| Returns a new instance equivalent to this one. More... | |
| bool | deleteAttribute (int attr) override |
| Removes attribute from the layer and commits changes. More... | |
| bool | exists (const QgsPropertyDefinition &definition) const |
Returns true if the property is stored in the layer already, false otherwise. More... | |
| int | indexOfPropertyDefinition (const QgsPropertyDefinition &definition) const |
| Returns the index of the auxiliary field for a specific property definition. More... | |
| bool | isHiddenProperty (int index) const |
Returns true if the underlying field has to be hidden from editing tools like attribute table, false otherwise. More... | |
| QgsVectorLayerJoinInfo | joinInfo () const |
| Returns information to use for joining with primary key and so on. More... | |
| QgsAuxiliaryLayer & | operator= (QgsAuxiliaryLayer const &rhs)=delete |
| QgsPropertyDefinition | propertyDefinitionFromIndex (int index) const |
| Returns the property definition for the underlying field index. More... | |
| int | propertyFromIndex (int index) const |
| Returns the underlying property key for the field index. More... | |
| bool | save () |
| Commits changes and starts editing then. More... | |
| QgsVectorLayer * | toSpatialLayer () const |
| An auxiliary layer is not spatial. More... | |
 Public Member Functions inherited from QgsVectorLayer | |
| QgsVectorLayer (const QgsVectorLayer &rhs)=delete | |
| QgsVectorLayer cannot be copied. More... | |
| QgsVectorLayer (const QString &path=QString(), const QString &baseName=QString(), const QString &providerLib="ogr", const QgsVectorLayer::LayerOptions &options=QgsVectorLayer::LayerOptions()) | |
| Constructor - creates a vector layer. More... | |
| ~QgsVectorLayer () override | |
| QgsActionManager * | actions () |
| Returns all layer actions defined on this layer. More... | |
| const QgsActionManager * | actions () const |
| Returns all layer actions defined on this layer. More... | |
| bool | addAttribute (const QgsField &field) |
Add an attribute field (but does not commit it) returns true if the field was added. More... | |
| int | addExpressionField (const QString &exp, const QgsField &fld) |
| Add a new field which is calculated by the expression specified. More... | |
| bool | addFeature (QgsFeature &feature, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) FINAL |
| Adds a single feature to the sink. More... | |
| void | addFeatureRendererGenerator (QgsFeatureRendererGenerator *generator) |
| Adds a new feature renderer generator to the layer. More... | |
| bool | addFeatures (QgsFeatureList &features, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) FINAL |
| Adds a list of features to the sink. More... | |
| bool | addJoin (const QgsVectorLayerJoinInfo &joinInfo) |
| Joins another vector layer to this layer. More... | |
| Q_INVOKABLE Qgis::GeometryOperationResult | addPart (const QgsPointSequence &ring) |
| Adds a new part polygon to a multipart feature. More... | |
| Q_DECL_DEPRECATED Qgis::GeometryOperationResult | addPart (const QList< QgsPointXY > &ring) |
| Adds a new part polygon to a multipart feature. More... | |
| Q_INVOKABLE Qgis::GeometryOperationResult | addPart (QgsCurve *ring) |
| Q_INVOKABLE Qgis::GeometryOperationResult | addRing (const QgsPointSequence &ring, QgsFeatureId *featureId=nullptr) |
| Adds a ring to polygon/multipolygon features. More... | |
| Q_DECL_DEPRECATED Qgis::GeometryOperationResult | addRing (const QVector< QgsPointXY > &ring, QgsFeatureId *featureId=nullptr) |
| Adds a ring to polygon/multipolygon features. More... | |
| Q_INVOKABLE Qgis::GeometryOperationResult | addRing (QgsCurve *ring, QgsFeatureId *featureId=nullptr) |
| Adds a ring to polygon/multipolygon features (takes ownership) More... | |
| int | addTopologicalPoints (const QgsGeometry &geom) |
| Adds topological points for every vertex of the geometry. More... | |
| int | addTopologicalPoints (const QgsPoint &p) |
| Adds a vertex to segments which intersect point p but don't already have a vertex there. More... | |
| int | addTopologicalPoints (const QgsPointSequence &ps) |
| Adds a vertex to segments which intersect any of the points p but don't already have a vertex there. More... | |
| Q_DECL_DEPRECATED int | addTopologicalPoints (const QgsPointXY &p) |
| Adds a vertex to segments which intersect point p but don't already have a vertex there. More... | |
| QVariant | aggregate (QgsAggregateCalculator::Aggregate aggregate, const QString &fieldOrExpression, const QgsAggregateCalculator::AggregateParameters ¶meters=QgsAggregateCalculator::AggregateParameters(), QgsExpressionContext *context=nullptr, bool *ok=nullptr, QgsFeatureIds *fids=nullptr, QgsFeedback *feedback=nullptr, QString *error=nullptr) const |
| Calculates an aggregated value from the layer's features. More... | |
| bool | allowCommit () const |
| Controls, if the layer is allowed to commit changes. More... | |
| QString | attributeAlias (int index) const |
| Returns the alias of an attribute name or a null string if there is no alias. More... | |
| QgsStringMap | attributeAliases () const |
| Returns a map of field name to attribute alias. More... | |
| QString | attributeDisplayName (int index) const |
| Convenience function that returns the attribute alias if defined or the field name else. More... | |
| QgsAttributeList | attributeList () const |
| Returns list of attribute indexes. More... | |
| QgsAttributeTableConfig | attributeTableConfig () const |
| Returns the attribute table configuration object. More... | |
| QgsAuxiliaryLayer * | auxiliaryLayer () |
| Returns the current auxiliary layer. More... | |
| const QgsAuxiliaryLayer * | auxiliaryLayer () const |
| Returns the current const auxiliary layer. More... | |
| void | beginEditCommand (const QString &text) |
| Create edit command for undo/redo operations. More... | |
| Q_INVOKABLE QgsRectangle | boundingBoxOfSelected () const |
| Returns the bounding box of the selected features. If there is no selection, QgsRectangle(0,0,0,0) is returned. More... | |
| QString | capabilitiesString () const |
| Capabilities for this layer, comma separated and translated. More... | |
| bool | changeAttributeValue (QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue=QVariant(), bool skipDefaultValues=false) |
| Changes an attribute value for a feature (but does not immediately commit the changes). More... | |
| bool | changeAttributeValues (QgsFeatureId fid, const QgsAttributeMap &newValues, const QgsAttributeMap &oldValues=QgsAttributeMap(), bool skipDefaultValues=false) |
| Changes attributes' values for a feature (but does not immediately commit the changes). More... | |
| bool | changeGeometry (QgsFeatureId fid, QgsGeometry &geometry, bool skipDefaultValue=false) |
| Changes a feature's geometry within the layer's edit buffer (but does not immediately commit the changes). More... | |
| QgsVectorLayer * | clone () const override |
| Returns a new instance equivalent to this one. More... | |
| Q_INVOKABLE bool | commitChanges (bool stopEditing=true) |
| Attempts to commit to the underlying data provider any buffered changes made since the last to call to startEditing(). More... | |
| QStringList | commitErrors () const |
| Returns a list containing any error messages generated when attempting to commit changes to the layer. More... | |
| QgsConditionalLayerStyles * | conditionalStyles () const |
| Returns the conditional styles that are set for this layer. More... | |
| QString | constraintDescription (int index) const |
| Returns the descriptive name for the constraint expression for a specified field index. More... | |
| QString | constraintExpression (int index) const |
| Returns the constraint expression for for a specified field index, if set. More... | |
| QgsVectorLayerFeatureCounter * | countSymbolFeatures (bool storeSymbolFids=false) |
| Count features for symbols. More... | |
| QgsExpressionContext | createExpressionContext () const FINAL |
| This method needs to be reimplemented in all classes which implement this interface and return an expression context. More... | |
| QgsExpressionContextScope * | createExpressionContextScope () const FINAL |
| This method needs to be reimplemented in all classes which implement this interface and return an expression context scope. More... | |
| QgsMapLayerRenderer * | createMapRenderer (QgsRenderContext &rendererContext) FINAL |
| Returns new instance of QgsMapLayerRenderer that will be used for rendering of given context. More... | |
| QgsAbstractProfileGenerator * | createProfileGenerator (const QgsProfileRequest &request) override |
| Given a profile request, returns a new profile generator ready for generating elevation profiles. More... | |
| QString | dataComment () const |
| Returns a description for this layer as defined in the data provider. More... | |
| const QgsVectorDataProvider * | dataProvider () const FINAL |
Returns the layer's data provider in a const-correct manner, it may be nullptr. More... | |
| QgsVectorDataProvider * | dataProvider () FINAL |
Returns the layer's data provider, it may be nullptr. More... | |
| 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. More... | |
| QVariant | defaultValue (int index, const QgsFeature &feature=QgsFeature(), QgsExpressionContext *context=nullptr) const |
| Returns the calculated default value for the specified field index. More... | |
| QgsDefaultValue | defaultValueDefinition (int index) const |
| Returns the definition of the expression used when calculating the default value for a field. More... | |
| virtual bool | deleteAttribute (int attr) |
| Deletes an attribute field (but does not commit it). More... | |
| bool | deleteAttributes (const QList< int > &attrs) |
| Deletes a list of attribute fields (but does not commit it) More... | |
| bool | deleteFeature (QgsFeatureId fid, DeleteContext *context=nullptr) |
| Deletes a feature from the layer (but does not commit it). More... | |
| bool | deleteFeatures (const QgsFeatureIds &fids, DeleteContext *context=nullptr) |
| Deletes a set of features from the layer (but does not commit it) More... | |
| Q_INVOKABLE bool | deleteSelectedFeatures (int *deletedCount=nullptr, QgsVectorLayer::DeleteContext *context=nullptr) |
| Deletes the selected features. More... | |
| virtual bool | deleteStyleFromDatabase (const QString &styleId, QString &msgError) |
| Deletes a style from the database. More... | |
| Qgis::VectorEditResult | deleteVertex (QgsFeatureId featureId, int vertex) |
| Deletes a vertex from a feature. More... | |
| QSet< QgsMapLayerDependency > | dependencies () const FINAL |
| Gets the list of dependencies. More... | |
| void | destroyEditCommand () |
| Destroy active command and reverts all changes in it. More... | |
| const QgsDiagramLayerSettings * | diagramLayerSettings () const |
| const QgsDiagramRenderer * | diagramRenderer () const |
| bool | diagramsEnabled () const |
| Returns whether the layer contains diagrams which are enabled and should be drawn. More... | |
| QString | displayExpression () const |
| Returns the preview expression, used to create a human readable preview string. More... | |
| QString | displayField () const |
| This is a shorthand for accessing the displayExpression if it is a simple field. More... | |
| Q_INVOKABLE QgsVectorLayerEditBuffer * | editBuffer () |
| Buffer with uncommitted editing operations. Only valid after editing has been turned on. More... | |
| const QgsVectorLayerEditBuffer * | editBuffer () const |
| Buffer with uncommitted editing operations. More... | |
| QgsEditFormConfig | editFormConfig () const |
| Returns the configuration of the form used to represent this vector layer. More... | |
| QgsEditorWidgetSetup | editorWidgetSetup (int index) const |
The editor widget setup defines which QgsFieldFormatter and editor widget will be used for the field at index. More... | |
| QgsMapLayerElevationProperties * | elevationProperties () override |
| Returns the layer's elevation properties. More... | |
| 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. More... | |
| void | endEditCommand () |
| Finish edit command and add it to undo/redo stack. More... | |
| Q_DECL_DEPRECATED QSet< QString > | excludeAttributesWfs () const |
| A set of attributes that are not advertised in WFS requests with QGIS server. More... | |
| Q_DECL_DEPRECATED QSet< QString > | excludeAttributesWms () const |
| A set of attributes that are not advertised in WMS requests with QGIS server. More... | |
| QString | expressionField (int index) const |
| Returns the expression used for a given expression field. More... | |
| QgsRectangle | extent () const FINAL |
| Returns the extent of the layer. More... | |
| QPainter::CompositionMode | featureBlendMode () const |
| Returns the current blending mode for features. More... | |
| long long | featureCount () const FINAL |
| Returns feature count including changes which have not yet been committed If you need only the count of committed features call this method on this layer's provider. More... | |
| long long | featureCount (const QString &legendKey) const |
| Number of features rendered with specified legend key. More... | |
| QList< const QgsFeatureRendererGenerator * > | featureRendererGenerators () const |
| Returns a list of the feature renderer generators owned by the layer. More... | |
| QgsField::ConfigurationFlags | fieldConfigurationFlags (int index) const |
| Returns the configuration flags of the field at given index. More... | |
| QgsFieldConstraints::Constraints | fieldConstraints (int fieldIndex) const |
| Returns any constraints which are present for a specified field index. More... | |
| QMap< QgsFieldConstraints::Constraint, QgsFieldConstraints::ConstraintStrength > | fieldConstraintsAndStrength (int fieldIndex) const |
| Returns a map of constraint with their strength for a specific field of the layer. More... | |
| QgsFields | fields () const FINAL |
| Returns the list of fields of this layer. More... | |
| QgsGeometryOptions * | geometryOptions () const |
| Configuration and logic to apply automatically on any edit happening on this layer. More... | |
| Q_INVOKABLE Qgis::GeometryType | geometryType () const |
| Returns point, line or polygon. More... | |
| QgsFeature | getFeature (QgsFeatureId fid) const |
| Queries the layer for the feature with the given id. More... | |
| QgsFeatureIterator | getFeatures (const QgsFeatureIds &fids) |
| Queries the layer for the features with the given ids. More... | |
| QgsFeatureIterator | getFeatures (const QgsFeatureRequest &request=QgsFeatureRequest()) const FINAL |
| Queries the layer for features specified in request. More... | |
| QgsFeatureIterator | getFeatures (const QgsRectangle &rectangle) |
| Queries the layer for the features which intersect the specified rectangle. More... | |
| QgsFeatureIterator | getFeatures (const QString &expression) |
| Queries the layer for features matching a given expression. More... | |
| QgsGeometry | getGeometry (QgsFeatureId fid) const |
| Queries the layer for the geometry at the given id. More... | |
| QgsFeatureIterator | getSelectedFeatures (QgsFeatureRequest request=QgsFeatureRequest()) const |
| Returns an iterator of the selected features. More... | |
| virtual QString | getStyleFromDatabase (const QString &styleId, QString &msgError) |
| Returns the named style corresponding to style id provided. More... | |
| FeatureAvailability | hasFeatures () const FINAL |
| Determines if this vector layer has features. More... | |
| bool | hasMapTips () const FINAL |
Returns true if the layer contains map tips. More... | |
| QString | htmlMetadata () const FINAL |
| Obtain a formatted HTML string containing assorted metadata for this layer. More... | |
| bool | insertVertex (const QgsPoint &point, QgsFeatureId atFeatureId, int beforeVertex) |
| Inserts a new vertex before the given vertex number, in the given ring, item (first number is index 0), and feature. More... | |
| bool | insertVertex (double x, double y, QgsFeatureId atFeatureId, int beforeVertex) |
| Inserts a new vertex before the given vertex number, in the given ring, item (first number is index 0), and feature. More... | |
| Q_INVOKABLE void | invertSelection () |
| Selects not selected features and deselects selected ones. More... | |
| Q_INVOKABLE void | invertSelectionInRectangle (QgsRectangle &rect) |
| Inverts selection of features found within the search rectangle (in layer's coordinates) More... | |
| bool | isAuxiliaryField (int index, int &srcIndex) const |
Returns true if the field comes from the auxiliary layer, false otherwise. More... | |
| bool | isEditable () const FINAL |
Returns true if the provider is in editing mode. More... | |
| bool | isEditCommandActive () const |
| Tests if an edit command is active. More... | |
| bool | isModified () const override |
Returns true if the provider has been modified since the last commit. More... | |
| bool | isSpatial () const FINAL |
Returns true if this is a geometry layer and false in case of NoGeometry (table only) or UnknownGeometry. More... | |
| bool | isSqlQuery () const |
Returns true if the layer is a query (SQL) layer. More... | |
| QgsVectorLayerJoinBuffer * | joinBuffer () |
| Returns the join buffer object. More... | |
| const QgsVectorLayerJoinBuffer * | joinBuffer () const |
| Returns a const pointer on join buffer object. More... | |
| QgsAbstractVectorLayerLabeling * | labeling () |
| Access to labeling configuration. More... | |
| const QgsAbstractVectorLayerLabeling * | labeling () const |
| Access to const labeling configuration. More... | |
| bool | labelsEnabled () const |
| Returns whether the layer contains labels which are enabled and should be drawn. More... | |
| 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. More... | |
| bool | loadAuxiliaryLayer (const QgsAuxiliaryStorage &storage, const QString &key=QString()) |
| Loads the auxiliary layer for this vector layer. More... | |
| QString | loadDefaultStyle (bool &resultFlag) FINAL |
| 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 | loadNamedStyle (const QString &theURI, bool &resultFlag, bool loadFromLocalDb, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) |
| Loads a named style from file/local db/datasource db. More... | |
| QString | loadNamedStyle (const QString &theURI, bool &resultFlag, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) FINAL |
Calls loadNamedStyle( theURI, resultFlag, false ); Retained for backward compatibility. More... | |
| QVariant | maximumValue (int index) const FINAL |
| Returns the maximum value for an attribute column or an invalid variant in case of error. More... | |
| void | minimumAndMaximumValue (int index, QVariant &minimum, QVariant &maximum) const |
| Calculates both the minimum and maximum value for an attribute column. More... | |
| QVariant | minimumValue (int index) const FINAL |
| Returns the minimum value for an attribute column or an invalid variant in case of error. More... | |
| Q_INVOKABLE void | modifySelection (const QgsFeatureIds &selectIds, const QgsFeatureIds &deselectIds) |
| Modifies the current selection on this layer. More... | |
| bool | moveVertex (const QgsPoint &p, QgsFeatureId atFeatureId, int atVertex) |
| Moves the vertex at the given position number, ring and item (first number is index 0), and feature to the given coordinates. More... | |
| bool | moveVertex (double x, double y, QgsFeatureId atFeatureId, int atVertex) |
| Moves the vertex at the given position number, ring and item (first number is index 0), and feature to the given coordinates. More... | |
| QgsVectorLayer & | operator= (QgsVectorLayer const &rhs)=delete |
| QgsVectorLayer cannot be copied. More... | |
| QgsAttributeList | primaryKeyAttributes () const |
| Returns the list of attributes which make up the layer's primary keys. More... | |
| bool | readExtentFromXml () const |
Returns true if the extent is read from the XML document when data source has no metadata, false if it's the data provider which determines it. More... | |
| bool | readSld (const QDomNode &node, QString &errorMessage) FINAL |
| bool | readStyle (const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) FINAL |
| bool | readSymbology (const QDomNode &layerNode, QString &errorMessage, QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) FINAL |
| bool | readXml (const QDomNode &layer_node, QgsReadWriteContext &context) FINAL |
| Reads vector layer specific state from project file Dom node. More... | |
| QList< QgsRelation > | referencingRelations (int idx) const |
| Returns the layer's relations, where the foreign key is on this layer. More... | |
| void | reload () FINAL |
| Synchronises with changes in the datasource. More... | |
| void | removeExpressionField (int index) |
| Removes an expression field. More... | |
| void | removeFeatureRendererGenerator (const QString &id) |
| Removes the feature renderer with matching id from the layer. More... | |
| void | removeFieldAlias (int index) |
| Removes an alias (a display name) for attributes to display in dialogs. More... | |
| void | removeFieldConstraint (int index, QgsFieldConstraints::Constraint constraint) |
| Removes a constraint for a specified field index. More... | |
| bool | removeJoin (const QString &joinLayerId) |
| Removes a vector layer join. More... | |
| bool | renameAttribute (int index, const QString &newName) |
| Renames an attribute field (but does not commit it). More... | |
| QgsFeatureRenderer * | renderer () |
| Returns the feature renderer used for rendering the features in the layer in 2D map views. More... | |
| const QgsFeatureRenderer * | renderer () const |
| Returns the feature renderer used for rendering the features in the layer in 2D map views. More... | |
| void | resolveReferences (QgsProject *project) FINAL |
| Resolves references to other layers (kept as layer IDs after reading XML) into layer objects. More... | |
| Q_INVOKABLE bool | rollBack (bool deleteBuffer=true) |
| Stops a current editing operation and discards any uncommitted edits. More... | |
| 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. More... | |
| Q_INVOKABLE void | selectAll () |
| Select all the features. More... | |
| Q_INVOKABLE void | selectByExpression (const QString &expression, Qgis::SelectBehavior behavior=Qgis::SelectBehavior::SetSelection, QgsExpressionContext *context=nullptr) |
| Selects matching features using an expression. More... | |
| Q_INVOKABLE void | selectByIds (const QgsFeatureIds &ids, Qgis::SelectBehavior behavior=Qgis::SelectBehavior::SetSelection) |
| Selects matching features using a list of feature IDs. More... | |
| Q_INVOKABLE void | selectByRect (QgsRectangle &rect, Qgis::SelectBehavior behavior=Qgis::SelectBehavior::SetSelection) |
| Selects features found within the search rectangle (in layer's coordinates) More... | |
| int | selectedFeatureCount () const |
| Returns the number of features that are selected in this layer. More... | |
| Q_INVOKABLE const QgsFeatureIds & | selectedFeatureIds () const |
| Returns a list of the selected features IDs in this layer. More... | |
| Q_INVOKABLE QgsFeatureList | selectedFeatures () const |
| Returns a copy of the user-selected features. More... | |
| void | setAllowCommit (bool allowCommit) |
| Controls, if the layer is allowed to commit changes. More... | |
| void | setAttributeTableConfig (const QgsAttributeTableConfig &attributeTableConfig) |
| Sets the attribute table configuration object. More... | |
| void | setAuxiliaryLayer (QgsAuxiliaryLayer *layer=nullptr) |
| Sets the current auxiliary layer. More... | |
| void | setConstraintExpression (int index, const QString &expression, const QString &description=QString()) |
| Sets the constraint expression for the specified field index. More... | |
| void | setCoordinateSystem () |
| Setup the coordinate system transformation for the layer. More... | |
| void | setDefaultValueDefinition (int index, const QgsDefaultValue &definition) |
| Sets the definition of the expression to use when calculating the default value for a field. More... | |
| bool | setDependencies (const QSet< QgsMapLayerDependency > &layers) FINAL |
| Sets the list of dependencies. More... | |
| void | setDiagramLayerSettings (const QgsDiagramLayerSettings &s) |
| void | setDiagramRenderer (QgsDiagramRenderer *r) |
| Sets diagram rendering object (takes ownership) More... | |
| void | setDisplayExpression (const QString &displayExpression) |
| Set the preview expression, used to create a human readable preview string. More... | |
| void | setEditFormConfig (const QgsEditFormConfig &editFormConfig) |
| Sets the editFormConfig (configuration) of the form used to represent this vector layer. More... | |
| void | setEditorWidgetSetup (int index, const QgsEditorWidgetSetup &setup) |
The editor widget setup defines which QgsFieldFormatter and editor widget will be used for the field at index. More... | |
| Q_DECL_DEPRECATED void | setExcludeAttributesWfs (const QSet< QString > &att) |
| A set of attributes that are not advertised in WFS requests with QGIS server. More... | |
| Q_DECL_DEPRECATED void | setExcludeAttributesWms (const QSet< QString > &att) |
| A set of attributes that are not advertised in WMS requests with QGIS server. More... | |
| void | setFeatureBlendMode (QPainter::CompositionMode blendMode) |
| Sets the blending mode used for rendering each feature. More... | |
| void | setFieldAlias (int index, const QString &aliasString) |
| Sets an alias (a display name) for attributes to display in dialogs. More... | |
| void | setFieldConfigurationFlag (int index, QgsField::ConfigurationFlag flag, bool active) |
| Sets the given configuration flag for the field at given index to be active or not. More... | |
| void | setFieldConfigurationFlags (int index, QgsField::ConfigurationFlags flags) |
| Sets the configuration flags of the field at given index. More... | |
| void | setFieldConstraint (int index, QgsFieldConstraints::Constraint constraint, QgsFieldConstraints::ConstraintStrength strength=QgsFieldConstraints::ConstraintStrengthHard) |
| Sets a constraint for a specified field index. More... | |
| void | setFieldSplitPolicy (int index, Qgis::FieldDomainSplitPolicy policy) |
| Sets a split policy for the field with the specified index. More... | |
| void | setLabeling (QgsAbstractVectorLayerLabeling *labeling) |
| Sets labeling configuration. More... | |
| void | setLabelsEnabled (bool enabled) |
| Sets whether labels should be enabled for the layer. More... | |
| void | setProviderEncoding (const QString &encoding) |
| Sets the text encoding of the data provider. More... | |
| void | setReadExtentFromXml (bool readExtentFromXml) |
| Flag allowing to indicate if the extent has to be read from the XML document when data source has no metadata or if the data provider has to determine it. More... | |
| bool | setReadOnly (bool readonly=true) |
| Makes layer read-only (editing disabled) or not. More... | |
| void | setRenderer (QgsFeatureRenderer *r) |
| Sets the feature renderer which will be invoked to represent this layer in 2D map views. More... | |
| void | setSimplifyMethod (const QgsVectorSimplifyMethod &simplifyMethod) |
| Sets the simplification settings for fast rendering of features. More... | |
| virtual bool | setSubsetString (const QString &subset) |
| Sets the string (typically sql) used to define a subset of the layer. More... | |
| void | setWeakRelations (const QList< QgsWeakRelation > &relations) |
| Sets the layer's weak relations. More... | |
| bool | simplifyDrawingCanbeApplied (const QgsRenderContext &renderContext, QgsVectorSimplifyMethod::SimplifyHint simplifyHint) const |
| Returns whether the VectorLayer can apply the specified simplification hint. More... | |
| const QgsVectorSimplifyMethod & | simplifyMethod () const |
| Returns the simplification settings for fast rendering of features. More... | |
| QgsCoordinateReferenceSystem | sourceCrs () const FINAL |
| Returns the coordinate reference system for features in the source. More... | |
| QgsRectangle | sourceExtent () const FINAL |
| Returns the extent of all geometries from the source. More... | |
| QString | sourceName () const FINAL |
| Returns a friendly display name for the source. More... | |
| Q_INVOKABLE Qgis::GeometryOperationResult | splitFeatures (const QgsCurve *curve, QgsPointSequence &topologyTestPoints, bool preserveCircular=false, bool topologicalEditing=false) |
| Splits features cut by the given curve. More... | |
| Q_INVOKABLE Qgis::GeometryOperationResult | splitFeatures (const QgsPointSequence &splitLine, bool topologicalEditing=false) |
| Splits features cut by the given line. More... | |
| Q_DECL_DEPRECATED Qgis::GeometryOperationResult | splitFeatures (const QVector< QgsPointXY > &splitLine, bool topologicalEditing=false) |
| Splits features cut by the given line. More... | |
| Q_INVOKABLE Qgis::GeometryOperationResult | splitParts (const QgsPointSequence &splitLine, bool topologicalEditing=false) |
| Splits parts cut by the given line. More... | |
| Q_DECL_DEPRECATED Qgis::GeometryOperationResult | splitParts (const QVector< QgsPointXY > &splitLine, bool topologicalEditing=false) |
| Splits parts cut by the given line. More... | |
| QString | storageType () const |
| Returns the permanent storage type for this layer as a friendly name. More... | |
| QgsStoredExpressionManager * | storedExpressionManager () |
| Returns the manager of the stored expressions for this layer. More... | |
| virtual QString | subsetString () const |
| Returns the string (typically sql) used to define a subset of the layer. More... | |
| bool | supportsEditing () const override |
| Returns whether the layer supports editing or not. More... | |
| QgsFeatureIds | symbolFeatureIds (const QString &legendKey) const |
| Ids of features rendered with specified legend key. More... | |
| QgsMapLayerTemporalProperties * | temporalProperties () override |
| Returns the layer's temporal properties. More... | |
| Q_INVOKABLE int | translateFeature (QgsFeatureId featureId, double dx, double dy) |
| Translates feature by dx, dy. More... | |
| QStringList | uniqueStringsMatching (int index, const QString &substring, int limit=-1, QgsFeedback *feedback=nullptr) const |
| Returns unique string values of an attribute which contain a specified subset string. More... | |
| QSet< QVariant > | uniqueValues (int fieldIndex, int limit=-1) const FINAL |
| Calculates a list of unique values contained within an attribute in the layer. More... | |
| void | updateExpressionField (int index, const QString &exp) |
| Changes the expression used to define an expression based (virtual) field. More... | |
| bool | updateFeature (QgsFeature &feature, bool skipDefaultValues=false) |
| Updates an existing feature in the layer, replacing the attributes and geometry for the feature with matching QgsFeature::id() with the attributes and geometry from feature. More... | |
| void | updateFields () |
Will regenerate the fields property of this layer by obtaining all fields from the dataProvider, joined fields and virtual fields. More... | |
| const QList< QgsVectorLayerJoinInfo > | vectorJoins () const |
| Qgis::VectorLayerTypeFlags | vectorLayerTypeFlags () const |
| Returns the vector layer type flags. More... | |
| QList< QgsWeakRelation > | weakRelations () const |
| Returns the layer's weak relations as specified in the layer's style. More... | |
| Q_INVOKABLE Qgis::WkbType | wkbType () const FINAL |
| Returns the WKBType or WKBUnknown in case of error. More... | |
| bool | writeSld (QDomNode &node, QDomDocument &doc, QString &errorMessage, const QVariantMap &props=QVariantMap()) const |
| Writes the symbology of the layer into the document provided in SLD 1.1 format. More... | |
| bool | writeStyle (QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) const FINAL |
| bool | writeSymbology (QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) const FINAL |
| bool | writeXml (QDomNode &layer_node, QDomDocument &doc, const QgsReadWriteContext &context) const FINAL |
| Writes vector layer specific state to project file Dom node. More... | |
| Public Member Functions inherited from QgsMapLayer | |
| QgsMapLayer (Qgis::LayerType type=Qgis::LayerType::Vector, const QString &name=QString(), const QString &source=QString()) | |
| Constructor for QgsMapLayer. More... | |
| QgsMapLayer (QgsMapLayer const &)=delete | |
| QgsMapLayer cannot be copied. 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 void | exportSldStyleV2 (QDomDocument &doc, QString &errorMsg, const QgsSldExportContext &exportContext) 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... | |
| virtual bool | hasMapTips () const |
Returns true if the layer contains map tips. 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... | |
| QString | mapTipTemplate () const |
| The mapTip is a pretty, html representation for feature information. 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 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) More... | |
| 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) 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... | |
| virtual QString | saveSldStyleV2 (bool &resultFlag, const QgsSldExportContext &exportContext) 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... | |
| void | setMapTipTemplate (const QString &mapTipTemplate) |
| The mapTip is a pretty, html representation for feature information. 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... | |
| Qgis::LayerType | 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... | |
| Public Member Functions inherited from QgsExpressionContextGenerator | |
| virtual | ~QgsExpressionContextGenerator ()=default |
| virtual QgsExpressionContext | createExpressionContext () const =0 |
| This method needs to be reimplemented in all classes which implement this interface and return an expression context. More... | |
| Public Member Functions inherited from QgsExpressionContextScopeGenerator | |
| virtual | ~QgsExpressionContextScopeGenerator ()=default |
| virtual QgsExpressionContextScope * | createExpressionContextScope () const =0 |
| This method needs to be reimplemented in all classes which implement this interface and return an expression context scope. More... | |
| Public Member Functions inherited from QgsFeatureSink | |
| virtual | ~QgsFeatureSink ()=default |
| virtual bool | addFeature (QgsFeature &feature, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) |
| Adds a single feature to the sink. More... | |
| virtual bool | addFeatures (QgsFeatureIterator &iterator, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) |
| Adds all features from the specified iterator to the sink. More... | |
| virtual bool | addFeatures (QgsFeatureList &features, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags())=0 |
| Adds a list of features to the sink. More... | |
| virtual bool | flushBuffer () |
| Flushes any internal buffer which may exist in the sink, causing any buffered features to be added to the sink's destination. More... | |
| virtual QString | lastError () const |
| Returns the most recent error encountered by the sink, e.g. More... | |
| Public Member Functions inherited from QgsFeatureSource | |
| virtual | ~QgsFeatureSource ()=default |
| virtual QgsFeatureIds | allFeatureIds () const |
| Returns a list of all feature IDs for features present in the source. More... | |
| virtual long long | featureCount () const =0 |
| Returns the number of features contained in the source, or -1 if the feature count is unknown. More... | |
| virtual QgsFields | fields () const =0 |
| Returns the fields associated with features in the source. More... | |
| virtual QgsFeatureIterator | getFeatures (const QgsFeatureRequest &request=QgsFeatureRequest()) const =0 |
| Returns an iterator for the features in the source. More... | |
| virtual FeatureAvailability | hasFeatures () const |
| Determines if there are any features available in the source. More... | |
| virtual SpatialIndexPresence | hasSpatialIndex () const |
| Returns an enum value representing the presence of a valid spatial index on the source, if it can be determined. More... | |
| QgsVectorLayer * | materialize (const QgsFeatureRequest &request, QgsFeedback *feedback=nullptr) |
| Materializes a request (query) made against this feature source, by running it over the source and returning a new memory based vector layer containing the result. More... | |
| virtual QVariant | maximumValue (int fieldIndex) const |
| Returns the maximum value for an attribute column or an invalid variant in case of error. More... | |
| virtual QVariant | minimumValue (int fieldIndex) const |
| Returns the minimum value for an attribute column or an invalid variant in case of error. More... | |
| virtual QgsCoordinateReferenceSystem | sourceCrs () const =0 |
| Returns the coordinate reference system for features in the source. More... | |
| virtual QgsRectangle | sourceExtent () const |
| Returns the extent of all geometries from the source. More... | |
| virtual QString | sourceName () const =0 |
| Returns a friendly display name for the source. More... | |
| virtual QSet< QVariant > | uniqueValues (int fieldIndex, int limit=-1) const |
| Returns the set of unique values contained within the specified fieldIndex from this source. More... | |
| virtual Qgis::WkbType | wkbType () const =0 |
| Returns the geometry type for features returned by this source. More... | |
| Public Member Functions inherited from QgsAbstractProfileSource | |
| virtual | ~QgsAbstractProfileSource () |
| virtual QgsAbstractProfileGenerator * | createProfileGenerator (const QgsProfileRequest &request)=0 |
| Given a profile request, returns a new profile generator ready for generating elevation profiles. More... | |
Static Public Member Functions | |
| static QgsField | createAuxiliaryField (const QgsField &field) |
| Creates a new auxiliary field from a field. More... | |
| static QgsField | createAuxiliaryField (const QgsPropertyDefinition &definition) |
| Creates a new auxiliary field from a property definition. More... | |
| static int | createProperty (QgsCallout::Property property, QgsVectorLayer *vlayer, bool overwriteExisting=true) |
| Creates if necessary a new auxiliary field for a callout's property and activates this property in settings. More... | |
| static int | createProperty (QgsDiagramLayerSettings::Property property, QgsVectorLayer *vlayer, bool overwriteExisting=true) |
| Creates if necessary a new auxiliary field for a diagram's property and activates this property in settings. More... | |
| static int | createProperty (QgsPalLayerSettings::Property property, QgsVectorLayer *vlayer, bool overwriteExisting=true) |
| Creates if necessary a new auxiliary field for a PAL property and activates this property in settings. More... | |
| static QString | nameFromProperty (const QgsPropertyDefinition &def, bool joined=false) |
| Returns the name of the auxiliary field for a property definition. More... | |
| static QgsPropertyDefinition | propertyDefinitionFromField (const QgsField &field) |
| Returns the property definition from an auxiliary field. More... | |
| Static Public Member Functions inherited from QgsVectorLayer | |
| static Q_DECL_DEPRECATED void | drawVertexMarker (double x, double y, QPainter &p, Qgis::VertexMarkerType type, int vertexSize) |
| Draws a vertex symbol at (screen) coordinates x, y. More... | |
| Static Public Member Functions inherited from QgsMapLayer | |
| 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... | |
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... | |
| 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... | |
| 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 Types inherited from QgsFeatureSink | |
| enum | Flag { FastInsert = 1 << 1 , RollBackOnErrors = 1 << 2 } |
| Flags controlling how features are added to a sink. More... | |
| enum | SinkFlag { RegeneratePrimaryKey = 1 << 1 } |
| Flags that can be set on a QgsFeatureSink. More... | |
| Public Types inherited from QgsFeatureSource | |
| enum | FeatureAvailability { NoFeaturesAvailable , FeaturesAvailable , FeaturesMaybeAvailable } |
| Possible return value for hasFeatures() to determine if a source is empty. More... | |
| enum | SpatialIndexPresence { SpatialIndexUnknown = 0 , SpatialIndexNotPresent = 1 , SpatialIndexPresent = 2 } |
| Enumeration of spatial index presence states. More... | |
| Public Slots inherited from QgsVectorLayer | |
| bool | accept (QgsStyleEntityVisitorInterface *visitor) const override |
| Q_INVOKABLE void | deselect (const QgsFeatureIds &featureIds) |
| Deselects features by their ID. More... | |
| void | deselect (QgsFeatureId featureId) |
| Deselects feature by its ID. More... | |
| QgsFeatureSource::SpatialIndexPresence | hasSpatialIndex () const override |
| Q_INVOKABLE void | removeSelection () |
| Clear selection. More... | |
| void | reselect () |
| Reselects the previous set of selected features. More... | |
| Q_INVOKABLE void | select (const QgsFeatureIds &featureIds) |
| Selects features by their ID. More... | |
| void | select (QgsFeatureId featureId) |
| Selects feature by its ID. More... | |
| virtual void | setTransformContext (const QgsCoordinateTransformContext &transformContext) override |
| Sets the coordinate transform context to transformContext. More... | |
| Q_INVOKABLE bool | startEditing () |
| Makes the layer editable. More... | |
| virtual void | updateExtents (bool force=false) |
| Update the extents for the layer. More... | |
| Public Slots inherited from QgsMapLayer | |
| 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 inherited from QgsVectorLayer | |
| void | afterCommitChanges () |
| Emitted after changes are committed to the data provider. More... | |
| void | afterRollBack () |
| Emitted after changes are rolled back. More... | |
| void | allowCommitChanged () |
| Emitted whenever the allowCommitChanged() property of this layer changes. More... | |
| void | attributeAdded (int idx) |
| Will be emitted, when a new attribute has been added to this vector layer. More... | |
| void | attributeDeleted (int idx) |
| Will be emitted, when an attribute has been deleted from this vector layer. More... | |
| void | attributeValueChanged (QgsFeatureId fid, int idx, const QVariant &value) |
| Emitted whenever an attribute value change is done in the edit buffer. More... | |
| void | beforeAddingExpressionField (const QString &fieldName) |
| Will be emitted, when an expression field is going to be added to this vector layer. More... | |
| void | beforeCommitChanges (bool stopEditing) |
| Emitted before changes are committed to the data provider. More... | |
| void | beforeEditingStarted () |
| Emitted before editing on this layer is started. More... | |
| void | beforeModifiedCheck () const |
| Emitted when the layer is checked for modifications. Use for last-minute additions. More... | |
| void | beforeRemovingExpressionField (int idx) |
| Will be emitted, when an expression field is going to be deleted from this vector layer. More... | |
| void | beforeRollBack () |
| Emitted before changes are rolled back. More... | |
| void | committedAttributesAdded (const QString &layerId, const QList< QgsField > &addedAttributes) |
| Emitted when attributes are added to the provider if not in transaction mode. More... | |
| void | committedAttributesDeleted (const QString &layerId, const QgsAttributeList &deletedAttributes) |
| Emitted when attributes are deleted from the provider if not in transaction mode. More... | |
| void | committedAttributeValuesChanges (const QString &layerId, const QgsChangedAttributesMap &changedAttributesValues) |
| Emitted when attribute value changes are saved to the provider if not in transaction mode. More... | |
| void | committedFeaturesAdded (const QString &layerId, const QgsFeatureList &addedFeatures) |
| Emitted when features are added to the provider if not in transaction mode. More... | |
| void | committedFeaturesRemoved (const QString &layerId, const QgsFeatureIds &deletedFeatureIds) |
| Emitted when features are deleted from the provider if not in transaction mode. More... | |
| void | committedGeometriesChanges (const QString &layerId, const QgsGeometryMap &changedGeometries) |
| Emitted when geometry changes are saved to the provider if not in transaction mode. More... | |
| void | displayExpressionChanged () |
| Emitted when the display expression changes. More... | |
| void | editCommandDestroyed () |
| Signal emitted, when an edit command is destroyed. More... | |
| void | editCommandEnded () |
| Signal emitted, when an edit command successfully ended. More... | |
| void | editCommandStarted (const QString &text) |
| Signal emitted when a new edit command has been started. More... | |
| void | editFormConfigChanged () |
| Will be emitted whenever the edit form configuration of this layer changes. More... | |
| void | featureAdded (QgsFeatureId fid) |
| Emitted when a new feature has been added to the layer. More... | |
| void | featureBlendModeChanged (QPainter::CompositionMode blendMode) |
| Signal emitted when setFeatureBlendMode() is called. More... | |
| void | featureDeleted (QgsFeatureId fid) |
| Emitted when a feature has been deleted. More... | |
| void | featuresDeleted (const QgsFeatureIds &fids) |
| Emitted when features have been deleted. More... | |
| void | geometryChanged (QgsFeatureId fid, const QgsGeometry &geometry) |
| Emitted whenever a geometry change is done in the edit buffer. More... | |
| void | labelingFontNotFound (QgsVectorLayer *layer, const QString &fontfamily) |
| Emitted when the font family defined for labeling layer is not found on system. More... | |
| void | raiseError (const QString &msg) |
| Signals an error related to this vector layer. More... | |
| void | readCustomSymbology (const QDomElement &element, QString &errorMessage) |
| Signal emitted whenever the symbology (QML-file) for this layer is being read. More... | |
| void | readOnlyChanged () |
| Emitted when the read only state of this layer is changed. More... | |
| void | selectionChanged (const QgsFeatureIds &selected, const QgsFeatureIds &deselected, bool clearAndSelect) |
| Emitted when selection was changed. More... | |
| void | subsetStringChanged () |
| Emitted when the layer's subset string has changed. More... | |
| void | supportsEditingChanged () |
| Emitted when the read only state or the data provider of this layer is changed. More... | |
| void | symbolFeatureCountMapChanged () |
| Emitted when the feature count for symbols on this layer has been recalculated. More... | |
| void | updatedFields () |
| Emitted whenever the fields available from this layer have been changed. More... | |
| void | writeCustomSymbology (QDomElement &element, QDomDocument &doc, QString &errorMessage) const |
| Signal emitted whenever the symbology (QML-file) for this layer is being written. More... | |
| Signals inherited from QgsMapLayer | |
| 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 | mapTipTemplateChanged () |
| Emitted when the map tip template changes. 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... | |
| Static Public Attributes inherited from QgsVectorLayer | |
| static const QgsSettingsEntryEnumFlag< QgsVectorSimplifyMethod::SimplifyAlgorithm > * | settingsSimplifyAlgorithm = new QgsSettingsEntryEnumFlag<QgsVectorSimplifyMethod::SimplifyAlgorithm>( QStringLiteral( "simplifyAlgorithm" ), QgsSettingsTree::sTreeQgis, QgsVectorSimplifyMethod::SimplifyAlgorithm::Distance ) |
| static const QgsSettingsEntryEnumFlag< QgsVectorSimplifyMethod::SimplifyHints > * | settingsSimplifyDrawingHints = new QgsSettingsEntryEnumFlag<QgsVectorSimplifyMethod::SimplifyHints>( QStringLiteral( "simplifyDrawingHints" ), QgsSettingsTree::sTreeQgis, QgsVectorSimplifyMethod::SimplifyHint::NoSimplification ) |
| static const QgsSettingsEntryDouble * | settingsSimplifyDrawingTol = new QgsSettingsEntryDouble( QStringLiteral( "simplifyDrawingTol" ), QgsSettingsTree::sTreeQgis, Qgis::DEFAULT_MAPTOPIXEL_THRESHOLD ) |
| static const QgsSettingsEntryBool * | settingsSimplifyLocal = new QgsSettingsEntryBool( QStringLiteral( "simplifyLocal" ), QgsSettingsTree::sTreeQgis, true ) |
| static const QgsSettingsEntryDouble * | settingsSimplifyMaxScale = new QgsSettingsEntryDouble( QStringLiteral( "simplifyMaxScale" ), QgsSettingsTree::sTreeQgis, 1.0 ) |
| Protected Member Functions inherited from QgsVectorLayer | |
| void | setExtent (const QgsRectangle &rect) FINAL |
| Sets the extent. More... | |
| Protected Member Functions inherited from QgsMapLayer | |
| void | appendError (const QgsErrorMessage &error) |
| Add error message. More... | |
| void | clone (QgsMapLayer *layer) const |
| Copies attributes like name, short name, ... into another layer. 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 inherited from QgsMapLayer | |
| 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 inherited from QgsVectorLayer | |
| QString | displayExpression |
| QgsEditFormConfig | editFormConfig |
| bool | readOnly |
| QString | subsetString |
| bool | supportsEditing |
| Properties inherited from QgsMapLayer | |
| int | autoRefreshInterval |
| QgsCoordinateReferenceSystem | crs |
| bool | isValid |
| QString | mapTipTemplate |
| QgsLayerMetadata | metadata |
| QString | name |
| double | opacity |
| Qgis::LayerType | type |
Detailed Description
Class allowing to manage the auxiliary storage for a vector layer.
Such auxiliary data are data used mostly for the needs of QGIS (symbology) and have no real interest in being stored with the native raw geospatial data.
The need arises from the restrictions existing in the manual placement of labels. Manual placement of labels are possible in QGIS by setting some labeling properties (X and Y position, and rotation angle optionally) as being "data-defined", meaning that values come from a column (or an expression). But setting this up on an existing layer requires either to add new columns to the source layer, while it is not always possible or desirable.
This QgsAuxiliaryLayer provides the solution to this limitation. Actually it's an editable join to the original vector layer with some synchronisation mechanisms activated such as "Upsert On Edit" or "Delete Cascade". Thus, auxiliary fields are editable even if the source layer is not and edition of a joined field is also possible.
- Since
- QGIS 3.0
Definition at line 61 of file qgsauxiliarystorage.h.
Constructor & Destructor Documentation
◆ QgsAuxiliaryLayer() [1/2]
| QgsAuxiliaryLayer::QgsAuxiliaryLayer | ( | const QString & | pkField, |
| const QString & | filename, | ||
| const QString & | table, | ||
| QgsVectorLayer * | vlayer | ||
| ) |
Constructor.
- Parameters
-
pkField The primary key to use for joining filename The database path table The table name vlayer The target vector layer in join definition
◆ QgsAuxiliaryLayer() [2/2]
|
delete |
Copy constructor deactivated.
Member Function Documentation
◆ addAuxiliaryField()
| bool QgsAuxiliaryLayer::addAuxiliaryField | ( | const QgsPropertyDefinition & | definition | ) |
Adds an auxiliary field for the given property.
Setup for widget editors are updated in the target layer as well as the attribute table config to hide auxiliary fields by default.
- Parameters
-
definition The definition of the property to add
- Returns
trueif the auxiliary field is well added,falseotherwise
◆ auxiliaryFields()
| QgsFields QgsAuxiliaryLayer::auxiliaryFields | ( | ) | const |
Returns a list of all auxiliary fields currently managed by the layer.
◆ clear()
| bool QgsAuxiliaryLayer::clear | ( | ) |
Deletes all features from the layer.
Changes are automatically committed and the layer remains editable.
- Returns
trueif changes are committed without error,falseotherwise.
◆ clone()
| QgsAuxiliaryLayer * QgsAuxiliaryLayer::clone | ( | QgsVectorLayer * | layer | ) | const |
Returns a new instance equivalent to this one.
The underlying table is duplicate for the layer given in parameter. Note that the current auxiliary layer should be saved to have a proper duplicated table.
- Parameters
-
layer The layer for which the clone is made
◆ createAuxiliaryField() [1/2]
Creates a new auxiliary field from a field.
- Parameters
-
field The field to use to create the auxiliary field
◆ createAuxiliaryField() [2/2]
|
static |
Creates a new auxiliary field from a property definition.
- Parameters
-
definition The property definition of the auxiliary field to create
◆ createProperty() [1/3]
|
static |
Creates if necessary a new auxiliary field for a callout's property and activates this property in settings.
- Parameters
-
property The property to create vlayer The vector layer overwriteExisting since QGIS 3.22, controls whether an existing property should be completely overwritten or upgraded to a coalesce("new aux field", 'existing' || 'property' || 'expression') type property
- Returns
- The index of the auxiliary field or -1
- Since
- QGIS 3.20
◆ createProperty() [2/3]
|
static |
Creates if necessary a new auxiliary field for a diagram's property and activates this property in settings.
- Parameters
-
property The property to create vlayer The vector layer overwriteExisting since QGIS 3.22, controls whether an existing property should be completely overwritten or upgraded to a coalesce("new aux field", 'existing' || 'property' || 'expression') type property
- Returns
- The index of the auxiliary field or -1
◆ createProperty() [3/3]
|
static |
Creates if necessary a new auxiliary field for a PAL property and activates this property in settings.
- Parameters
-
property The property to create vlayer The vector layer overwriteExisting since QGIS 3.22, controls whether an existing property should be completely overwritten or upgraded to a coalesce("new aux field", 'existing' || 'property' || 'expression') type property
- Returns
- The index of the auxiliary field or -1
◆ deleteAttribute()
|
overridevirtual |
Removes attribute from the layer and commits changes.
The layer remains editable.
- Parameters
-
attr The index of the attribute to remove
- Returns
trueif the attribute is well deleted,falseotherwise
Reimplemented from QgsVectorLayer.
◆ exists()
| bool QgsAuxiliaryLayer::exists | ( | const QgsPropertyDefinition & | definition | ) | const |
Returns true if the property is stored in the layer already, false otherwise.
- Parameters
-
definition The property definition to check
- Returns
trueif the property is stored,falseotherwise
◆ indexOfPropertyDefinition()
| int QgsAuxiliaryLayer::indexOfPropertyDefinition | ( | const QgsPropertyDefinition & | definition | ) | const |
Returns the index of the auxiliary field for a specific property definition.
- Parameters
-
definition The property definition
- Returns
- The index of the field corresponding to the property or -1
◆ isHiddenProperty()
| bool QgsAuxiliaryLayer::isHiddenProperty | ( | int | index | ) | const |
Returns true if the underlying field has to be hidden from editing tools like attribute table, false otherwise.
- Parameters
-
index The index of the field for which visibility is checked
◆ joinInfo()
| QgsVectorLayerJoinInfo QgsAuxiliaryLayer::joinInfo | ( | ) | const |
Returns information to use for joining with primary key and so on.
◆ nameFromProperty()
|
static |
Returns the name of the auxiliary field for a property definition.
- Parameters
-
def The property definition joined The join prefix is taken into account if true
◆ operator=()
|
delete |
◆ propertyDefinitionFromField()
|
static |
Returns the property definition from an auxiliary field.
- Parameters
-
field The auxiliary field
◆ propertyDefinitionFromIndex()
| QgsPropertyDefinition QgsAuxiliaryLayer::propertyDefinitionFromIndex | ( | int | index | ) | const |
Returns the property definition for the underlying field index.
- Parameters
-
index The index of the field
◆ propertyFromIndex()
| int QgsAuxiliaryLayer::propertyFromIndex | ( | int | index | ) | const |
Returns the underlying property key for the field index.
The key may be a PAL, diagram or symbology property according to the underlying property definition of the field. The key -1 is returned if an error happened.
- Parameters
-
index The index of the field
◆ save()
| bool QgsAuxiliaryLayer::save | ( | ) |
Commits changes and starts editing then.
- Returns
trueif commit step passed,falseotherwise
◆ toSpatialLayer()
| QgsVectorLayer * QgsAuxiliaryLayer::toSpatialLayer | ( | ) | const |
An auxiliary layer is not spatial.
This method returns a spatial representation of auxiliary data.
- Returns
- A new spatial vector layer
The documentation for this class was generated from the following file:
- /build/qgis-3.30.0+99sid/src/core/qgsauxiliarystorage.h
