QGIS – Difference Between iface.mapCanvas and QgsMapCanvas

pyqgisqgisstandalone

I am working on standalone pyqgis script and I wanted to set project extent to position on imported layer.
First I tried with:

vlayer = QgsVectorLayer("data/layers/layer1.gpkg", "layer_name", "ogr")
canvas= iface.mapCanvas()
canvas.setExtent(layer.extent())
canvas.refresh()

And I got: AttributeError: 'NoneType' object has no attribute 'mapCanvas'

Then I tried with using the same layer:

ex = vlayer.extent()
canvas = QgsMapCanvas()
canvas.setExtent(ex)

And then it worked.
I am wondering why i could do this using QgsMapCanvas and not using mapCanvas from iface(which i imported from qgis.utils import iface).

What is the difference between these two object?
Is it meant to be like this because someone would want to work with native Qgis and someone with standalone app or something else?

Best Answer

On the one hand, QgsMapCanvas is a class. You can always create new canvas objects from it (as you did already in your second attempt).

On the other hand, iface.mapCanvas() is an instance, an object of the class QgsMapCanvas. iface.mapCanvas() is initialized when you load QGIS app with GUI (Python should be enabled to use it), and refers to the main canvas you see in QGIS GUI.

In a standalone app, iface is not initialized. QGIS app has no default canvas, and you are responsible for adding one to your app (which is optional, as you can have an app with no canvas). That's why you cannot call iface.mapCanvas() when working on a standalone app.

Related Solutions

QGIS Standalone Applications – Using Environment Variables in QGIS

You have to start the Qt event loop using:

app.exec_()

I would remove QgsApplication.exitQgis(). It should ideally be handled in a slot that is connected to lastWindowClosed() signal of the application.

Merge Shapefiles with Attributes Using PyQGIS – How to

OK here's the answer. I have discovered the processing toolbox from which there was a simple solution: As per http://qgis.org/de/docs/user_manual/processing/console.html

From the console you can get a list of all the algorithms available which contain the word "merge" by typing:

import processing
processing.alglist("merge")

Then you could find out how to use the most appropriate function with:

processing.alghelp("qgis:mergevectorlayers")

Then simply use the algorithm in your script as follows:

processing.runalg("qgis:mergevectorlayers", layer1, layer2,"outputfilename.shp")

On the other hand manually merging shapes may still be useful. For those who still want to manually copy features from an input layer into some destination layer with attributes you need to first make sure the destination layer has those fields.

old_attribute_List = input_layer.dataProvider().fields().toList()
new_attribute_List=[]
for attrib in old_attribute_List:
  if destination_layer.fieldNameIndex(attrib.name())==-1:
    new_attribute_List.append(QgsField(attrib.name(),attrib.type()))
destination_layer_data_provider.addAttributes(new_attribute_List)
destination_layer.updateFields()

Then to manually copy over the features you can do:

destination_layer.startEditing()
cfeature = QgsFeature()
cfeatures=[]
xfeatures = input_layer.getFeatures()
for xfeature in xfeatures:
    xgeometry = xfeature.geometry()
    #GEOMETRY TRANSFORM GOES HERE IF DESTINATION CRS DIFFERS FROM INPUT CRS
    cfeature_Attributes=[]
    cfeature_Attributes.extend(xfeature.attributes())
    cfeature.setGeometry(xgeometry)
    cfeature.setAttributes(cfeature_Attributes)
    cfeatures.append(cfeature)
destination_layer_data_provider.addFeatures(cfeatures)
destination_layer_data_provider.commitChanges()

Best Answer

Related Solutions

QGIS Standalone Applications – Using Environment Variables in QGIS

Merge Shapefiles with Attributes Using PyQGIS – How to

Related Question