Просмотр кода страницы Добавление списка слоёв в приложение PyQGIS

{{Статья|Опубликована|qgis-legend}}
{{Аннотация|Подробное описание процесса подключения списка слоёв в приложениях на базе QGIS с помощью Python.}}

QGIS помимо готовой пользовательской ГИС является еще и набором библиотек, которые могут быть использованы для создания новых приложений. Мы уже [http://gis-lab.info/qa/qgis-standalone.html рассказывали] о создании самостоятельного отдельного приложения на основе QGIS. К сожалению, при разработке таких приложений некоторые элементы интерфейса необходимо создавать самостоятельно. Один из примеров такого элемента — список загруженных слоёв (иногда неверно называемый легендой).

Данная статья описывает процесс встраивания списка слоёв в приложение PyQGIS. В основе статьи лежит перевод поста «[http://geotux.tuxfamily.org/index.php?option=com_myblog&show=tabla-de-contenido-leyenda-para-aplicaciones-basadas-en-pyqgis.html&Itemid=59 Layer list widget for PyQGIS applications]», сделанного German Carrillo в блоге GeoTux.

Работоспособность примеров проверена на QGIS 1.7. В новых версиях QGIS могут быть внесены изменения, делающие данные примеры неработоспособным.

=== Подготовка ===

Будем исходить из того, что все программное обеспечение установлено при помощи установщика OSGeo4W ([http://gis-lab.info/qa/qgis-osgeo4w.html подробнее]) используя путь по умолчанию <tt>C:\OSGeo4W</tt>. Кроме самой QGIS со всеми зависимостями, необходимо выбрать следующие пакеты в категории Libs:

<pre>pyqt4, qt4-devel, qt4-doc, qt4-libs</pre>

В этих пакетах находятся инструменты разработчика, необходимые библиотеки и документация.

Предполагается, что читатель уже знаком с процессом создания приложений PyQGIS и QGIS Python API. Если это не так, рекомендуем ознакомиться со статьей «[http://gis-lab.info/qa/qgis-standalone.html Создание приложения на базе набора библиотек QGIS на Python]». Для демонстрации основных аспектов работы со списком слоёв мы немного модифицировали пример, рассмотренный в этой статье. Скачать полный код приложения можно [http://gis-lab.info/other/qgis-legend.7z здесь].

=== Общие сведения о виджете ===

Рассматриваемый виджет разработан German Carrillo и является упрощенной версией списка слоёв QGIS. Основное отличие от оригинала — не поддерживается новая символика и отсутствуют группы слоёв.

Вот так выглядит приложение со списком слоёв:

[[Файл:qgis-legend-01.png|center|thumb|400px]]

==== Возможности ====

* получение упорядоченного списка слоёв
* изменение порядка следования слоёв в легенде с соответствующим изменением порядка слоёв карты
* управление видимостью слоя
* отображение/изменение символики слоя (рекомендуется создать свой собственный диалог настройки символики, автор виджета предлагает лишь очень простой пример)
* изменение некоторых параметров слоя
* загрузка/сохранение стилей (.qml)
* удаление слоёв
* интеграция с картой и инструментами, действующими на загруженные слои (Скрыть/Показать все, Удалить все)

Виджет распространяется по условиям [http://www.gnu.org/licenses/gpl-2.0.html GNU GPL v2].

=== Подключение легенды к приложению ===

Сначала нужно загрузить [http://downloads.tuxfamily.org/tuxgis/geoblogs/pyqgis_toc/pyqgis_legend.zip архив] и извлечь его содержимое в каталог с приложением. В архиве находится:

* файл <tt>legend.py</tt>, который реализует весь фукционал легенды
* несколько иконок, необходимых для отображения слоёв разных типов
* иконки действий для выпадающего меню
* диалог настройки свойств слоя

==== Инициализация ====

В основном классе нашего приложения импортируем класс <tt>Legend</tt> из файла <tt>legend.py</tt>

<syntaxhighlight lang="python">
from legend import Legend
</syntaxhighlight>

В этом же классе создадим новый метод <tt>CreateLegendWidget</tt>, который будет отвечать за создание плавающего окна и за установку связи между легендой и картой.

<syntaxhighlight lang="python">
def createLegendWidget( self ):
  # создаем легенду
  self.legend = Legend( self )
  self.legend.setCanvas( self.canvas )
  self.legend.setObjectName( "theMapLegend" )

  # создаем плавающую панель и добавляем к ней легенду
  self.LegendDock = QDockWidget( "Layers", self )
  self.LegendDock.setObjectName( "legend" )
  self.LegendDock.setAllowedAreas( Qt.LeftDockWidgetArea | Qt.RightDockWidgetArea )
  self.LegendDock.setWidget( self.legend )
  self.LegendDock.setContentsMargins ( 9, 9, 9, 9 )
  self.addDockWidget( Qt.LeftDockWidgetArea, self.LegendDock )
</syntaxhighlight>

Вызов этого метода необходимо добавить в метод <tt>__init__</tt> основного класса приложения. Обратите внимание, что создание легенды необходимо выполнять после создания карты (<tt>QgsMapCanvas</tt>).

<syntaxhighlight lang="python">
class MainWindow( QMainWindow, Ui_MainWindow ):
  def __init__( self ):
    MainWindow.__init__( self )

    # Требуется Qt4 для инициализации пользовательского интерфейса
    self.setupUi( self )
    # Создаем карту
    self.canvas = QgsMapCanvas()
    ...
    # создаем легенду
    self.createLegendWidget()
</syntaxhighlight>

==== Использование ====

Виджет легенды использует несколько иконок: иконки для разных типов слоёв и иконки для контекстного меню слоя. Чтобы они отображались необходимо скомпилировать входящий в архив файл <tt>resources.qrc</tt> командой

<pre>pyrcc4 resources.qrc -o resources_rc.py</pre>

В файле <tt>legend.py</tt> уже присутствует ссылка на сгенерированный таким образом файл. Если приложение использует свой собственный ресурсный файл (а так чаще всего и бывает), есть два варианта

# переименовать один из ресурсных файлов
# поместить все ресурсы в один файл

В последнем случае может потребоваться задание раздельных префиксов для ресурсов, относящихся к разным частям приложения (например, один префикс для иконок легенды и второй для остальных файлов). При изменении префикса для ресурсов легенды также необходимо соответствующим образом изменить переменную <tt>resource_prefix</tt> в файле <tt>legend.py</tt>

<pre>resources_prefix = ":/legend/imgs/"</pre>

Мы выбрали второй вариант: все изображения находятся в каталоге images и вложенных каталогах, в ресурсном файле создано два префикса и соотвественно изменена переменная <tt>resource_prefix</tt> в файле <tt>legend.py</tt>. Обратите внимание, что помимо задания другого префикса, для каждого файла был создан псевдоним (alias).

При использовании легенды немного меняется процедура добавления слоёв. Если раньше для загрузки и отображения слоя мы использовали свой собственный метод, в котором добавляли слой и обновляли <tt>LayerSet</tt>, то теперь контролировать процесс загрузки и удаления будет виджет легенды. Виджет имеет слот, обновляющий список слоёв при каждом добавлении, удалении или перемещении слоя. Всё что от нас требуется — вызвать соответствующие методы класса <tt>QgsMapLayerRegistry</tt> (например, <tt>addMapLayer</tt> или <tt>removeMapLayer</tt>). А вот вызов метода <tt>setLayerSet</tt> класса <tt>QgsMapCanvas</tt> теперь не нужен, т.к. об этом заботится виджет легенды. Его можно закомментировать или вообще удалить. Таким образом, для добавления нового слоя необходима всего одна строка кода

<syntaxhighlight lang="python">
QgsMapLayerRegistry.instance().addMapLayer( layer )
</syntaxhighlight>

здесь <tt>layer</tt> — экземпляр класса <tt>QgsVectorLayer</tt> или <tt>QgsRasterLayer</tt>, подробнее об этом можно прочесть в [http://gis-lab.info/qa/qgis-standalone предыдущей статье].

Вместе в легендой поставляется простой диалог свойств слоя. Чтобы им можно было пользоваться, необходимо скомпилировать файл <tt>dlgLayerProperties.ui</tt>

<pre>pyuic4 dlgLayerProperties.ui -o dlgLayerProperties_ui.py</pre>

Диалог позволяет задать имя слоя, изменить отображаемое поле и настраивать видимость в пределах масштаба. Если этого функционала не достаточно, можно, взяв за основу существующий диалог, разработать свой вариант.

[[Файл:qgis-legend-02.png|center]]

При смене активного слоя виджет легенды испускает сигнал <tt>activeLayerChanged</tt>, который можно использовать для активации/деактивации определенных инструментов приложения, например, в зависимости от типа слоя (растр или вектор). Для этого необходимо в главном классе приложения связать сигнал со слотом, который и будет отвечать за активацию/деактивацию инструментов или выполнять какие-то другие действия. Например, так

<syntaxhighlight lang="python">
self.connect( self.legend, SIGNAL( "activeLayerChanged" ), self.enableTools )

def enableTools( self ):
  if not self.legend.activeLayer():
    # нет активного слоя, деактивируем инструменты общего назначения
  else:
    # делаем инструменты общего назначения доступными

    layerType = self.legend.activeLayer().layer().type()
    if layerType == 0: # Vector Layer
      # активируем инструменты для работы с вектором и деактивируем остальные
    elif layerType == 1: # Raster Layer
      # активируем инструменты для работы с растром и деактивируем остальные
</syntaxhighlight>

Также виджет предоставляет несколько полезных методов, с помощью которых можно

* перебрать все слои
<syntaxhighlight lang="python">
for layer in self.legend.layers:
  # сделать что-то со слоем
</syntaxhighlight>

* скрыть или отобразить все слои
<syntaxhighlight lang="python">
def showAllLayers( self ):
  self.legend.setStatusForAllLayers( True )
</syntaxhighlight>

* получить активный слой <syntaxhighlight lang="python">return self.legend.activeLayer()</syntaxhighlight>

* обновить символику слоя <syntaxhighlight lang="python">self.legend.refreshLayerSymbology( layer )</syntaxhighlight>

* удалить слои по идентификаторам <syntaxhighlight lang="python">self.legend.removeLayers( layerIds )</syntaxhighlight>

Разумеется, это далеко не полный список методов рассматриваемого виджета. Более полное представление о его возможностях можно получить заглянув в файл <tt>legend.py</tt>, код достаточно прозрачный и снабжен комментариями, так что разобраться в нем не составит труда.

На этом знакомство с виджетом легенды будем считать оконченным. Многое осталось за бортом: например, не были затронуты вопросы настройки символики, расширения диалогового окна свойств слоя, взаимодействие легенды и инструментов карты... Возможно, если тема окажется интересной, статья получит продолжение.

Исходные коды примера, а так же все необходимые изображения и тестовый набор данных можно скачать [http://gis-lab.info/other/qgis-legend.7z одним файлом].

Необходимо отметить, что существует еще один вариант легенды, созданный Aaron Racicot для проекта [http://svn.infodrizzle.org/openocean/trunk/openoceanmap/Tools/legend.py OpenOceanMap] и основанный на элементе управления QCheckBox, а не на [http://doc.qt.nokia.com/4.6/qtreewidget.html QTreeWidget].

=== Ссылки по теме ===

* [http://gis-lab.info/qa/qgis-standalone.html Создание приложения на базе набора библиотек QGIS на Python]
* [http://geotux.tuxfamily.org/index.php?option=com_myblog&task=view&id=270&Itemid=59&lang=en Layer list widget for PyQGIS applications]
* [http://gis-lab.info/docs/qgis/ Документация по QGIS]