Plugins

提供: OSGeo.JP Wiki
移動: 案内検索

QGIS プラグイン

QGIS は、プラグインが使えるように設計されています。 これにより、新規の機能をアプリケーションに簡単に追加することができます。 QGISの多くの機能は、実際のところコアあるいは外部プラグインとして実装されています。

  • コアプラグインは、 QGIS 開発チームによってメンテナンスされ、 QGIS 配布時に自動的に含まれます。 これは、 C++ と Python の二つの言語のいずれかで書かれています。 詳細は、セクションsec:core_pluginsにあります。
  • 外部プラグインは、現在のところすべて Python で書かれています。 外部プラグインは、外部のレポジトリに保存されており、各製作者によってメンテナンスされています。 外部プラグインは、Plugin Installer を使うことで QGIS に追加することができます。 詳細は、セクションsec:external_pluginsにあります。

プラグインの管理

プラグインの管理とは、通常、Plugin Manager を使ったロードとアンロードのことを指します。 外部プラグインを使うためには、最初に Plugin Installer が必要となります。

QGIS コアプラグインをロード

QGIS コアプラグインのロードは、メインメニューの Plugins > MActionShowPluginManager.png Manage Plugins... から行うことができます。

図 40: Plugin Manager Nix.png
Pluginmanager.png

Plugin Manager は、 すべてのコアプラグインと Plugin Installer (セクション sec:external_plugins を参照) からインストールされたすべての外部プラグインに関して、 使用可能なプラグインと、その状態 (loaded または unloaded) を、 既にロードされているプラグインには名称の左にチェックマークがつくように、表示します。 図 40 はプラグインマネージャーのダイアログです。

プラグインを使用するには、プラグイン名の左にあるチェックボックスをクリックし、 OK をクリックします。 アプリケーションを終了する際、ロードしたプラグインの一覧が保存され、 次回 QGIS を起動する際に、プラグインが自動的にロードされます。


Tip 41 Crashing Plugins


If you find that QGIS crashes on startup, a plugin may be at fault. You can stop all plugins from loading by editing your stored settings file (see subsec:gui_options for location). Locate the plugins settings and change all the plugin values to false to prevent them from loading. Nix.png For example, to prevent the Delimited text plugin from loading, the entry in $HOME/.config/QuantumGIS/qgis.conf on Linux should look like this:Add Delimited Text Layer=false. Do this for each plugin in the [Plugins] section. You can then start QGIS and add the plugins one at a time from the Plugin Manager to determine which plugin is causing the problem.



Loading an external QGIS Plugin

There are two steps required to integrate external plugins into QGIS:

  1. Download an external plugin from a repository using the Plugin Installer (Section 11.1.3). The new external plugin will be added to the list of available plugins in the Plugin Manager.
  2. Load the plugin using the Plugin Manager.

Using the QGIS Python Plugin Installer

図 41: Installing external python plugins Nix.png

Plugininstaller.png

In order to download and install an external Python plugin, click the menu Plugins > Plugin installer.png Fetch Python Plugins.... The Plugin Installer window will appear (figure 41) with the tab Plugins, containing a list of all locally installed Python plugins, as well as plugins available in remote repositories. Each plugin can be either:

  • not installed - this means the plugin is available in the repository, but is not installed yet. In order to install it, select the plugin from the list and click the Install plugin button.
  • new - this means that the plugin is newly available in the repository.
  • installed - this indicates that the plugin is already installed. If it is also available in any repository the Reinstall plugin button will be enabled. If the available version is older than the installed version, the Downgrade plugin button will appear instead.
  • upgradeable - this means that the plugin is installed, but there is an updated version available. In this case, the Upgrade plugin button will be enabled.
  • invalid - this means that the plugin is installed, but is unavailable or broken. The reason will be explained in the plugin description field.
Plugins tab

To install a plugin, select it from the list and click the Install plugin button. The plugin is installed in its own directory.

  • Nix.png Linux and other unices:
    ./share/qgis/python/plugins
    /home/$USERNAME/.qgis/python/plugins
  • Osx.png Mac OS X:
    ./Contents/MacOS/share/qgis/python/plugins
    /Users/$USERNAME/.qgis/python/plugins
  • Win.png Windows:
    C:\Program Files\QGIS\python\plugins
    C:\Documents and Settings\$USERNAME\.qgis\python\plugins

If the installation is successful, a confirmation message will appear telling you to go to Plugins > MActionShowPluginManager.png Manage Plugins... to load the newly installed plugin.

If the installation fails, the reason for the failure will be displayed in a warning dialog. Most often, errors are the result of connection problems and/or missing Python modules. In the former case you will likely need to wait before trying the install again, in the latter case, you should install the missing modules relevant to your operating system prior to using the plugin. Nix.png For Linux, most required modules should be available via a package manager. Win.png For install instructions in Windows visit the module home page. If you are using a proxy, you may need to configure it under Edit > MActionOptions.png Options (Gnome, OSX) or Settings > MActionOptions.png Options (KDE, Windows) on the Proxy tab.

The Uninstall plugin button is enabled only if the selected plugin is installed and is not a core plugin. Note that if you have installed an update to a core plugin, you can uninstall this update with the Uninstall plugin and revert to the version shipped with Quantum GIS. This default version however, cannot be uninstalled.

Repositories tab

The second tab Repositories, contains a list of plugin repositories available for the Plugin Installer. By default, only the QGIS Official Repository is enabled. You can add several user-contributed repositories, including the central QGIS Contributed Repository and other external repositories by clicking the Add 3rd party repositories button. The added repositories contain a large number of useful plugins which are not maintained by the QGIS Development Team. As such, we cannot take any responsibility for them. You can also manage the repository list manually, that is add, remove, and edit the entries. Temporarily disabling a particular repository is possible by clicking the Edit... button.

Options tab

The Options tab is where you can configure the settings of the Plugin Installer. The CheckBox.pngCheck for updates on startup checkbox tells QGIS to automatically look for plugin updates and news. By default, if this feature is enabled all repositories listed and enabled in the Repositories tab are checked for updates each time the program is started. The frequency of update checking can be adjusted using the dropdown menu, and may be adjusted from once a day right up to once a month. If a new plugin or update is available for one of the installed plugins, a notification will appear in the Status Bar. If the checkbox is disabled, looking for updates and news is performed only when the Plugin Installer is manually launched from the menu.

Some internet connections will cause problems when attempting to automatically check for updates. In these cases, a Looking for new plugins... indicator will remain visible in the Status Bar during your entire QGIS session, and may cause a program crash when exiting. In this case please disable the checkbox.

In addition, you may specify the type of plugins that are displayed by the Plugin Installer. Under Allowed plugins, you can specify whether you would like to:

  • Only show plugins from the official repository
  • Show all plugins except those marked as experimental,
  • or Show all plugins, even those marked as experimental.

Tip 42 Using experimental plugins


Experimental plugins are generally unsuitable for production use. These plugins are in the early stages of development, and should be considered 'incomplete' or 'proof of concept' tools. The QGIS development team does not recommend installing these plugins unless you intend to use them for testing purposes.



データプロバイダ

Data Providers are "special" plugins that provides access to a data store. By default, QGIS supports PostGIS layers and disk-based data stores supported by the GDAL/OGR library (Appendix appdx_ogr). A Data Provider plugin extends the ability of QGIS to use other data sources.

Data Provider plugins are registered automatically by QGIS at startup. They are not managed by the Plugin Manager but used behind the scenes when a data type is added as a layer in QGIS.