Plugins for OpenLAyeRs is based on the masterportalAPI and OpenLayers.

POLAR is ...

• ... a configurable map client package.
• ... a flexible map client factory.
• ... an extensible library.

Quick Start

Usage without NPM is documented here.

Installation (via NPM)

npm i @polar/client-generic

Embedding POLAR

.js

import polar from '@polar/client-generic'

polar.createMap({
  // a div must have this id
  containerId: 'polarstern',
  // any service register – this is Hamburg's
  services: 'https://geodienste.hamburg.de/services-internet.json',
  mapConfiguration: {
    // this initially shows Hamburg's city plan
    layers: [{
      id: '453',
      visibility: true,
      type: 'background',
    }]
  }
})

.html

<div
  style="width: 680px; height: 420px; position: relative;"
  id="polarstern"
/>

See our documentation page for all features and configuration options included in this modulith client, with running examples.

Example clients

The most common use case for this client is in citizen's application processes regarding public service.

Other clients with more specific code 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.

Backers and users

States of Germany

Freie Hansestadt Bremen	Freie und Hansestadt Hamburg
Sachsen-Anhalt	Schleswig-Holstein

Government agencies

• Senatskanzlei Hamburg
• Landesamt für Denkmalpflege Schleswig-Holstein
• Dataport AöR

Technical concepts

Reusability and adaptability

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 and fill in the missing parts.

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.

Plugin-based approach

To see our plugins in action, please visit our documentation page to see running examples. Plugins are designed to be configurable, optional, and replacable.

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 and client.
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.
Filter	Allows users to filter vector layers to content relevant to their interests.
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. Can be used as feature list viewer for vector layers.
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.

Getting started (for developers)

For a detailed step-by-step guide, please refer to our comprehensive Getting Started guide.

Stay In Touch

• Contact us via email 📧

made by Dataport with ❤️