Lizmap JavaScript scripts

You can use those JavaScript scripts to enhance Lizmap Web Client. Documentation about additional JavaScript is on docs.lizmap.com and the autogenerated documentation is on docs.3liz.org

You might have a README.md inside the directory with more information and a demo.

Some JavaScript codes presented are self-sufficient while others are examples to help you create the functionality you want.

If you are developing a new feature, do not hesitate to let us know so that we can integrate it.

Important note about versions, contributions and maintainability

The main goal of this repository is to store Javascript snippets related to Lizmap Web Client.

These scripts are not linked to a specific version of Lizmap and might be added by an external contributor. It might be designed for a special need of a project or a customer.

The API on Lizmap Web Client is not guaranteed across versions. So the compatibility with Lizmap Web Client is not guaranteed as well on this repository. They aren't any tests suite done on these snippets to avoid regression.

Each JavaScript file is naming following the pattern custom_feature_X.Y.js where X.Y is targeting the LWC version when the script was written.

Scripts

API

• Connecteur vers Oxalis d'Operis (Autorisations du droit des sols (ADS)) 🇫🇷
• IGN web services 🇫🇷
• Google Street View
• Mapillary
• GeoFoncier Popup🇫🇷

Data

• Edit GPX Import/Export GPX
• WMTS direct access

Miscellaneous

• Open external links with map click coordinates
• Add keyboard shortcuts
• Refresh some layers periodically

Translation

• Translate the QGIS project To provide a Lizmap project in many languages
• Change some labels in the interface

Tools

• Attribute table column filter
• Dynamic form field visibility
• Group time tool, Display a temporal layers' group as a GIF and generate it
• Point buffer on map Display a buffer on the map
• Simple filter
• Smart filter
• Display statistics on the current layer selection
• Selection from a popup feature geometry
• Deprecated since LWC 3.6
  • Zoom to feature at startup and show popup, now use the native permalink
• Deprecated since LWC 3.4
  • Multiple atlas, included by default in the plugin now
  • Snapping while editing, included by default in the plugin now

UI

• Add documentation with buttons and a dock
• Display a right-docked table of data
• Background selector, like on Google Maps
• Hide value popup
• Measure tool custom style
• Move filter in new panel
• Popup when opening the project with metadata information
• Interactive guided tour
• Remove button to make the UI lighter and easier
• Resize Dock with splitter
• Resize Dock with splitter 2 (interact.js)
• Simplify export options
• Export attribute table to CSV
• Add button to toggle dock full width
• Add a hard-coded legend at the bottom of the map
• Show a global legend image for all visible layers
• Add placeholder to input/textarea elements
• Permalink copy to clipboard instead of link
• Move Layers button after Information
• Activate geolocation at startup
• Deprecated since LWC 3.7
  • Group collapse, use a QGIS theme and the checkbox at the "Layers" tab in the plugin
  • Expand/collapse legend when layer toggled, use a QGIS theme and the checkbox at the "Layers" tab in the plugin
  • Expand legend on load, use a QGIS theme and the checkbox at the "Layers" tab in the plugin
  • Simplify print options, use the "Layouts" panel in the plugin
• Deprecated since LWC 3.4
  • Add hamburger menu for a better UX on a small screen. The menu is now added automatically on smaller screen