Skip to content

Latest commit

 

History

History
45 lines (24 loc) · 2 KB

README.md

File metadata and controls

45 lines (24 loc) · 2 KB

@qgis-js/ol

OpenLayers sources for qgis-js

qgis-js Repository | qgis-js Website | "@qgis-js/ol" package source

@qgis-js/ol on npm

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

Prerequisites

  • This package requires OpenLayers >=8 to be installed as a peer dependency

  • The qgis-js package is also required as a direct dependency of this package

    • An instance of the qgis-js runtime has to be created at runtime and its API must be passed to the OpenLayers source constructor

Installation

npm install -S @qgis-js/ol

Usage

QgisCanvasDataSource

OpenLayers source for rendering a single tile with the size and pixel ratio of the ol map canvas. This is useful for rendering in the projection of the QGIS project, both in the OpenLayers view and in the qgis-js runtime.

See QgisCanvasDataSource.ts for the implementation.

QgisXYZDataSource

OpenLayers source to render a QGIS project in the common Web Mercator projection (EPSG:3857) addressed with the xyz tile scheme. This makes it convenient to mix the QGIS layer with other layer sources provided by OpenLayers.

See QgisXYZDataSource.ts for the implementation.

Versioning

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

License

GNU General Public License v2.0