|
QGIS API Documentation
2.6.0-Brighton
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
QGIS API Documentation
2.6.0-Brighton
|
Represents a vector layer which manages a vector based data sets. More...
#include <qgsvectorlayer.h>
Classes | |
| struct | GroupData |
| struct | RangeData |
| struct | TabData |
| struct | ValueRelationData |
Public Types | |
| enum | EditorLayout { GeneratedLayout = 0, TabLayout = 1, UiFileLayout = 2 } |
| The different types to layout the attribute editor. More... | |
| enum | EditType { LineEdit, UniqueValues, UniqueValuesEditable, ValueMap, Classification, EditRange, SliderRange, CheckBox, FileName, Enumeration, Immutable, Hidden, TextEdit, Calendar, DialRange, ValueRelation, UuidGenerator, Photo, WebView, Color, EditorWidgetV2 } |
| enum | FeatureFormSuppress { SuppressDefault = 0, SuppressOn = 1, SuppressOff = 2 } |
| Types of feature form suppression after feature creation. More... | |
| enum | VertexMarkerType { SemiTransparentCircle, Cross, NoMarker } |
| Editing vertex markers. More... | |
 Public Types inherited from QgsMapLayer | |
| enum | LayerType { VectorLayer, RasterLayer, PluginLayer } |
| Layers enum defining the types of layers that can be added to a map. More... | |
Public Slots | |
| void | select (const QgsFeatureId &featureId) |
| Select feature by its ID. | |
| void | select (const QgsFeatureIds &featureIds) |
| Select features by their ID. | |
| void | deselect (const QgsFeatureId featureId) |
| Deselect feature by its ID. | |
| void | deselect (const QgsFeatureIds &featureIds) |
| Deselect features by their ID. | |
| void | removeSelection () |
| Clear selection. | |
| virtual void | updateExtents () |
| Update the extents for the layer. | |
| void | checkJoinLayerRemove (QString theLayerId) |
| Check if there is a join with a layer that will be removed. | |
| Public Slots inherited from QgsMapLayer | |
| virtual void | invalidTransformInput () |
| Event handler for when a coordinate transform fails due to bad vertex error. | |
| void | setMinimumScale (float theMinScale) |
| Accessor and mutator for the minimum scale denominator member. | |
| float | minimumScale () const |
| void | setMaximumScale (float theMaxScale) |
| Accessor and mutator for the maximum scale denominator member. | |
| float | maximumScale () const |
| void | toggleScaleBasedVisibility (bool theVisibilityFlag) |
| Accessor and mutator for the scale based visilibility flag. | |
| bool | hasScaleBasedVisibility () const |
| Q_DECL_DEPRECATED void | clearCacheImage () |
| Clear cached image. | |
| void | triggerRepaint () |
| Will advice the map canvas (and any other interested party) that this layer requires to be repainted. | |
| virtual QDateTime | timestamp () const |
| Time stamp of data source in the moment when data/metadata were loaded by provider. | |
Signals | |
| void | selectionChanged (const QgsFeatureIds selected, const QgsFeatureIds deselected, const bool clearAndSelect) |
| This signal is emitted when selection was changed. | |
| void | selectionChanged () |
| This signal is emitted when selection was changed. | |
| void | layerModified () |
| This signal is emitted when modifications has been done on layer. | |
| void | beforeModifiedCheck () const |
| Is emitted, when layer is checked for modifications. | |
| void | editingStarted () |
| Is emitted, when editing on this layer has started. | |
| void | editingStopped () |
| Is emitted, when edited changes successfully have been written to the data provider. | |
| void | beforeCommitChanges () |
| Is emitted, before changes are commited to the data provider. | |
| void | beforeRollBack () |
| Is emitted, before changes are rolled back. | |
| void | attributeAdded (int idx) |
| Will be emitted, when a new attribute has been added to this vector layer. | |
| void | attributeDeleted (int idx) |
| Will be emitted, when an attribute has been deleted from this vector layer. | |
| void | featureAdded (QgsFeatureId fid) |
| void | featureDeleted (QgsFeatureId fid) |
| void | updatedFields () |
| Is emitted, whenever the fields available from this layer have been changed. | |
| void | layerDeleted () |
| void | attributeValueChanged (QgsFeatureId fid, int idx, const QVariant &) |
| void | geometryChanged (QgsFeatureId fid, QgsGeometry &geom) |
| void | committedAttributesDeleted (const QString &layerId, const QgsAttributeList &deletedAttributes) |
| Signals emitted after committing changes. | |
| void | committedAttributesAdded (const QString &layerId, const QList< QgsField > &addedAttributes) |
| void | committedFeaturesAdded (const QString &layerId, const QgsFeatureList &addedFeatures) |
| void | committedFeaturesRemoved (const QString &layerId, const QgsFeatureIds &deletedFeatureIds) |
| void | committedAttributeValuesChanges (const QString &layerId, const QgsChangedAttributesMap &changedAttributesValues) |
| void | committedGeometriesChanges (const QString &layerId, const QgsGeometryMap &changedGeometries) |
| void | saveLayerToProject () |
| void | labelingFontNotFound (QgsVectorLayer *layer, const QString &fontfamily) |
| Emitted when the font family defined for labeling layer is not found on system. | |
| void | featureBlendModeChanged (const QPainter::CompositionMode &blendMode) |
| Signal emitted when setFeatureBlendMode() is called. | |
| void | layerTransparencyChanged (int layerTransparency) |
| Signal emitted when setLayerTransparency() is called. | |
| void | editCommandStarted (const QString &text) |
| Signal emitted when a new edit command has been started. | |
| void | editCommandEnded () |
| Signal emitted, when an edit command successfully ended. | |
| void | editCommandDestroyed () |
| Signal emitted, whan an edit command is destroyed. | |
| void | readCustomSymbology (const QDomElement &element, QString &errorMessage) |
| Signal emitted whenever the symbology (QML-file) for this layer is being read. | |
| void | writeCustomSymbology (QDomElement &element, QDomDocument &doc, QString &errorMessage) const |
| Signal emitted whenever the symbology (QML-file) for this layer is being written. | |
| Signals inherited from QgsMapLayer | |
| void | drawingProgress (int theProgress, int theTotalSteps) |
| void | statusChanged (QString theStatus) |
| Emit a signal with status (e.g. | |
| void | layerNameChanged () |
| Emit a signal that the layer name has been changed. | |
| void | layerCrsChanged () |
| Emit a signal that layer's CRS has been reset. | |
| void | repaintRequested () |
| By emitting this signal the layer tells that either appearance or content have been changed and any view showing the rendered layer should refresh itself. | |
| void | screenUpdateRequested () |
| void | recalculateExtents () |
| This is used to send a request that any mapcanvas using this layer update its extents. | |
| void | dataChanged () |
| data of layer changed | |
| void | blendModeChanged (const QPainter::CompositionMode &blendMode) |
| Signal emitted when the blend mode is changed, through QgsMapLayer::setBlendMode() | |
| void | rendererChanged () |
| Signal emitted when renderer is changed. | |
| void | legendChanged () |
| Signal emitted when legend of the layer has changed. | |
Public Member Functions | |
| QgsVectorLayer (QString path=QString::null, QString baseName=QString::null, QString providerLib=QString::null, bool loadDefaultStyleFlag=true) | |
| Constructor - creates a vector layer. | |
| virtual | ~QgsVectorLayer () |
| Destructor. | |
| QString | storageType () const |
| Returns the permanent storage type for this layer as a friendly name. | |
| QString | capabilitiesString () const |
| Capabilities for this layer in a friendly format. | |
| QString | dataComment () const |
| Returns a comment for the data in the layer. | |
| void | setDisplayField (QString fldName="") |
| Set the primary display field to be used in the identify results dialog. | |
| const QString | displayField () const |
| Returns the primary display field name used in the identify results dialog. | |
| void | setDisplayExpression (const QString &displayExpression) |
| Set the preview expression, used to create a human readable preview string. | |
| const QString | displayExpression () |
| Get the preview expression, used to create a human readable preview string. | |
| QgsVectorDataProvider * | dataProvider () |
| Returns the data provider. | |
| const QgsVectorDataProvider * | dataProvider () const |
| Returns the data provider in a const-correct manner. | |
| void | setProviderEncoding (const QString &encoding) |
| Sets the textencoding of the data provider. | |
| void | setCoordinateSystem () |
| Setup the coordinate system transformation for the layer. | |
| bool | addJoin (const QgsVectorJoinInfo &joinInfo) |
| Joins another vector layer to this layer. | |
| void | removeJoin (const QString &joinLayerId) |
| Removes a vector layer join. | |
| const QList< QgsVectorJoinInfo > & | vectorJoins () const |
| void | addExpressionField (const QString &exp, const QgsField &fld) |
| Add a new field which is calculated by the expression specified. | |
| void | removeExpressionField (int index) |
| Remove an expression field. | |
| QgsLabel * | label () |
| Get the label object associated with this layer. | |
| const QgsLabel * | label () const |
| QgsAttributeAction * | actions () |
| int | selectedFeatureCount () |
| The number of features that are selected in this layer. | |
| void | select (QgsRectangle &rect, bool addToSelection) |
| Select features found within the search rectangle (in layer's coordinates) | |
| void | modifySelection (QgsFeatureIds selectIds, QgsFeatureIds deselectIds) |
| Modifies the current selection on this layer. | |
| void | invertSelection () |
| Select not selected features and deselect selected ones. | |
| void | selectAll () |
| Select all the features. | |
| QgsFeatureIds | allFeatureIds () |
| Get all feature Ids. | |
| void | invertSelectionInRectangle (QgsRectangle &rect) |
| Invert selection of features found within the search rectangle (in layer's coordinates) | |
| QgsFeatureList | selectedFeatures () |
| Get a copy of the user-selected features. | |
| QgsFeatureIterator | selectedFeaturesIterator (QgsFeatureRequest request=QgsFeatureRequest()) |
| Get an iterator of the selected features. | |
| const QgsFeatureIds & | selectedFeaturesIds () const |
| Return reference to identifiers of selected features. | |
| void | setSelectedFeatures (const QgsFeatureIds &ids) |
| Change selection to the new set of features. | |
| QgsRectangle | boundingBoxOfSelected () |
| Returns the bounding box of the selected features. | |
| void | setDiagramRenderer (QgsDiagramRendererV2 *r) |
| Sets diagram rendering object (takes ownership) | |
| const QgsDiagramRendererV2 * | diagramRenderer () const |
| void | setDiagramLayerSettings (const QgsDiagramLayerSettings &s) |
| const QgsDiagramLayerSettings * | diagramLayerSettings () const |
| QgsFeatureRendererV2 * | rendererV2 () |
| Return renderer V2. | |
| void | setRendererV2 (QgsFeatureRendererV2 *r) |
| Set renderer V2. | |
| QGis::GeometryType | geometryType () const |
| Returns point, line or polygon. | |
| bool | hasGeometryType () const |
| Returns true if this is a geometry layer and false in case of NoGeometry (table only) or UnknownGeometry. | |
| QGis::WkbType | wkbType () const |
| Returns the WKBType or WKBUnknown in case of error. | |
| QString | providerType () const |
| Return the provider type for this layer. | |
| virtual bool | readXml (const QDomNode &layer_node) |
| reads vector layer specific state from project file Dom node. | |
| virtual bool | writeXml (QDomNode &layer_node, QDomDocument &doc) |
| write vector layer specific state to project file Dom node. | |
| virtual void | saveStyleToDatabase (QString name, QString description, bool useAsDefault, QString uiFileContent, QString &msgError) |
| Save named and sld style of the layer to the style table in the db. | |
| virtual int | listStylesInDatabase (QStringList &ids, QStringList &names, QStringList &descriptions, QString &msgError) |
| Lists all the style in db split into related to the layer and not related to. | |
| virtual QString | getStyleFromDatabase (QString styleId, QString &msgError) |
| Will return the named style corresponding to style id provided. | |
| virtual QString | loadNamedStyle (const QString &theURI, bool &theResultFlag, bool loadFromLocalDb) |
| Load a named style from file/local db/datasource db. | |
| virtual QString | loadNamedStyle (const QString &theURI, bool &theResultFlag) |
| Calls loadNamedStyle( theURI, theResultFlag, false ); Retained for backward compatibility. | |
| virtual bool | applyNamedStyle (QString namedStyle, QString errorMsg) |
| QgsAttributeEditorElement * | attributeEditorElementFromDomElement (QDomElement &elem, QObject *parent) |
| convert a saved attribute editor element into a AttributeEditor structure as it's used internally. | |
| bool | readSymbology (const QDomNode &node, QString &errorMessage) |
| Read the symbology for the current layer from the Dom node supplied. | |
| bool | writeSymbology (QDomNode &node, QDomDocument &doc, QString &errorMessage) const |
| Write the symbology for the layer into the docment provided. | |
| bool | writeSld (QDomNode &node, QDomDocument &doc, QString &errorMessage) const |
| bool | readSld (const QDomNode &node, QString &errorMessage) |
| virtual long | featureCount () const |
| Number of features in the layer. | |
| long | featureCount (QgsSymbolV2 *symbol) |
| Number of features rendered with specified symbol. | |
| bool | countSymbolFeatures (bool showProgress=true) |
| Count features for symbols. | |
| virtual bool | setSubsetString (QString subset) |
| Set the string (typically sql) used to define a subset of the layer. | |
| virtual QString | subsetString () |
| Get the string (typically sql) used to define a subset of the layer. | |
| QgsFeatureIterator | getFeatures (const QgsFeatureRequest &request=QgsFeatureRequest()) |
| Query the provider for features specified in request. | |
| bool | addFeature (QgsFeature &f, bool alsoUpdateExtent=true) |
| Adds a feature. | |
| bool | updateFeature (QgsFeature &f) |
| Updates an existing feature. | |
| bool | insertVertex (double x, double y, QgsFeatureId atFeatureId, int beforeVertex) |
| Insert a new vertex before the given vertex number, in the given ring, item (first number is index 0), and feature Not meaningful for Point geometries. | |
| 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. | |
| bool | deleteVertex (QgsFeatureId atFeatureId, int atVertex) |
| Deletes a vertex from a feature. | |
| bool | deleteSelectedFeatures () |
| Deletes the selected features. | |
| int | addRing (const QList< QgsPoint > &ring) |
| Adds a ring to polygon/multipolygon features. | |
| int | addPart (const QList< QgsPoint > &ring) |
| Adds a new part polygon to a multipart feature. | |
| int | translateFeature (QgsFeatureId featureId, double dx, double dy) |
| Translates feature by dx, dy. | |
| int | splitParts (const QList< QgsPoint > &splitLine, bool topologicalEditing=false) |
| Splits parts cut by the given line. | |
| int | splitFeatures (const QList< QgsPoint > &splitLine, bool topologicalEditing=false) |
| Splits features cut by the given line. | |
| Q_DECL_DEPRECATED int | removePolygonIntersections (QgsGeometry *geom, QgsFeatureIds ignoreFeatures=QgsFeatureIds()) |
| Changes the specified geometry such that it has no intersections with other polygon (or multipolygon) geometries in this vector layer. | |
| int | addTopologicalPoints (QgsGeometry *geom) |
| Adds topological points for every vertex of the geometry. | |
| int | addTopologicalPoints (const QgsPoint &p) |
| Adds a vertex to segments which intersect point p but don't already have a vertex there. | |
| int | insertSegmentVerticesForSnap (const QList< QgsSnappingResult > &snapResults) |
| Inserts vertices to the snapped segments. | |
| void | enableLabels (bool on) |
| Set labels on. | |
| bool | hasLabelsEnabled () const |
| Label is on. | |
| virtual bool | isEditable () const |
| Returns true if the provider is in editing mode. | |
| virtual bool | isReadOnly () const |
| Returns true if the provider is in read-only mode. | |
| virtual bool | isModified () const |
| Returns true if the provider has been modified since the last commit. | |
| bool | snapPoint (QgsPoint &point, double tolerance) |
| Snaps a point to the closest vertex if there is one within the snapping tolerance. | |
| int | snapWithContext (const QgsPoint &startPoint, double snappingTolerance, QMultiMap< double, QgsSnappingResult > &snappingResults, QgsSnapper::SnappingType snap_to) |
| Snaps to segment or vertex within given tolerance. | |
| virtual void | reload () |
| Synchronises with changes in the datasource. | |
| virtual QgsMapLayerRenderer * | createMapRenderer (QgsRenderContext &rendererContext) |
| Return new instance of QgsMapLayerRenderer that will be used for rendering of given context. | |
| bool | draw (QgsRenderContext &rendererContext) |
| Draws the layer. | |
| void | drawLabels (QgsRenderContext &rendererContext) |
| Draws the layer labels using coordinate transformation. | |
| QgsRectangle | extent () |
| Return the extent of the layer as a QRect. | |
| const QgsFields & | pendingFields () const |
| returns field list in the to-be-committed state | |
| QgsAttributeList | pendingAllAttributesList () |
| returns list of attributes | |
| QgsAttributeList | pendingPkAttributesList () |
| returns list of attribute making up the primary key | |
| int | pendingFeatureCount () |
| returns feature count after commit | |
| bool | setReadOnly (bool readonly=true) |
| Make layer read-only (editing disabled) or not. | |
| bool | startEditing () |
| Make layer editable. | |
| bool | changeGeometry (QgsFeatureId fid, QgsGeometry *geom) |
| change feature's geometry | |
| Q_DECL_DEPRECATED bool | changeAttributeValue (QgsFeatureId fid, int field, QVariant value, bool emitSignal) |
| Changes an attribute value (but does not commit it) | |
| bool | changeAttributeValue (QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue=QVariant()) |
| Changes an attribute value (but does not commit it) | |
| bool | addAttribute (const QgsField &field) |
| add an attribute field (but does not commit it) returns true if the field was added | |
| void | addAttributeAlias (int attIndex, QString aliasString) |
| Sets an alias (a display name) for attributes to display in dialogs. | |
| void | remAttributeAlias (int attIndex) |
| Removes an alias (a display name) for attributes to display in dialogs. | |
| void | addAttributeEditorWidget (QgsAttributeEditorElement *data) |
| Adds a tab (for the attribute editor form) holding groups and fields. | |
| const QString | editorWidgetV2 (int fieldIdx) const |
| Get the id for the editor widget used to represent the field at the given index. | |
| const QString | editorWidgetV2 (const QString &fieldName) const |
| Get the id for the editor widget used to represent the field at the given index. | |
| const QgsEditorWidgetConfig | editorWidgetV2Config (int fieldIdx) const |
| Get the configuration for the editor widget used to represent the field at the given index. | |
| const QgsEditorWidgetConfig | editorWidgetV2Config (const QString &fieldName) const |
| Get the configuration for the editor widget used to represent the field at the given index. | |
| QList < QgsAttributeEditorElement * > & | attributeEditorElements () |
| Returns a list of tabs holding groups and fields. | |
| void | clearAttributeEditorWidgets () |
| Clears all the tabs for the attribute editor form. | |
| QString | attributeAlias (int attributeIndex) const |
| Returns the alias of an attribute name or an empty string if there is no alias. | |
| QString | attributeDisplayName (int attributeIndex) const |
| Convenience function that returns the attribute alias if defined or the field name else. | |
| const QMap< QString, QString > & | attributeAliases () const |
| const QSet< QString > & | excludeAttributesWMS () const |
| void | setExcludeAttributesWMS (const QSet< QString > &att) |
| const QSet< QString > & | excludeAttributesWFS () const |
| void | setExcludeAttributesWFS (const QSet< QString > &att) |
| bool | deleteAttribute (int attr) |
| delete an attribute field (but does not commit it) | |
| bool | deleteAttributes (QList< int > attrs) |
| Deletes a list of attribute fields (but does not commit it) | |
| bool | addFeatures (QgsFeatureList features, bool makeSelected=true) |
| Insert a copy of the given features into the layer (but does not commit it) | |
| bool | deleteFeature (QgsFeatureId fid) |
| delete a feature from the layer (but does not commit it) | |
| bool | commitChanges () |
| Attempts to commit any changes to disk. | |
| const QStringList & | commitErrors () |
| bool | rollBack (bool deleteBuffer=true) |
| Stop editing and discard the edits. | |
| Q_DECL_DEPRECATED EditType | editType (int idx) |
| Get edit type. | |
| Q_DECL_DEPRECATED void | setEditType (int idx, EditType edit) |
| Get edit type. | |
| EditorLayout | editorLayout () |
| get the active layout for the attribute editor for this layer | |
| void | setEditorLayout (EditorLayout editorLayout) |
| set the active layout for the attribute editor for this layer | |
| void | setEditorWidgetV2 (int attrIdx, const QString &widgetType) |
| Set the editor widget type for a field. | |
| void | setEditorWidgetV2Config (int attrIdx, const QgsEditorWidgetConfig &config) |
| Set the editor widget config for a field. | |
| Q_DECL_DEPRECATED void | setCheckedState (int idx, QString checked, QString notChecked) |
| Set string representing 'true' for a checkbox. | |
| QString | editForm () |
| get edit form | |
| void | setEditForm (QString ui) |
| set edit form | |
| QgsVectorLayer::FeatureFormSuppress | featureFormSuppress () const |
| Type of feature form pop-up suppression after feature creation (overrides app setting) | |
| void | setFeatureFormSuppress (QgsVectorLayer::FeatureFormSuppress s) |
| Set type of feature form pop-up suppression after feature creation (overrides app setting) | |
| QString | annotationForm () const |
| get annotation form | |
| void | setAnnotationForm (const QString &ui) |
| set annotation form for layer | |
| QString | editFormInit () |
| get python function for edit form initialization | |
| void | setEditFormInit (QString function) |
| set python function for edit form initialization | |
| Q_DECL_DEPRECATED QMap < QString, QVariant > | valueMap (int idx) |
| Access value map. | |
| Q_DECL_DEPRECATED RangeData | range (int idx) |
| Access range widget config data. | |
| ValueRelationData | valueRelation (int idx) |
| Access value relation widget data. | |
| QList< QgsRelation > | referencingRelations (int idx) |
| Get relations, where the foreign key is on this layer. | |
| Q_DECL_DEPRECATED QString | dateFormat (int idx) |
| Access date format. | |
| Q_DECL_DEPRECATED QSize | widgetSize (int idx) |
| Access widget size for photo and webview widget. | |
| bool | fieldEditable (int idx) |
| is edit widget editable | |
| bool | labelOnTop (int idx) |
| label widget on top | |
| void | setFieldEditable (int idx, bool editable) |
| set edit widget editable | |
| void | setLabelOnTop (int idx, bool onTop) |
| label widget on top | |
| QgsVectorLayerEditBuffer * | editBuffer () |
| Buffer with uncommitted editing operations. Only valid after editing has been turned on. | |
| void | beginEditCommand (QString text) |
| Create edit command for undo/redo operations. | |
| void | endEditCommand () |
| Finish edit command and add it to undo/redo stack. | |
| void | destroyEditCommand () |
| Destroy active command and reverts all changes in it. | |
| int | fieldNameIndex (const QString &fieldName) const |
| Returns the index of a field name or -1 if the field does not exist. | |
| void | updateFields () |
| Assembles mUpdatedFields considering provider fields, joined fields and added fields. | |
| void | createJoinCaches () |
| Caches joined attributes if required (and not already done) | |
| void | uniqueValues (int index, QList< QVariant > &uniqueValues, int limit=-1) |
| Returns unique values for column. | |
| QVariant | minimumValue (int index) |
| Returns minimum value for an attribute column or invalid variant in case of error. | |
| QVariant | maximumValue (int index) |
| Returns maximum value for an attribute column or invalid variant in case of error. | |
| void | setFeatureBlendMode (const QPainter::CompositionMode &blendMode) |
| Write blend mode for features. | |
| QPainter::CompositionMode | featureBlendMode () const |
| Read blend mode for layer. | |
| void | setLayerTransparency (int layerTransparency) |
| Write transparency for layer. | |
| int | layerTransparency () const |
| Read transparency for layer. | |
| QString | metadata () |
| Obtain Metadata for this layer. | |
| QgsGeometryCache * | cache () |
| void | setSimplifyMethod (const QgsVectorSimplifyMethod &simplifyMethod) |
| Set the simplification settings for fast rendering of features. | |
| const QgsVectorSimplifyMethod & | simplifyMethod () const |
| Returns the simplification settings for fast rendering of features. | |
| bool | simplifyDrawingCanbeApplied (const QgsRenderContext &renderContext, QgsVectorSimplifyMethod::SimplifyHint simplifyHint) const |
| Returns whether the VectorLayer can apply the specified simplification hint. | |
| Public Member Functions inherited from QgsMapLayer | |
| QgsMapLayer (QgsMapLayer::LayerType type=VectorLayer, QString lyrname=QString::null, QString source=QString::null) | |
| Constructor. | |
| virtual | ~QgsMapLayer () |
| Destructor. | |
| QgsMapLayer::LayerType | type () const |
| Get the type of the layer. | |
| QString | id () const |
| Get this layer's unique ID, this ID is used to access this layer from map layer registry. | |
| void | setLayerName (const QString &name) |
| Set the display name of the layer. | |
| const QString & | name () const |
| Get the display name of the layer. | |
| const QString & | originalName () const |
| Get the original name of the layer. | |
| void | setTitle (const QString &title) |
| const QString & | title () const |
| void | setAbstract (const QString &abstract) |
| const QString & | abstract () const |
| void | setKeywordList (const QString &keywords) |
| const QString & | keywordList () const |
| void | setDataUrl (const QString &dataUrl) |
| const QString & | dataUrl () const |
| void | setDataUrlFormat (const QString &dataUrlFormat) |
| const QString & | dataUrlFormat () const |
| void | setAttribution (const QString &attrib) |
| const QString & | attribution () const |
| void | setAttributionUrl (const QString &attribUrl) |
| const QString & | attributionUrl () const |
| void | setMetadataUrl (const QString &metaUrl) |
| const QString & | metadataUrl () const |
| void | setMetadataUrlType (const QString &metaUrlType) |
| const QString & | metadataUrlType () const |
| void | setMetadataUrlFormat (const QString &metaUrlFormat) |
| const QString & | metadataUrlFormat () const |
| void | setBlendMode (const QPainter::CompositionMode &blendMode) |
| Write blend mode for layer. | |
| QPainter::CompositionMode | blendMode () const |
| Read blend mode for layer. | |
| bool | isValid () |
| QString | publicSource () const |
| const QString & | source () const |
| Returns the source for the layer. | |
| virtual QStringList | subLayers () const |
| Returns the sublayers of this layer (Useful for providers that manage their own layers, such as WMS) | |
| virtual void | setLayerOrder (const QStringList &layers) |
| Reorders the previously selected sublayers of this layer from bottom to top (Useful for providers that manage their own layers, such as WMS) | |
| virtual void | setSubLayerVisibility (QString name, bool vis) |
| Set the visibility of the given sublayer name. | |
| bool | readLayerXML (const QDomElement &layerElement) |
| sets state from Dom document | |
| bool | writeLayerXML (QDomElement &layerElement, QDomDocument &document, QString relativeBasePath=QString::null) |
| stores state in Dom node | |
| void | setCustomProperty (const QString &key, const QVariant &value) |
| Set a custom property for layer. | |
| QVariant | customProperty (const QString &value, const QVariant &defaultValue=QVariant()) const |
| Read a custom property from layer. | |
| void | removeCustomProperty (const QString &key) |
| Remove a custom property from layer. | |
| virtual Q_DECL_DEPRECATED QString | lastErrorTitle () |
| virtual Q_DECL_DEPRECATED QString | lastError () |
| virtual QgsError | error () const |
| Get current status error. | |
| const QgsCoordinateReferenceSystem & | crs () const |
| Returns layer's spatial reference system. | |
| void | setCrs (const QgsCoordinateReferenceSystem &srs, bool emitSignal=true) |
| Sets layer's spatial reference system. | |
| virtual QString | styleURI () |
| Retrieve the style URI for this layer (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) | |
| virtual QString | loadDefaultStyle (bool &theResultFlag) |
| 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) | |
| virtual bool | loadNamedStyleFromDb (const QString &db, const QString &theURI, QString &qml) |
| virtual void | exportNamedStyle (QDomDocument &doc, QString &errorMsg) |
| Export the properties of this layer as named style in a QDomDocument. | |
| virtual void | exportSldStyle (QDomDocument &doc, QString &errorMsg) |
| Export the properties of this layer as SLD style in a QDomDocument. | |
| virtual QString | saveDefaultStyle (bool &theResultFlag) |
| Save the properties of this layer as the default style (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) | |
| virtual QString | saveNamedStyle (const QString &theURI, bool &theResultFlag) |
| Save the properties of this layer as a named style (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) | |
| virtual QString | saveSldStyle (const QString &theURI, bool &theResultFlag) |
| virtual QString | loadSldStyle (const QString &theURI, bool &theResultFlag) |
| QUndoStack * | undoStack () |
| Return pointer to layer's undo stack. | |
| void | setLegendUrl (const QString &legendUrl) |
| const QString & | legendUrl () const |
| void | setLegendUrlFormat (const QString &legendUrlFormat) |
| const QString & | legendUrlFormat () const |
| Q_DECL_DEPRECATED QImage * | cacheImage () |
| Q_DECL_DEPRECATED void | setCacheImage (QImage *) |
| virtual Q_DECL_DEPRECATED void | onCacheImageDelete () |
| void | setLegend (QgsMapLayerLegend *legend) |
| Assign a legend controller to the map layer. | |
| QgsMapLayerLegend * | legend () const |
| Can be null. | |
Static Public Member Functions | |
| static void | drawVertexMarker (double x, double y, QPainter &p, QgsVectorLayer::VertexMarkerType type, int vertexSize) |
| Draws a vertex symbol at (screen) coordinates x, y. | |
| Static Public Member Functions inherited from QgsMapLayer | |
| static QDomDocument | asLayerDefinition (QList< QgsMapLayer * > layers, QString relativeBasePath=QString::null) |
| Returns the given layer as a layer definition document Layer definitions store the data source as well as styling and custom properties. | |
| static QList< QgsMapLayer * > | fromLayerDefinition (QDomDocument &document) |
| Creates a new layer from a layer defininition document. | |
| static QList< QgsMapLayer * > | fromLayerDefinitionFile (const QString qlrfile) |
| static QString | capitaliseLayerName (const QString &name) |
| A convenience function to (un)capitalise the layer name. | |
Protected Slots | |
| void | invalidateSymbolCountedFlag () |
Protected Member Functions | |
| void | setExtent (const QgsRectangle &rect) |
| Set the extent. | |
| Protected Member Functions inherited from QgsMapLayer | |
| void | setValid (bool valid) |
| set whether layer is valid or not - should be used in constructor. | |
| void | readCustomProperties (const QDomNode &layerNode, const QString &keyStartsWith="") |
| Read custom properties from project file. | |
| void | writeCustomProperties (QDomNode &layerNode, QDomDocument &doc) const |
| Write custom properties to project file. | |
| void | connectNotify (const char *signal) |
| debugging member - invoked when a connect() is made to this object | |
| void | appendError (const QgsErrorMessage &theMessage) |
| Add error message. | |
| void | setError (const QgsError &theError) |
| Set error message. | |
Friends | |
| class | QgsVectorLayerEditBuffer |
| class | QgsVectorLayerFeatureSource |
Additional Inherited Members | |
| Protected Attributes inherited from QgsMapLayer | |
| QgsRectangle | mExtent |
| Extent of the layer. | |
| bool | mValid |
| Indicates if the layer is valid and can be drawn. | |
| QString | mDataSource |
| data source description string, varies by layer type | |
| QString | mLayerName |
| Name of the layer - used for display. | |
| QString | mLayerOrigName |
| Original name of the layer. | |
| QString | mTitle |
| QString | mAbstract |
| Description of the layer. | |
| QString | mKeywordList |
| QString | mDataUrl |
| DataUrl of the layer. | |
| QString | mDataUrlFormat |
| QString | mAttribution |
| Attribution of the layer. | |
| QString | mAttributionUrl |
| QString | mMetadataUrl |
| MetadataUrl of the layer. | |
| QString | mMetadataUrlType |
| QString | mMetadataUrlFormat |
| QString | mLegendUrl |
| WMS legend. | |
| QString | mLegendUrlFormat |
| QgsError | mError |
| Error. | |
Represents a vector layer which manages a vector based data sets.
The QgsVectorLayer is instantiated by specifying the name of a data provider, such as postgres or wfs, and url defining the specific data set to connect to. The vector layer constructor in turn instantiates a QgsVectorDataProvider subclass corresponding to the provider type, and passes it the url. The data provider connects to the data source.
The QgsVectorLayer provides a common interface to the different data types. It also manages editing transactions.
Sample usage of the QgsVectorLayer class:
The main data providers supported by QGIS are listed below.
The memory data provider is used to construct in memory data, for example scratch data or data generated from spatial operations such as contouring. There is no inherent persistent storage of the data. The data source uri is constructed. The url specifies the geometry type ("point", "linestring", "polygon", "multipoint","multilinestring","multipolygon"), optionally followed by url parameters as follows:
An example url is "Point?crs=epsg:4326&field=id:integer&field=name:string(20)&index=yes"
Accesses data using the OGR drivers (http://www.gdal.org/ogr/ogr_formats.html). The url is the OGR connection string. A wide variety of data formats can be accessed using this driver, including file based formats used by many GIS systems, database formats, and web services. Some of these formats are also supported by custom data providers listed below.
Access data in a spatialite database. The url defines the connection parameters, table, geometry column, and other attributes. The url can be constructed using the QgsDataSourceURI class.
Connects to a postgresql database. The url defines the connection parameters, table, geometry column, and other attributes. The url can be constructed using the QgsDataSourceURI class.
Connects to a Microsoft SQL server database. The url defines the connection parameters, table, geometry column, and other attributes. The url can be constructed using the QgsDataSourceURI class.
Used to access data provided by a web feature service.
The url can be a HTTP url to a WFS 1.0.0 server or a GML2 data file path. Examples are http://foobar/wfs or /foo/bar/file.gml
If a GML2 file path is provided the driver will attempt to read the schema from a file in the same directory with the same basename + “.xsd”. This xsd file must be in the same format as a WFS describe feature type response. If no xsd file is provide then the driver will attempt to guess the attribute types from the file.
In the case of a HTTP URL the ‘FILTER’ query string parameter can be used to filter the WFS feature type. The ‘FILTER’ key value can either be a QGIS expression or an OGC XML filter. If the value is set to a QGIS expression the driver will turn it into OGC XML filter before passing it to the WFS server. Beware the QGIS expression filter only supports” =, !=, <, >, <=, >=, AND, OR, NOT, LIKE, IS NULL” attribute operators, “BBOX, Disjoint, Intersects, Touches, Crosses, Contains, Overlaps, Within” spatial binary operators and the QGIS local “geomFromWKT, geomFromGML” geometry constructor functions.
Also note:
Accesses data in a delimited text file, for example CSV files generated by spreadsheets. The contents of the file are split into columns based on specified delimiter characters. Each record may be represented spatially either by an X and Y coordinate column, or by a WKT (well known text) formatted columns.
The url defines the filename, the formatting options (how the text in the file is divided into data fields, and which fields contain the X,Y coordinates or WKT text definition. The options are specified as url query items.
At its simplest the url can just be the filename, in which case it will be loaded as a CSV formatted file.
The url may include the following items:
encoding=UTF-8
Defines the character encoding in the file. The default is UTF-8. To use the default encoding for the operating system use "System".
type=(csv|regexp|whitespace|plain)
Defines the algorithm used to split records into columns. Records are defined by new lines, except for csv format files for which quoted fields may span multiple records. The default type is csv.
delimiter=characters
Defines the delimiter characters used for csv and plain type files, or the regular expression for regexp type files. It is a literal string of characters except that "\t" may be used to represent a tab character.
quote=characters
Defines the characters that are used as quote characters for csv and plain type files.
escape=characters
Defines the characters used to escape delimiter, quote, and newline characters.
skipLines=n
Defines the number of lines to ignore at the beginning of the file (default 0)
useHeader=(yes|no)
Defines whether the first record in the file (after skipped lines) contains column names (default yes)
trimFields=(yes|no)
If yes then leading and trailing whitespace will be removed from fields
skipEmptyFields=(yes|no)
If yes then empty fields will be discarded (eqivalent to concatenating consecutive delimiters)
maxFields=#
Specifies the maximum number of fields to load for each record. Additional fields will be discarded. Default is 0 - load all fields.
decimalPoint=c
Defines a character that is used as a decimal point in the numeric columns The default is '.'.
xField=column yField=column
Defines the name of the columns holding the x and y coordinates for XY point geometries. If the useHeader is no (ie there are no column names), then this is the column number (with the first column as 1).
xyDms=(yes|no)
If yes then the X and Y coordinates are interpreted as degrees/minutes/seconds format (fairly permissively), or degree/minutes format.
wktField=column
Defines the name of the columns holding the WKT geometry definition for WKT geometries. If the useHeader is no (ie there are no column names), then this is the column number (with the first column as 1).
geomType=(point|line|polygon|none)
Defines the geometry type for WKT type geometries. QGIS will only display one type of geometry for the layer - any others will be ignored when the file is loaded. By default the provider uses the type of the first geometry in the file. Use geomType to override this type.
geomType can also be set to none, in which case the layer is loaded without geometries.
subset=expression
Defines an expression that will identify a subset of records to display
crs=crsstring
Defines the coordinate reference system used for the layer. This can be any string accepted by QgsCoordinateReferenceSystem::createFromString()
-subsetIndex=(yes|no)
Determines whether the provider generates an index to improve the efficiency of subsets. The default is yes
-spatialIndex=(yes|no)
Determines whether the provider generates a spatial index. The default is no.
-watchFile=(yes|no)
Defines whether the file will be monitored for changes. The default is to monitor for changes.
quiet
Errors encountered loading the file will not be reported in a user dialog if quiet is included (They will still be shown in the output log).
Provider reads tracks, routes, and waypoints from a GPX file. The url defines the name of the file, and the type of data to retrieve from it ("track", "route", or "waypoint").
An example url is "/home/user/data/holiday.gpx?type=route"
Provider to display vector data in a GRASS GIS layer.
| QgsVectorLayer::QgsVectorLayer | ( | QString | path = QString::null, |
| QString | baseName = QString::null, |
||
| QString | providerLib = QString::null, |
||
| bool | loadDefaultStyleFlag = true |
||
| ) |
Constructor - creates a vector layer.
The QgsVectorLayer is constructed by instantiating a data provider. The provider interprets the supplied path (url) of the data source to connect to and access the data.
| path | The path or url of the parameter. Typically this encodes parameters used by the data provider as url query items. |
| baseName | The name used to represent the layer in the legend |
| providerLib | The name of the data provider, eg "memory", "postgres" |
| loadDefaultStyleFlag | whether to load the default style |
|
virtual |
Destructor.
|
inline |
| bool QgsVectorLayer::addAttribute | ( | const QgsField & | field | ) |
add an attribute field (but does not commit it) returns true if the field was added
| void QgsVectorLayer::addAttributeAlias | ( | int | attIndex, |
| QString | aliasString | ||
| ) |
Sets an alias (a display name) for attributes to display in dialogs.
| void QgsVectorLayer::addAttributeEditorWidget | ( | QgsAttributeEditorElement * | data | ) |
Adds a tab (for the attribute editor form) holding groups and fields.
| void QgsVectorLayer::addExpressionField | ( | const QString & | exp, |
| const QgsField & | fld | ||
| ) |
Add a new field which is calculated by the expression specified.
| exp | The expression which calculates the field |
| fld | The field to calculate |
| bool QgsVectorLayer::addFeature | ( | QgsFeature & | f, |
| bool | alsoUpdateExtent = true |
||
| ) |
Adds a feature.
| f | feature to add |
| alsoUpdateExtent | If True, will also go to the effort of e.g. updating the extents. |
| bool QgsVectorLayer::addFeatures | ( | QgsFeatureList | features, |
| bool | makeSelected = true |
||
| ) |
Insert a copy of the given features into the layer (but does not commit it)
| bool QgsVectorLayer::addJoin | ( | const QgsVectorJoinInfo & | joinInfo | ) |
Joins another vector layer to this layer.
| joinInfo | join object containing join layer id, target and source field |
| int QgsVectorLayer::addPart | ( | const QList< QgsPoint > & | ring | ) |
Adds a new part polygon to a multipart feature.
| int QgsVectorLayer::addRing | ( | const QList< QgsPoint > & | ring | ) |
Adds a ring to polygon/multipolygon features.
| int QgsVectorLayer::addTopologicalPoints | ( | QgsGeometry * | geom | ) |
Adds topological points for every vertex of the geometry.
| geom | the geometry where each vertex is added to segments of other features |
| int QgsVectorLayer::addTopologicalPoints | ( | const QgsPoint & | p | ) |
Adds a vertex to segments which intersect point p but don't already have a vertex there.
If a feature already has a vertex at position p, no additional vertex is inserted. This method is useful for topological editing.
| p | position of the vertex |
| QgsFeatureIds QgsVectorLayer::allFeatureIds | ( | ) |
Get all feature Ids.
|
inline |
get annotation form
|
virtual |
|
signal |
Will be emitted, when a new attribute has been added to this vector layer.
Applies only to types QgsFields::OriginEdit and QgsFields::OriginProvider
| idx | The index of the new attribute |
| QString QgsVectorLayer::attributeAlias | ( | int | attributeIndex | ) | const |
Returns the alias of an attribute name or an empty string if there is no alias.
|
inline |
|
signal |
Will be emitted, when an attribute has been deleted from this vector layer.
Applies only to types QgsFields::OriginEdit and QgsFields::OriginProvider
| idx | The index of the deleted attribute |
| QString QgsVectorLayer::attributeDisplayName | ( | int | attributeIndex | ) | const |
Convenience function that returns the attribute alias if defined or the field name else.
| QgsAttributeEditorElement * QgsVectorLayer::attributeEditorElementFromDomElement | ( | QDomElement & | elem, |
| QObject * | parent | ||
| ) |
convert a saved attribute editor element into a AttributeEditor structure as it's used internally.
| elem | the DOM element |
| parent | the QObject which will own this object |
| QList< QgsAttributeEditorElement * > & QgsVectorLayer::attributeEditorElements | ( | ) |
Returns a list of tabs holding groups and fields.
|
signal |
|
signal |
Is emitted, before changes are commited to the data provider.
|
signal |
Is emitted, when layer is checked for modifications.
Use for last-minute additions
|
signal |
Is emitted, before changes are rolled back.
| void QgsVectorLayer::beginEditCommand | ( | QString | text | ) |
Create edit command for undo/redo operations.
| text | text which is to be displayed in undo window |
| QgsRectangle QgsVectorLayer::boundingBoxOfSelected | ( | ) |
Returns the bounding box of the selected features.
If there is no selection, QgsRectangle(0,0,0,0) is returned
|
inline |
| QString QgsVectorLayer::capabilitiesString | ( | ) | const |
Capabilities for this layer in a friendly format.
| bool QgsVectorLayer::changeAttributeValue | ( | QgsFeatureId | fid, |
| int | field, | ||
| QVariant | value, | ||
| bool | emitSignal | ||
| ) |
Changes an attribute value (but does not commit it)
| bool QgsVectorLayer::changeAttributeValue | ( | QgsFeatureId | fid, |
| int | field, | ||
| const QVariant & | newValue, | ||
| const QVariant & | oldValue = QVariant() |
||
| ) |
Changes an attribute value (but does not commit it)
| fid | The feature id of the feature to be changed |
| field | The index of the field to be updated |
| newValue | The value which will be assigned to the field |
| oldValue | The previous value to restore on undo (will otherwise be retrieved) |
| bool QgsVectorLayer::changeGeometry | ( | QgsFeatureId | fid, |
| QgsGeometry * | geom | ||
| ) |
change feature's geometry
|
slot |
Check if there is a join with a layer that will be removed.
| void QgsVectorLayer::clearAttributeEditorWidgets | ( | ) |
Clears all the tabs for the attribute editor form.
| bool QgsVectorLayer::commitChanges | ( | ) |
Attempts to commit any changes to disk.
Returns the result of the attempt. If a commit fails, the in-memory changes are left alone.
This allows editing to continue if the commit failed on e.g. a disallowed value in a Postgres database - the user can re-edit and try again.
The commits occur in distinct stages, (add attributes, add features, change attribute values, change geometries, delete features, delete attributes) so if a stage fails, it's difficult to roll back cleanly. Therefore any error message also includes which stage failed so that the user has some chance of repairing the damage cleanly.
| const QStringList & QgsVectorLayer::commitErrors | ( | ) |
|
signal |
|
signal |
Signals emitted after committing changes.
|
signal |
|
signal |
|
signal |
|
signal |
| bool QgsVectorLayer::countSymbolFeatures | ( | bool | showProgress = true | ) |
Count features for symbols.
Feature counts may be get by featureCount( QgsSymbolV2*).
| showProgress | show progress dialog |
| void QgsVectorLayer::createJoinCaches | ( | ) |
Caches joined attributes if required (and not already done)
|
virtual |
Return new instance of QgsMapLayerRenderer that will be used for rendering of given context.
Reimplemented from QgsMapLayer.
| QString QgsVectorLayer::dataComment | ( | ) | const |
Returns a comment for the data in the layer.
| QgsVectorDataProvider * QgsVectorLayer::dataProvider | ( | ) |
Returns the data provider.
| const QgsVectorDataProvider * QgsVectorLayer::dataProvider | ( | ) | const |
Returns the data provider in a const-correct manner.
| QString QgsVectorLayer::dateFormat | ( | int | idx | ) |
Access date format.
| bool QgsVectorLayer::deleteAttribute | ( | int | attr | ) |
delete an attribute field (but does not commit it)
| bool QgsVectorLayer::deleteAttributes | ( | QList< int > | attrs | ) |
Deletes a list of attribute fields (but does not commit it)
| attrs | the indices of the attributes to delete |
| bool QgsVectorLayer::deleteFeature | ( | QgsFeatureId | fid | ) |
delete a feature from the layer (but does not commit it)
| bool QgsVectorLayer::deleteSelectedFeatures | ( | ) |
Deletes the selected features.
| bool QgsVectorLayer::deleteVertex | ( | QgsFeatureId | atFeatureId, |
| int | atVertex | ||
| ) |
Deletes a vertex from a feature.
|
slot |
Deselect feature by its ID.
| featureId | The id of the feature to deselect |
|
slot |
Deselect features by their ID.
| featureIds | The ids of the features to deselect |
| void QgsVectorLayer::destroyEditCommand | ( | ) |
Destroy active command and reverts all changes in it.
|
inline |
|
inline |
| const QString QgsVectorLayer::displayExpression | ( | ) |
Get the preview expression, used to create a human readable preview string.
Uses QgsExpression
| const QString QgsVectorLayer::displayField | ( | ) | const |
Returns the primary display field name used in the identify results dialog.
|
virtual |
|
virtual |
Draws the layer labels using coordinate transformation.
Reimplemented from QgsMapLayer.
|
static |
Draws a vertex symbol at (screen) coordinates x, y.
(Useful to assist vertex editing.)
|
inline |
Buffer with uncommitted editing operations. Only valid after editing has been turned on.
|
signal |
Signal emitted, whan an edit command is destroyed.
|
signal |
Signal emitted, when an edit command successfully ended.
|
signal |
Signal emitted when a new edit command has been started.
| text | Description for this edit command |
| QString QgsVectorLayer::editForm | ( | ) |
get edit form
| QString QgsVectorLayer::editFormInit | ( | ) |
get python function for edit form initialization
|
signal |
Is emitted, when editing on this layer has started.
|
signal |
Is emitted, when edited changes successfully have been written to the data provider.
| QgsVectorLayer::EditorLayout QgsVectorLayer::editorLayout | ( | ) |
get the active layout for the attribute editor for this layer
| const QString QgsVectorLayer::editorWidgetV2 | ( | int | fieldIdx | ) | const |
Get the id for the editor widget used to represent the field at the given index.
| fieldIdx | The index of the field |
| const QString QgsVectorLayer::editorWidgetV2 | ( | const QString & | fieldName | ) | const |
Get the id for the editor widget used to represent the field at the given index.
| fieldName | The name of the field |
| const QgsEditorWidgetConfig QgsVectorLayer::editorWidgetV2Config | ( | int | fieldIdx | ) | const |
Get the configuration for the editor widget used to represent the field at the given index.
| fieldIdx | The index of the field |
| const QgsEditorWidgetConfig QgsVectorLayer::editorWidgetV2Config | ( | const QString & | fieldName | ) | const |
Get the configuration for the editor widget used to represent the field at the given index.
| fieldName | The name of the field |
| QgsVectorLayer::EditType QgsVectorLayer::editType | ( | int | idx | ) |
Get edit type.
| void QgsVectorLayer::enableLabels | ( | bool | on | ) |
Set labels on.
| void QgsVectorLayer::endEditCommand | ( | ) |
Finish edit command and add it to undo/redo stack.
|
inline |
|
inline |
|
virtual |
Return the extent of the layer as a QRect.
Reimplemented from QgsMapLayer.
|
signal |
| QPainter::CompositionMode QgsVectorLayer::featureBlendMode | ( | ) | const |
Read blend mode for layer.
|
signal |
Signal emitted when setFeatureBlendMode() is called.
|
virtual |
Number of features in the layer.
This is necessary if features are added/deleted or the layer has been subsetted. If the data provider chooses not to support this feature, the total number of features can be returned.
| long QgsVectorLayer::featureCount | ( | QgsSymbolV2 * | symbol | ) |
Number of features rendered with specified symbol.
Features must be first calculated by countSymbolFeatures()
| symbol | the symbol |
|
signal |
|
inline |
Type of feature form pop-up suppression after feature creation (overrides app setting)
| bool QgsVectorLayer::fieldEditable | ( | int | idx | ) |
is edit widget editable
| int QgsVectorLayer::fieldNameIndex | ( | const QString & | fieldName | ) | const |
Returns the index of a field name or -1 if the field does not exist.
|
signal |
| QGis::GeometryType QgsVectorLayer::geometryType | ( | ) | const |
Returns point, line or polygon.
| QgsFeatureIterator QgsVectorLayer::getFeatures | ( | const QgsFeatureRequest & | request = QgsFeatureRequest() | ) |
Query the provider for features specified in request.
|
virtual |
Will return the named style corresponding to style id provided.
| bool QgsVectorLayer::hasGeometryType | ( | ) | const |
Returns true if this is a geometry layer and false in case of NoGeometry (table only) or UnknownGeometry.
| bool QgsVectorLayer::hasLabelsEnabled | ( | void | ) | const |
Label is on.
| int QgsVectorLayer::insertSegmentVerticesForSnap | ( | const QList< QgsSnappingResult > & | snapResults | ) |
Inserts vertices to the snapped segments.
This is useful for topological editing if snap to segment is enabled.
| snapResults | results collected from the snapping operation |
| bool QgsVectorLayer::insertVertex | ( | double | x, |
| double | y, | ||
| QgsFeatureId | atFeatureId, | ||
| int | beforeVertex | ||
| ) |
Insert a new vertex before the given vertex number, in the given ring, item (first number is index 0), and feature Not meaningful for Point geometries.
|
protectedslot |
| void QgsVectorLayer::invertSelection | ( | ) |
Select not selected features and deselect selected ones.
| void QgsVectorLayer::invertSelectionInRectangle | ( | QgsRectangle & | rect | ) |
Invert selection of features found within the search rectangle (in layer's coordinates)
| rect | The rectangle in which the selection of features will be inverted |
|
virtual |
Returns true if the provider is in editing mode.
Reimplemented from QgsMapLayer.
|
virtual |
Returns true if the provider has been modified since the last commit.
|
virtual |
Returns true if the provider is in read-only mode.
| QgsLabel * QgsVectorLayer::label | ( | ) |
Get the label object associated with this layer.
| const QgsLabel * QgsVectorLayer::label | ( | ) | const |
|
signal |
Emitted when the font family defined for labeling layer is not found on system.
| bool QgsVectorLayer::labelOnTop | ( | int | idx | ) |
label widget on top
|
signal |
|
signal |
This signal is emitted when modifications has been done on layer.
| int QgsVectorLayer::layerTransparency | ( | ) | const |
Read transparency for layer.
|
signal |
Signal emitted when setLayerTransparency() is called.
|
virtual |
Lists all the style in db split into related to the layer and not related to.
| ids | the list in which will be stored the style db ids |
| names | the list in which will be stored the style names |
| descriptions | the list in which will be stored the style descriptions |
| msgError |
|
virtual |
Load a named style from file/local db/datasource db.
| theURI | the URI of the style or the URI of the layer |
| theResultFlag | will be set to true if a named style is correctly loaded |
| loadFromLocalDb | if true forces to load from local db instead of datasource one |
|
virtual |
Calls loadNamedStyle( theURI, theResultFlag, false ); Retained for backward compatibility.
Reimplemented from QgsMapLayer.
| QVariant QgsVectorLayer::maximumValue | ( | int | index | ) |
Returns maximum value for an attribute column or invalid variant in case of error.
|
virtual |
Obtain Metadata for this layer.
Reimplemented from QgsMapLayer.
| QVariant QgsVectorLayer::minimumValue | ( | int | index | ) |
Returns minimum value for an attribute column or invalid variant in case of error.
| void QgsVectorLayer::modifySelection | ( | QgsFeatureIds | selectIds, |
| QgsFeatureIds | deselectIds | ||
| ) |
Modifies the current selection on this layer.
| selectIds | Select these ids |
| deselectIds | Deselect these ids |
| bool QgsVectorLayer::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.
| QgsAttributeList QgsVectorLayer::pendingAllAttributesList | ( | ) |
returns list of attributes
| int QgsVectorLayer::pendingFeatureCount | ( | ) |
returns feature count after commit
| const QgsFields & QgsVectorLayer::pendingFields | ( | ) | const |
returns field list in the to-be-committed state
| QgsAttributeList QgsVectorLayer::pendingPkAttributesList | ( | ) |
returns list of attribute making up the primary key
| QString QgsVectorLayer::providerType | ( | ) | const |
Return the provider type for this layer.
| QgsVectorLayer::RangeData QgsVectorLayer::range | ( | int | idx | ) |
Access range widget config data.
|
signal |
Signal emitted whenever the symbology (QML-file) for this layer is being read.
If there is custom style information saved in the file, you can connect to this signal and update the layer style accordingly.
| element | The XML layer style element. |
| errorMessage | Write error messages into this string. |
|
virtual |
Reimplemented from QgsMapLayer.
|
virtual |
Read the symbology for the current layer from the Dom node supplied.
| node | node that will contain the symbology definition for this layer. |
| errorMessage | reference to string that will be updated with any error messages |
Implements QgsMapLayer.
|
virtual |
reads vector layer specific state from project file Dom node.
Reimplemented from QgsMapLayer.
| QList< QgsRelation > QgsVectorLayer::referencingRelations | ( | int | idx | ) |
Get relations, where the foreign key is on this layer.
| idx | Only get relations, where idx forms part of the foreign key |
|
virtual |
Synchronises with changes in the datasource.
Reimplemented from QgsMapLayer.
| void QgsVectorLayer::remAttributeAlias | ( | int | attIndex | ) |
Removes an alias (a display name) for attributes to display in dialogs.
| void QgsVectorLayer::removeExpressionField | ( | int | index | ) |
Remove an expression field.
| index | The index of the field |
| void QgsVectorLayer::removeJoin | ( | const QString & | joinLayerId | ) |
Removes a vector layer join.
| int QgsVectorLayer::removePolygonIntersections | ( | QgsGeometry * | geom, |
| QgsFeatureIds | ignoreFeatures = QgsFeatureIds() |
||
| ) |
Changes the specified geometry such that it has no intersections with other polygon (or multipolygon) geometries in this vector layer.
| geom | geometry to modify |
| ignoreFeatures | list of feature ids where intersections should be ignored |
|
slot |
Clear selection.
| QgsFeatureRendererV2 * QgsVectorLayer::rendererV2 | ( | ) |
Return renderer V2.
| bool QgsVectorLayer::rollBack | ( | bool | deleteBuffer = true | ) |
Stop editing and discard the edits.
| deleteBuffer | whether to delete editing buffer |
|
signal |
|
virtual |
Save named and sld style of the layer to the style table in the db.
| name | |
| description | |
| useAsDefault | |
| uiFileContent | |
| msgError |
| void QgsVectorLayer::select | ( | QgsRectangle & | rect, |
| bool | addToSelection | ||
| ) |
Select features found within the search rectangle (in layer's coordinates)
| rect | The search rectangle |
| addToSelection | If set to true will not clear before selecting |
|
slot |
Select feature by its ID.
| featureId | The id of the feature to select |
|
slot |
Select features by their ID.
| featureIds | The ids of the features to select |
| void QgsVectorLayer::selectAll | ( | ) |
Select all the features.
| int QgsVectorLayer::selectedFeatureCount | ( | ) |
The number of features that are selected in this layer.
| QgsFeatureList QgsVectorLayer::selectedFeatures | ( | ) |
Get a copy of the user-selected features.
| const QgsFeatureIds & QgsVectorLayer::selectedFeaturesIds | ( | ) | const |
Return reference to identifiers of selected features.
| QgsFeatureIterator QgsVectorLayer::selectedFeaturesIterator | ( | QgsFeatureRequest | request = QgsFeatureRequest() | ) |
Get an iterator of the selected features.
| request | You may specify a request, e.g. to limit the set of requested attributes. Any filter on the request will be discarded. |
|
signal |
This signal is emitted when selection was changed.
| selected | Newly selected feature ids |
| deselected | Ids of all features which have previously been selected but are not any more |
| clearAndSelect | In case this is set to true, the old selection was dismissed and the new selection corresponds to selected |
|
signal |
This signal is emitted when selection was changed.
| void QgsVectorLayer::setAnnotationForm | ( | const QString & | ui | ) |
set annotation form for layer
| void QgsVectorLayer::setCheckedState | ( | int | idx, |
| QString | checked, | ||
| QString | notChecked | ||
| ) |
Set string representing 'true' for a checkbox.
| void QgsVectorLayer::setCoordinateSystem | ( | ) |
Setup the coordinate system transformation for the layer.
| void QgsVectorLayer::setDiagramLayerSettings | ( | const QgsDiagramLayerSettings & | s | ) |
| void QgsVectorLayer::setDiagramRenderer | ( | QgsDiagramRendererV2 * | r | ) |
Sets diagram rendering object (takes ownership)
| void QgsVectorLayer::setDisplayExpression | ( | const QString & | displayExpression | ) |
Set the preview expression, used to create a human readable preview string.
Used e.g. in the attribute table feature list. Uses QgsExpression.
| displayExpression | The expression which will be used to preview features for this layer |
| void QgsVectorLayer::setDisplayField | ( | QString | fldName = "" | ) |
Set the primary display field to be used in the identify results dialog.
sets the preferred display field based on some fuzzy logic
| void QgsVectorLayer::setEditForm | ( | QString | ui | ) |
set edit form
| void QgsVectorLayer::setEditFormInit | ( | QString | function | ) |
set python function for edit form initialization
| void QgsVectorLayer::setEditorLayout | ( | EditorLayout | editorLayout | ) |
set the active layout for the attribute editor for this layer
| void QgsVectorLayer::setEditorWidgetV2 | ( | int | attrIdx, |
| const QString & | widgetType | ||
| ) |
Set the editor widget type for a field.
QGIS ships the following widget types, additional types may be available depending on plugins.
| attrIdx | Index of the field |
| widgetType | Type id of the editor widget to use |
| void QgsVectorLayer::setEditorWidgetV2Config | ( | int | attrIdx, |
| const QgsEditorWidgetConfig & | config | ||
| ) |
Set the editor widget config for a field.
Python: Will accept a map.
Example:
| attrIdx | Index of the field |
| config | The config to set for this field |
| void QgsVectorLayer::setEditType | ( | int | idx, |
| EditType | edit | ||
| ) |
Get edit type.
|
inline |
|
inline |
|
protectedvirtual |
Set the extent.
Reimplemented from QgsMapLayer.
| void QgsVectorLayer::setFeatureBlendMode | ( | const QPainter::CompositionMode & | blendMode | ) |
Write blend mode for features.
|
inline |
Set type of feature form pop-up suppression after feature creation (overrides app setting)
| void QgsVectorLayer::setFieldEditable | ( | int | idx, |
| bool | editable | ||
| ) |
set edit widget editable
| void QgsVectorLayer::setLabelOnTop | ( | int | idx, |
| bool | onTop | ||
| ) |
label widget on top
| void QgsVectorLayer::setLayerTransparency | ( | int | layerTransparency | ) |
Write transparency for layer.
| void QgsVectorLayer::setProviderEncoding | ( | const QString & | encoding | ) |
Sets the textencoding of the data provider.
| bool QgsVectorLayer::setReadOnly | ( | bool | readonly = true | ) |
Make layer read-only (editing disabled) or not.
| void QgsVectorLayer::setRendererV2 | ( | QgsFeatureRendererV2 * | r | ) |
Set renderer V2.
| void QgsVectorLayer::setSelectedFeatures | ( | const QgsFeatureIds & | ids | ) |
Change selection to the new set of features.
Dismisses the current selection. Will emit the selectionChanged( QgsFeatureIds, QgsFeatureIds, bool ) signal with the clearAndSelect flag set.
| ids | The ids which will be the new selection |
|
inline |
Set the simplification settings for fast rendering of features.
|
virtual |
Set the string (typically sql) used to define a subset of the layer.
| subset | The subset string. This may be the where clause of a sql statement or other defintion string specific to the underlying dataprovider and data store. |
| bool QgsVectorLayer::simplifyDrawingCanbeApplied | ( | const QgsRenderContext & | renderContext, |
| QgsVectorSimplifyMethod::SimplifyHint | simplifyHint | ||
| ) | const |
Returns whether the VectorLayer can apply the specified simplification hint.
|
inline |
Returns the simplification settings for fast rendering of features.
| bool QgsVectorLayer::snapPoint | ( | QgsPoint & | point, |
| double | tolerance | ||
| ) |
Snaps a point to the closest vertex if there is one within the snapping tolerance.
| point | The point which is set to the position of a vertex if there is one within the snapping tolerance. If there is no point within this tolerance, point is left unchanged. |
| tolerance | The snapping tolerance |
| int QgsVectorLayer::snapWithContext | ( | const QgsPoint & | startPoint, |
| double | snappingTolerance, | ||
| QMultiMap< double, QgsSnappingResult > & | snappingResults, | ||
| QgsSnapper::SnappingType | snap_to | ||
| ) |
Snaps to segment or vertex within given tolerance.
| startPoint | point to snap (in layer coordinates) |
| snappingTolerance | distance tolerance for snapping |
| snappingResults | snapping results. Key is the distance between startPoint and snapping target |
| snap_to | to segment / to vertex |
| int QgsVectorLayer::splitFeatures | ( | const QList< QgsPoint > & | splitLine, |
| bool | topologicalEditing = false |
||
| ) |
Splits features cut by the given line.
| splitLine | line that splits the layer features |
| topologicalEditing | true if topological editing is enabled |
| int QgsVectorLayer::splitParts | ( | const QList< QgsPoint > & | splitLine, |
| bool | topologicalEditing = false |
||
| ) |
Splits parts cut by the given line.
| splitLine | line that splits the layer features |
| topologicalEditing | true if topological editing is enabled |
| bool QgsVectorLayer::startEditing | ( | ) |
Make layer editable.
| QString QgsVectorLayer::storageType | ( | ) | const |
Returns the permanent storage type for this layer as a friendly name.
|
virtual |
Get the string (typically sql) used to define a subset of the layer.
| int QgsVectorLayer::translateFeature | ( | QgsFeatureId | featureId, |
| double | dx, | ||
| double | dy | ||
| ) |
Translates feature by dx, dy.
| featureId | id of the feature to translate |
| dx | translation of x-coordinate |
| dy | translation of y-coordinate |
| void QgsVectorLayer::uniqueValues | ( | int | index, |
| QList< QVariant > & | uniqueValues, | ||
| int | limit = -1 |
||
| ) |
Returns unique values for column.
| index | column index for attribute |
| uniqueValues | out: result list |
| limit | maximum number of values to return (-1 if unlimited) |
|
signal |
Is emitted, whenever the fields available from this layer have been changed.
This can be due to manually adding attributes or due to a join.
|
virtualslot |
Update the extents for the layer.
This is necessary if features are added/deleted or the layer has been subsetted.
| bool QgsVectorLayer::updateFeature | ( | QgsFeature & | f | ) |
Updates an existing feature.
This method needs to query the datasource on every call. Consider using changeAttributeValue() or changeGeometry() instead.
| f | Feature to update |
| void QgsVectorLayer::updateFields | ( | ) |
Assembles mUpdatedFields considering provider fields, joined fields and added fields.
| QMap< QString, QVariant > QgsVectorLayer::valueMap | ( | int | idx | ) |
Access value map.
| QgsVectorLayer::ValueRelationData QgsVectorLayer::valueRelation | ( | int | idx | ) |
Access value relation widget data.
| const QList< QgsVectorJoinInfo > & QgsVectorLayer::vectorJoins | ( | ) | const |
| QSize QgsVectorLayer::widgetSize | ( | int | idx | ) |
Access widget size for photo and webview widget.
| QGis::WkbType QgsVectorLayer::wkbType | ( | ) | const |
Returns the WKBType or WKBUnknown in case of error.
|
signal |
Signal emitted whenever the symbology (QML-file) for this layer is being written.
If there is custom style information you want to save to the file, you can connect to this signal and update the element accordingly.
| element | The XML element where you can add additional style information to. |
| doc | The XML document that you can use to create new XML nodes. |
| errorMessage | Write error messages into this string. |
| bool QgsVectorLayer::writeSld | ( | QDomNode & | node, |
| QDomDocument & | doc, | ||
| QString & | errorMessage | ||
| ) | const |
|
virtual |
Write the symbology for the layer into the docment provided.
| node | the node that will have the style element added to it. |
| doc | the document that will have the QDomNode added. |
| errorMessage | reference to string that will be updated with any error messages |
Implements QgsMapLayer.
|
virtual |
write vector layer specific state to project file Dom node.
Reimplemented from QgsMapLayer.
|
friend |
|
friend |
1.8.1.2