Skip to content
QGIS SDK

qgis-sdk TypeScript package guide

The reference for @archont561/qgis-sdk, the page side of a plugin’s web view: the transport client, the host namespaces, the generated schema module and QgisSdk, the framework-free stores with their React, Vue and Svelte bindings, the @archont561/qgis-sdk-ui components and the scripted test host. The documentation site at archont561.github.io/qgis-sdk renders it one page per section. Status at the time of writing: 0.5.0 is the released version (ts-v0.5.0, tagged with python-v0.7.0 and ui-v0.1.0 on one merge commit as the 0.7.0 triple; packages version independently, decision-25); it carries the framework-free stores with the ./vue and ./svelte adapters and algorithms.run, described below and in the 0.5.0 migration notes; 0.4.0 brought the root entry and the QgisSdk entry point. 0.3.0 was the first version under this name. Through 0.2.0 the package was published as @archont561/qgis-sdk-bridge; it is @archont561/qgis-sdk from 0.3.0 on (decision-33). Migration notes are at the end of this guide.

The Python half of every surface here is in doc-12.

Sections

Section titled “Sections”