|
| 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...
|
|
| 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 QgsWkbTypes::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...
|
|
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...
|
|
QString | mapTipTemplate () const |
| The mapTip is a pretty, html representation for feature information. 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 | setLabeling (QgsAbstractVectorLayerLabeling *labeling) |
| Sets labeling configuration. More...
|
|
void | setLabelsEnabled (bool enabled) |
| Sets whether labels should be enabled for the layer. More...
|
|
void | setMapTipTemplate (const QString &mapTipTemplate) |
| The mapTip is a pretty, html representation for feature information. 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 QgsWkbTypes::Type | 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...
|
|
| QgsMapLayer (QgsMapLayer const &)=delete |
| QgsMapLayer cannot be copied. More...
|
|
| QgsMapLayer (QgsMapLayerType type=QgsMapLayerType::VectorLayer, const QString &name=QString(), const QString &source=QString()) |
| Constructor for QgsMapLayer. More...
|
|
| ~QgsMapLayer () override |
|
QString | abstract () const |
| Returns the abstract of the layer used by QGIS Server in GetCapabilities request. More...
|
|
virtual bool | accept (QgsStyleEntityVisitorInterface *visitor) const |
| Accepts the specified symbology visitor, causing it to visit all symbols associated with the layer. More...
|
|
QString | attribution () const |
| Returns the attribution of the layer used by QGIS Server in GetCapabilities request. More...
|
|
QString | attributionUrl () const |
| Returns the attribution URL of the layer used by QGIS Server in GetCapabilities request. More...
|
|
int | autoRefreshInterval () const |
| Returns the auto refresh interval (in milliseconds). More...
|
|
QPainter::CompositionMode | blendMode () const |
| Returns the current blending mode for a layer. More...
|
|
virtual QgsMapLayer * | clone () const =0 |
| Returns a new instance equivalent to this one except for the id which is still unique. More...
|
|
virtual QgsMapLayerRenderer * | createMapRenderer (QgsRenderContext &rendererContext)=0 |
| Returns new instance of QgsMapLayerRenderer that will be used for rendering of given context. More...
|
|
QgsCoordinateReferenceSystem | crs () const |
| Returns the layer's spatial reference system. More...
|
|
template<class T > |
T | customEnumProperty (const QString &key, const T &defaultValue) |
| Returns the property value for a property based on an enum. More...
|
|
template<class T > |
T | customFlagProperty (const QString &key, const T &defaultValue) |
| Returns the property value for a property based on a flag. More...
|
|
const QgsObjectCustomProperties & | customProperties () const |
| Read all custom properties from layer. More...
|
|
Q_INVOKABLE QVariant | customProperty (const QString &value, const QVariant &defaultValue=QVariant()) const |
| Read a custom property from layer. More...
|
|
Q_INVOKABLE QStringList | customPropertyKeys () const |
| Returns list of all keys within custom properties. More...
|
|
virtual Q_INVOKABLE QgsDataProvider * | dataProvider () |
| Returns the layer's data provider, it may be nullptr . More...
|
|
virtual const QgsDataProvider * | dataProvider () const |
| Returns the layer's data provider in a const-correct manner, it may be nullptr . More...
|
|
QString | dataUrl () const |
| Returns the DataUrl of the layer used by QGIS Server in GetCapabilities request. More...
|
|
QString | dataUrlFormat () const |
| Returns the DataUrl format of the layer used by QGIS Server in GetCapabilities request. More...
|
|
virtual QSet< QgsMapLayerDependency > | dependencies () const |
| Gets the list of dependencies. More...
|
|
virtual QgsMapLayerElevationProperties * | elevationProperties () |
| Returns the layer's elevation properties. More...
|
|
virtual QgsError | error () const |
| Gets current status error. More...
|
|
void | exportNamedMetadata (QDomDocument &doc, QString &errorMsg) const |
| Export the current metadata of this layer as named metadata in a QDomDocument. More...
|
|
virtual void | exportNamedStyle (QDomDocument &doc, QString &errorMsg, const QgsReadWriteContext &context=QgsReadWriteContext(), QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) const |
| Export the properties of this layer as named style in a QDomDocument. More...
|
|
virtual void | exportSldStyle (QDomDocument &doc, QString &errorMsg) const |
| Export the properties of this layer as SLD style in a QDomDocument. More...
|
|
virtual QgsRectangle | extent () const |
| Returns the extent of the layer. More...
|
|
QgsMapLayer::LayerFlags | flags () const |
| Returns the flags for this layer. More...
|
|
bool | hasAutoRefreshEnabled () const |
| Returns true if auto refresh is enabled for the layer. More...
|
|
bool | hasScaleBasedVisibility () const |
| Returns whether scale based visibility is enabled for the layer. More...
|
|
virtual QString | htmlMetadata () const |
| Obtain a formatted HTML string containing assorted metadata for this layer. More...
|
|
QString | id () const |
| Returns the layer's unique ID, which is used to access this layer from QgsProject. More...
|
|
bool | importNamedMetadata (QDomDocument &document, QString &errorMessage) |
| Import the metadata of this layer from a QDomDocument. More...
|
|
virtual bool | importNamedStyle (QDomDocument &doc, QString &errorMsg, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) |
| Import the properties of this layer from a QDomDocument. More...
|
|
virtual bool | isEditable () const |
| Returns true if the layer can be edited. More...
|
|
bool | isInScaleRange (double scale) const |
| Tests whether the layer should be visible at the specified scale. More...
|
|
virtual bool | isModified () const |
| Returns true if the layer has been modified since last commit/save. More...
|
|
bool | isRefreshOnNotifyEnabled () const |
| Returns true if the refresh on provider nofification is enabled. More...
|
|
virtual bool | isSpatial () const |
| Returns true if the layer is considered a spatial layer, ie it has some form of geometry associated with it. More...
|
|
virtual bool | isTemporary () const |
| Returns true if the layer is considered a temporary layer. More...
|
|
bool | isValid () const |
| Returns the status of the layer. More...
|
|
QString | keywordList () const |
| Returns the keyword list of the layer used by QGIS Server in GetCapabilities request. More...
|
|
QgsMapLayerLegend * | legend () const |
| Can be nullptr . More...
|
|
QString | legendPlaceholderImage () const |
| Returns path to the placeholder image or an empty string if a generated legend is shown. More...
|
|
QString | legendUrl () const |
| Returns the URL for the layer's legend. More...
|
|
QString | legendUrlFormat () const |
| Returns the format for a URL based layer legend. More...
|
|
virtual QString | loadDefaultMetadata (bool &resultFlag) |
| Retrieve the default metadata for this layer if one exists (either as a .qmd file on disk or as a record in the users metadata table in their personal qgis.db) More...
|
|
virtual QString | loadDefaultStyle (bool &resultFlag) |
| Retrieve the default style for this layer if one exists (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) More...
|
|
virtual QString | loadNamedMetadata (const QString &uri, bool &resultFlag) |
| Retrieve a named metadata for this layer if one exists (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db) More...
|
|
bool | loadNamedMetadataFromDatabase (const QString &db, const QString &uri, QString &qmd) |
| Retrieve a named metadata for this layer from a sqlite database. More...
|
|
virtual QString | loadNamedStyle (const QString &uri, bool &resultFlag, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) |
| Retrieve a named style for this layer if one exists (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) More...
|
|
virtual bool | loadNamedStyleFromDatabase (const QString &db, const QString &uri, QString &qml) |
| Retrieve a named style for this layer from a sqlite database. More...
|
|
virtual QString | loadSldStyle (const QString &uri, bool &resultFlag) |
| Attempts to style the layer using the formatting from an SLD type file. More...
|
|
double | maximumScale () const |
| Returns the maximum map scale (i.e. More...
|
|
virtual const QgsLayerMetadata & | metadata () const |
| Returns a reference to the layer's metadata store. More...
|
|
virtual QString | metadataUri () const |
| Retrieve the metadata URI for this layer (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db) More...
|
|
Q_DECL_DEPRECATED QString | metadataUrl () const |
| Returns the metadata URL of the layer used by QGIS Server in GetCapabilities request. More...
|
|
Q_DECL_DEPRECATED QString | metadataUrlFormat () const |
| Returns the metadata format of the layer used by QGIS Server in GetCapabilities request. More...
|
|
Q_DECL_DEPRECATED QString | metadataUrlType () const |
| Returns the metadata type of the layer used by QGIS Server in GetCapabilities request. More...
|
|
double | minimumScale () const |
| Returns the minimum map scale (i.e. More...
|
|
QString | name () const |
| Returns the display name of the layer. More...
|
|
virtual double | opacity () const |
| Returns the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque). More...
|
|
QgsMapLayer & | operator= (QgsMapLayer const &)=delete |
| QgsMapLayer cannot be copied. More...
|
|
QString | originalXmlProperties () const |
| Returns the XML properties of the original layer as they were when the layer was first read from the project file. More...
|
|
virtual Qgis::MapLayerProperties | properties () const |
| Returns the map layer properties of this layer. More...
|
|
QString | providerType () const |
| Returns the provider type (provider key) for this layer. More...
|
|
QString | publicSource () const |
| Gets a version of the internal layer definition that has sensitive bits removed (for example, the password). More...
|
|
bool | readLayerXml (const QDomElement &layerElement, QgsReadWriteContext &context, QgsMapLayer::ReadFlags flags=QgsMapLayer::ReadFlags()) |
| Sets state from DOM document. More...
|
|
bool | readOnly () const |
| Returns if this layer is read only. More...
|
|
virtual bool | readSld (const QDomNode &node, QString &errorMessage) |
|
virtual bool | readStyle (const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) |
| Read the style for the current layer from the DOM node supplied. More...
|
|
virtual bool | readSymbology (const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories)=0 |
| Read the symbology for the current layer from the DOM node supplied. More...
|
|
QString | refreshOnNotifyMessage () const |
| Returns the message that should be notified by the provider to triggerRepaint. More...
|
|
virtual Q_INVOKABLE void | reload () |
| Synchronises with changes in the datasource. More...
|
|
void | removeCustomProperty (const QString &key) |
| Remove a custom property from layer. More...
|
|
QgsAbstract3DRenderer * | renderer3D () const |
| Returns 3D renderer associated with the layer. More...
|
|
virtual void | resolveReferences (QgsProject *project) |
| Resolve references to other layers (kept as layer IDs after reading XML) into layer objects. More...
|
|
virtual QString | saveDefaultMetadata (bool &resultFlag) |
| Save the current metadata of this layer as the default metadata (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db) More...
|
|
virtual 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...
|
|
QgsMapLayerServerProperties * | serverProperties () |
| Returns QGIS Server Properties for the map layer. More...
|
|
const QgsMapLayerServerProperties * | serverProperties () const |
| Returns QGIS Server Properties const for the map layer. More...
|
|
void | setAbstract (const QString &abstract) |
| Sets the abstract of the layer used by QGIS Server in GetCapabilities request. More...
|
|
void | setAttribution (const QString &attrib) |
| Sets the attribution of the layer used by QGIS Server in GetCapabilities request. More...
|
|
void | setAttributionUrl (const QString &attribUrl) |
| Sets the attribution URL of the layer used by QGIS Server in GetCapabilities request. More...
|
|
void | setAutoRefreshEnabled (bool enabled) |
| Sets whether auto refresh is enabled for the layer. More...
|
|
void | setAutoRefreshInterval (int interval) |
| Sets the auto refresh interval (in milliseconds) for the layer. More...
|
|
void | setBlendMode (QPainter::CompositionMode blendMode) |
| Set the blending mode used for rendering a layer. More...
|
|
void | setCrs (const QgsCoordinateReferenceSystem &srs, bool emitSignal=true) |
| Sets layer's spatial reference system. More...
|
|
template<class T > |
void | setCustomEnumProperty (const QString &key, const T &value) |
| Set the value of a property based on an enum. More...
|
|
template<class T > |
void | setCustomFlagProperty (const QString &key, const T &value) |
| Set the value of a property based on a flag. More...
|
|
void | setCustomProperties (const QgsObjectCustomProperties &properties) |
| Set custom properties for layer. More...
|
|
Q_INVOKABLE void | setCustomProperty (const QString &key, const QVariant &value) |
| Set a custom property for layer. More...
|
|
void | setDataSource (const QString &dataSource, const QString &baseName, const QString &provider, bool loadDefaultStyleFlag=false) |
| Updates the data source of the layer. More...
|
|
void | setDataSource (const QString &dataSource, const QString &baseName, const QString &provider, const QgsDataProvider::ProviderOptions &options, bool loadDefaultStyleFlag=false) |
| Updates the data source of the layer. More...
|
|
void | setDataSource (const QString &dataSource, const QString &baseName, const QString &provider, const QgsDataProvider::ProviderOptions &options, QgsDataProvider::ReadFlags flags) |
| Updates the data source of the layer. More...
|
|
void | setDataUrl (const QString &dataUrl) |
| Sets the DataUrl of the layer used by QGIS Server in GetCapabilities request. More...
|
|
void | setDataUrlFormat (const QString &dataUrlFormat) |
| Sets the DataUrl format of the layer used by QGIS Server in GetCapabilities request. More...
|
|
void | setFlags (QgsMapLayer::LayerFlags flags) |
| Returns the flags for this layer. More...
|
|
void | setKeywordList (const QString &keywords) |
| Sets the keyword list of the layer used by QGIS Server in GetCapabilities request. More...
|
|
virtual void | setLayerOrder (const QStringList &layers) |
| Reorders the previously selected sublayers of this layer from bottom to top. More...
|
|
void | setLegend (QgsMapLayerLegend *legend) |
| Assign a legend controller to the map layer. More...
|
|
void | setLegendPlaceholderImage (const QString &imgPath) |
| Set placeholder image for legend. More...
|
|
void | setLegendUrl (const QString &legendUrl) |
| Sets the URL for the layer's legend. More...
|
|
void | setLegendUrlFormat (const QString &legendUrlFormat) |
| Sets the format for a URL based layer legend. More...
|
|
virtual void | setMetadata (const QgsLayerMetadata &metadata) |
| Sets the layer's metadata store. More...
|
|
Q_DECL_DEPRECATED void | setMetadataUrl (const QString &metaUrl) |
| Sets the metadata URL of the layer used by QGIS Server in GetCapabilities request. More...
|
|
Q_DECL_DEPRECATED void | setMetadataUrlFormat (const QString &metaUrlFormat) |
| Sets the metadata format of the layer used by QGIS Server in GetCapabilities request. More...
|
|
Q_DECL_DEPRECATED void | setMetadataUrlType (const QString &metaUrlType) |
| Set the metadata type of the layer used by QGIS Server in GetCapabilities request MetadataUrlType indicates the standard to which the metadata complies. More...
|
|
void | setName (const QString &name) |
| Set the display name of the layer. More...
|
|
virtual void | setOpacity (double opacity) |
| Sets the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque). More...
|
|
void | setOriginalXmlProperties (const QString &originalXmlProperties) |
| Sets the original XML properties for the layer to originalXmlProperties. More...
|
|
void | setRenderer3D (QgsAbstract3DRenderer *renderer) |
| Sets 3D renderer for the layer. More...
|
|
void | setShortName (const QString &shortName) |
| Sets the short name of the layer used by QGIS Server to identify the layer. More...
|
|
virtual void | setSubLayerVisibility (const QString &name, bool visible) |
| Set the visibility of the given sublayer name. More...
|
|
void | setTitle (const QString &title) |
| Sets the title of the layer used by QGIS Server in GetCapabilities request. More...
|
|
QString | shortName () const |
| Returns the short name of the layer used by QGIS Server to identify the layer. More...
|
|
QString | source () const |
| Returns the source for the layer. More...
|
|
QgsMapLayerStyleManager * | styleManager () const |
| Gets access to the layer's style manager. More...
|
|
virtual QString | styleURI () const |
| Retrieve the style URI for this layer (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) More...
|
|
virtual QStringList | subLayers () const |
| Returns the sublayers of this layer. More...
|
|
virtual bool | supportsEditing () const |
| Returns whether the layer supports editing or not. More...
|
|
virtual QgsMapLayerTemporalProperties * | temporalProperties () |
| Returns the layer's temporal properties. More...
|
|
virtual QDateTime | timestamp () const |
| Time stamp of data source in the moment when data/metadata were loaded by provider. More...
|
|
QString | title () const |
| Returns the title of the layer used by QGIS Server in GetCapabilities request. More...
|
|
QgsCoordinateTransformContext | transformContext () const |
| Returns the layer data provider coordinate transform context or a default transform context if the layer does not have a valid data provider. More...
|
|
QgsMapLayerType | type () const |
| Returns the type of the layer. More...
|
|
QUndoStack * | undoStack () |
| Returns pointer to layer's undo stack. More...
|
|
QUndoStack * | undoStackStyles () |
| Returns pointer to layer's style undo stack. More...
|
|
QgsRectangle | wgs84Extent (bool forceRecalculate=false) const |
| Returns the WGS84 extent (EPSG:4326) of the layer according to ReadFlag::FlagTrustLayerMetadata. More...
|
|
bool | writeLayerXml (QDomElement &layerElement, QDomDocument &document, const QgsReadWriteContext &context) const |
| Stores state in DOM node. More...
|
|
virtual bool | writeStyle (QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) const |
| Write just the symbology information for the layer into the document. More...
|
|
virtual bool | writeSymbology (QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) const =0 |
| Write the style for the layer into the document provided. More...
|
|
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...
|
|
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...
|
|
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...
|
|
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 QgsWkbTypes::Type | wkbType () const =0 |
| Returns the geometry type for features returned by this source. More...
|
|
virtual | ~QgsAbstractProfileSource () |
|
virtual QgsAbstractProfileGenerator * | createProfileGenerator (const QgsProfileRequest &request)=0 |
| Given a profile request, returns a new profile generator ready for generating elevation profiles. More...
|
|