qgis-js v0.0.5

qgis-js

QGIS core ported to WebAssembly to run it on the web platform

Version: 0.0.5 (based on QGIS 3.32.1)

qgis-js Repository | qgis-js Website | "qgis-js" package source

⚠️🧪 Work in progress! Currently this project is in public beta

Description

QGIS core compiled to WebAssembly to run it on the web platform. This package provides the WebAssembly module and JavaScript/TypeScript API to load the runtime and interact with QGIS.

See the qgis-js repository for more information about the project.

Installation

npm install -S qgis-js

Usage

import { qgis } from "qgis-js";

const { api } = await qgis();

const rect = new api.Rectangle(1, 2, 3, 4);
rect.scale(5);
const center = rect.center();
console.log(center.x, center.y);

💡 Have a look at the Integration packages to load QGIS projects and display them on a map

⚠️ It must be ensured that...

• the clients meets the compatibility requirements
• that the webserver is configured to allow cross-origin requests
• that if you are using a bundler, it is configured to load the qgis-js assets

Integration packages

Package	Description	npm
@qgis-js/ol	OpenLayers sources to display qgis-js maps
@qgis-js/utils	Utilities to integrate qgis-js into web applications

WebAssembly module

Size

The size of the package is 54.2 MB (uncompressed) or 14.57 MB Brotli compressed (73% space saving) / 16.88 MB Gzip compressed (69% space saving)

It consists of the following files:

Libraries

Versioning

This package uses SemVer for versioning. For the versions available, see the tags on this repository.

License

GNU General Public License v2.0