The Plugins for OpenLAyeRs library is based on the masterportalAPI and OpenLayers.
POLAR is built to ease the creation of new map clients: A lot of feature requests in map clients are recurring and can be fulfilled with reusable parts. Then again, many map clients require a little extra.
POLAR is built to serve both worlds. For generic use cases, generic clients are ready-made and usable by configuration. More specific use cases can be matched with special clients that still make use of the plugins, but fill in the missing parts right where they belong.
POLAR runs both as full page application and as component. The most common usage is as component: Think of it as a form input where the input data is geospatial.
The most common use case for this client is in citizen's application processes regarding public service.
Other clients with more specific code (and more visibility) include the Denkmalkarte Schleswig-Holstein, a memorial map, and the Meldemichel Hamburg, a map to inspect and create reports regarding damages to public infrastructure. The latter is currently being migrated to the version seen in this repository.
| Name | Details |
|---|---|
| AddressSearch | Offers a search field and standard search service implementations with API for your own configurable custom search services. For already usable search services, see the documentation of the package. Integration with Reverse Geocoder and Pins possible, or usable as a data source for further processing. |
| Attributions | Shows layer copyright information of visible layers. |
| Draw | Allows the user to draw various geometries onto the map. The resulting GeoJSON can be forwarded to later processing steps, or be used by the Export plugin to generate screenshots. |
| Export | Offers screenshot functionality for the user or further processing. |
| Fullscreen | User can toggle between integrated and fullscreen view with this plugin. |
| GeoLocation | Geolocalizes the user either on user demand or as a background procedure. An icon is shown on the user position on the map. |
| Gfi | Short for "Get Feature Information". Retrieves feature information from a WMS or WFS layer for display or usage by further processing steps. |
| IconMenu | Handles display of visible plugin buttons. Only relevant for programming clients, no direct user feature. |
| LayerChooser | Allows choosing a background layer and an arbitrary amount of feature or overlay layers. WMS layers can optionally be filtered by sub-layers by the user. |
| Legend | Displays an overview of layer legend images as delivered by the used WMS services. Images can be clicked for large view. |
| LoadingIndicator | Loading spinner. Only relevant for programming clients, no direct user feature. |
| Pins | Pin feature that allows users to set and move pins to indicate a position. Integration with AddressSearch and ReverseGeocoder configurable. |
| ReverseGeocoder | Configurable to translate an arbitrary coordinate to an address. Integration with AddressSearch and Pins configurable. |
| Scale | Shows current scale as ratio and size indicator. |
| Toast | Shows information to the user. Configurable in many plugins to communicate status updates or procedural advice. |
| Zoom | Allows zooming in and out of the client with buttons. |
Select a client from our releases. For a generic client, use @polar/client-afm. The zipped client is downloadable and attached as an asset to the release.
The package contains example files that illustrate how the client can be used. You may also inspect the example usage here.
To adapt the client to your use case, change the included polar-example.js file, and replace the object used in the .createMap call with your configuration. To learn more about configuration options, read the AfM documentation, or the documentation of the client you chose.
Clone the repository and run npm install && npm run snowbox. This winds up our development client in a minimal test environment as a starting point.
If you aim to create an additional plugin, you may now create and install it to the snowbox during development. To create a new client, it is advised to create a copy of the AfM client as a base project and adjust it to your needs.
We're production-ready. After a history as Inner Source software, we are now gradually switching to being Open Source software.
| Topic | Description | Status |
|---|---|---|
| Re-release | Offer all packages as 1.0.0 on the NPM registry and as GitHub releases. Previous inner source version history and changelogs are reset. | ✔️ |
| GitHub Actions | ✔️ | |
| GitHub Page | ✔️ | |
| Getting started | A short introduction is available above. We will expand upon this after the following task. | 🏗️ |
| Working outside the repository | Clients can be used anywhere, but their development requires further setup. Right now, clients should be developed in this repository or in a fork. | ⌛ |
| OSS Best Practices | Contributions, Issues, Discussions, The Wiki – there's a lot to fill out and define. | ⌛ |
made by Dataport with ❤️