Skip to content

Latest commit

 

History

History
226 lines (211 loc) · 9.75 KB

README.md

File metadata and controls

226 lines (211 loc) · 9.75 KB
Raw

GitHub version Build Status Coverage Status Join the chat at https://gitter.im/tomchadwin/qgis2web Donate to QGIS

qgis2web

QGIS plugin to export your project to an OpenLayers or Leaflet webmap. No server-side software required.

Installation

  • In QGIS, select Plugins > Manage and Install Plugins...

or:

  • Download and unzip to your QGIS plugins directory

Usage

Prepare your map as far as possible in QGIS, as you want it to appear in your webmap. Specific tasks you can carry out to improve your webmap include:

  • Set your project title, and background and highlight colours in Project > Project Properties...
  • Give your layers human-friendly names in the Layers Panel
  • Give your layer columns human friendly names via Layer > Properties > Fields > Alias
  • Hide the columns you don't want to appear in your popups by changing their Edit widget to "Hidden"
  • If any of your fields contain image filenames, change their Edit widget to "Photo" to have the images appear in popups
  • Style your layers, and set their scale-dependent visibility, if required

Run qgis2web from the Web menu, or via its icon. If required, choose a basemap from the list below the preview pane, and click "Update preview". CTRL/CMD-click for multiple basemaps or to deselect a basemap.

The top-left pane lets you set options for each layer in your map. The bottom-left pane sets overall options for your project. All options are written to your QGIS project, so save your project if you want to keep these settings.

Current limitations

QGIS, OpenLayers, and Leaflet are all different mapping technologies. This means that their respective functionality differs in many ways. qgis2web does its best to interpret a QGIS project and to export HTML, Javascript, and CSS to create a web map as close to the QGIS project as possible.

However, many elements of a QGIS project cannot be reproduced, and many are only possible in either OpenLayers or Leaflet. qgis2web tries its best to produce a publish-ready map, but you can always manually edit the output code to achieve what qgis2web cannot.

  • in OL3 maps, only single rendered points cluster, not categorized or graduated
  • line style (dashed/dotted) does not appear in OL3 preview, but works in export
  • only a single 2.5d layer will render per map
  • 2.5d layers only appear when zoomed in to building scales
  • attribute filters and abstract export only works in leaflet based webmaps

Layer options

Popup fields
Specify how each field will be labelled in popups
Popups
Specify, whether or not a layer shows a popup on a click. If not, the layer is not even clickable
Visible
Select whether the layer will be visible on map load. This only determines visibility - the layer will be loaded regardless of this setting
Encode to JSON
If unchecked, WFS layers will remain remote WFS layers in the webmap. If checked, the layer will be written to a local GeoJSON file
Cluster
Cluster point features

General options

Data export

Export folder
The folder where the webmap will be saved
Mapping library location
Select whether to use a local copy of OL3/Leaflet, or whether to call the library from its CDN
Minify GeoJSON files
Remove unnecessary whitespace from exported GeoJSON to reduce file size
Precision
Simplify geometry to reduce file size

Scale/Zoom

Extent
Either match the current QGIS view or show all contents of all layers (only local GeoJSON and rasters, not WFS/WMS)
Max zoom level
How far the webmap will zoom in
Min zoom level
How far the webmap will zoom out
Restrict to extent
Prevent panning or zooming beyond the selected extent

Appearance

Add abstract
This will push the abtract from the projects metadata (field abstract) into the webmap as a collapsible info box. Supported in leaflet only
Add address search
Add field to allow searching for locations (geocode)
Add layers list
Include list of layers (with legend icons, where possible)
Add measure tool
Include interactive measuring widget
Attribute filter
Every supported field of all layers are listed as well as the type and layers they occur in. Selected attributes will be used to filter the webmap and all layers that contain the attribute with the same name.
Geolocate user
Show user's location on map
Highlight on hover
Highlight features on mouseover
Layer search
Add option to search for values in layer field values
Match project CRS
Create webmap in same projection as QGIS project, otherwise the webmap is projected in EPSG:3857
Show popups on hover
Show popups when mouse hovers over features
Template
Select HTML template for webmap - add your own templates to the /qgis2web/templates directory in your current QGIS3 profile folder

Reporting bugs

Please report any problems you have with qgis2web. Without this feedback, I am often completely unaware that a problem exists. To ensure no time or effort is wasted in bug reporting, please follow these steps:

  1. Make sure you are using the latest release of qgis2web
  2. Check the issues on Github to see whether the bug has already been reported, and if so, read through all the comments on the issue, and add any additional information from your experience of the bug
  3. Make sure you can reproduce the bug reliably
  4. Reduce the complexity of your bug conditions as far as you can, especially by reducing the number of layers, ideally to one
  5. Raise a Github issue, including:
    • only one bug per Github issue
    • the qgis2web version (or make it clear you are using Github master branch)
    • any Python error text/stack trace which occurs
    • browser JS console errors - press F12 in qgis2web to open the developer toolbar and find the console
    • screenshot of your settings
    • screenshot of the output
    • a link to the data you used, if possible

The stability of qgis2web relies on your bug reports, so please keep them coming.

Credits

qgis2web is fundamentally a merge of Victor Olaya's qgis-ol3 and Riccardo Klinger's qgis2leaf. It would not exist without their work. Thank you, gentlemen. Thanks are also very much due to Paolo Cavallini, who suggested and supported the merge.

  • @volaya
  • @riccardoklinger
  • @pcav

Obviously, qgis2web could not exist without the following monumental software:

  • QGIS
  • OpenLayers
  • Leaflet

Thanks are also due for major code contributions to:

  • @akbargumbira
  • @lucacasagrande
  • @walkermatt
  • @boesiii
  • @ThomasG77
  • @NathanW2
  • @nyalldawson (FTP export for Faunalia/ENEL)
  • @perliedman
  • @olakov

In addition, the following libraries have been used:

  • ol3-layerswitcher, by @walkermatt
  • Autolinker.js, by @gregjacobs
  • requestAnimationFrame polyfill, by @paulirish
  • Function.prototype.bind polyfill, by @mozilla
  • Leaflet.label, by @jacobtoye
  • Leaflet.Locate, by @domoritz
  • Leaflet.markercluster, by @danzel
  • leaflet-measure, by @ljagis
  • leaflet-hash, by @mlevans
  • Proj4js, by @madair, @calvinmetcalf, and other
  • Proj4Leaflet, by @kartena
  • Leaflet.search, by @stefanocudini
  • ol3-search-layer, by @ThomasG77
  • Leaflet.heat, by @mourner
  • OSMBuildings, by @kekscom
  • multi-style-layer, by @perliedman
  • Leaflet.SvgShapeMarkers, by @rowanwins
  • rbush, by @mourner
  • Labelgun, by @JamesMilnerUK
  • Leaflet.pattern, by @teastman
  • Leaflet.VectorGrid, by @IvanSanchez

Greenkeeper badge