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:

| File name | Size (uncompressed) | Size (Brotli compressed) | Size (Gzip compressed) | | -------------------------- | ------------------- | ----------------------------- | ----------------------------- | | qgis.js | 5.93 kB | 2.12 kB (64% space saving) | 2.22 kB (62% space saving) | | assets/wasm/qgis-js.js | 315.36 kB | 69.97 kB (78% space saving) | 74.38 kB (76% space saving) | | assets/wasm/qgis-js.data | 11.09 MB | 1.75 MB (84% space saving) | 2.28 MB (79% space saving) | | assets/wasm/qgis-js.wasm | 42.8 MB | 12.75 MB (70% space saving) | 14.53 MB (66% space saving) |

Libraries

| Library | License | Links | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------- | | double-conversion (3.3.0)Efficient binary-decimal and decimal-binary conversion routines for IEEE doubles. | | Website - Source code | | egl-registry (2022-09-20)the EGL API and Extension Registry | | Website - Source code | | exiv2 (0.28.1)Image metadata library and tools | GPL-2.0-or-later | Website - Source code | | expat (2.6.0)XML parser library written in C | MIT | Website - Source code | | freetype (2.13.2)A library to render fonts. | FTL OR GPL-2.0-or-later | Website - Source code | | gdal (3.7.1)The Geographic Data Abstraction Library for reading and writing geospatial raster and vector data | | Website - Source code | | geos (3.11.3)Geometry Engine Open Source | LGPL-2.1-only | Website | | gumbo (0.10.1)An HTML5 parsing library in pure C99 | Apache-2.0 | Website - Source code | | inih (57)Simple .INI file parser | BSD-3-Clause | Website - Source code | | json-c (2023-08-12)A JSON implementation in C | MIT | Website - Source code | | libgeotiff (1.7.1)Libgeotiff is an open source library on top of libtiff for reading and writing GeoTIFF information tags. | MIT | Website - Source code | | libiconv (1.17)GNU Unicode text conversion | | Website | | libjpeg-turbo (3.0.2)libjpeg-turbo is a JPEG image codec that uses SIMD instructions (MMX, SSE2, NEON, AltiVec) to accelerate baseline JPEG compression and decompression on x86, x86-64, ARM, and PowerPC systems. | BSD-3-Clause | Website - Source code | | liblzma (5.4.4)Compression library with an API similar to that of zlib. | | Website - Source code | | libpng (1.6.40)libpng is a library implementing an interface for reading and writing PNG (Portable Network Graphics) format files | libpng-2.0 | Website - Source code | | libspatialindex (1.9.3)C++ implementation of R*-tree, an MVR-tree and a TPR-tree with C API. | MIT | Website - Source code | | libzip (1.10.1)A library for reading, creating, and modifying zip archives. | BSD-3-Clause | Website - Source code | | litehtml (0.6.0)litehtml is the lightweight HTML rendering engine with CSS2/CSS3 support. | BSD-3-Clause | Website - Source code | | nlohmann-json (3.11.3)JSON for Modern C++ | MIT | Website - Source code | | opengl-registry (2022-09-29)the API and Extension registries for the OpenGL family APIs | | Website - Source code | | opengl (2022-12-04)Open Graphics Library (OpenGL)[3][4][5] is a cross-language, cross-platform application programming interface (API) for rendering 2D and 3D vector graphics. | | | | pcre2 (10.42)Regular Expression pattern matching using the same syntax and semantics as Perl 5. | BSD-3-Clause | Website - Source code | | proj (9.3.1)PROJ library for cartographic projections | MIT | Website - Source code | | protobuf (3.21.12)Protocol Buffers - Google's data interchange format | BSD-3-Clause | Website - Source code | | qca (2.3.7)Qt Cryptographic Architecture (QCA). | | Website - Source code | | qgis (3.32.1)QGIS is a free, open source, cross platform (lin/win/mac) geographical information system (GIS) | GPL-2.0 | Website - Source code | | qt5compat (6.6.1)The module contains unsupported Qt 5 APIs | | Website | | qtbase (6.6.1)Qt Application Framework Base Module. Includes Core, GUI, Widgets, Networking, SQL, Concurrent and other essential qt components. | | Website | | qtkeychain (0.14.0)(Unaffiliated with Qt) Platform-independent Qt5 API for storing passwords securely | BSD-3-Clause | Website - Source code | | qtsvg (6.6.1)Qt SVG | | Website | | qttools (6.6.1)Qt Tools | | Website | | sqlite3 (3.45.0)SQLite is a software library that implements a self-contained, serverless, zero-configuration, transactional SQL database engine. | blessing | Website | | tiff (4.6.0)A library that supports the manipulation of TIFF image files | libtiff | Website - Source code | | zlib (1.3.1)A compression library | Zlib | Website - Source code |

Versioning

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

License

GNU General Public License v2.0