POLAR client DiPlanKarten

This document describes the @polar/client-diplan-specific configuration options.

For our example clients, see here.

Configuration

DiPlan-specific configuration parameters belong within the mapConfiguration object and are registered to the key diplan.

diplan

diplan.link

{
  mapConfiguration: {
    diplan: {
      link: {
        href: 'https://example.com',
        icon: '$vuetify.icons.fullscreen-exit'
      }
    }
  }
}

diplan.metaService

From all geometries of the service intersecting our geometries, properties are aggregated.

Example: Our drawing feature touches these features in the layer with id "metaSourceExampleId":

{
  "type": "Feature",
  "geometry": "...",
  "properties": { "a": 0, "b": 0 }
},
{
  "type": "Feature",
  "geometry": "...",
  "properties": { "a": 0, "b": 1 }
},
{
  "type": "Feature",
  "geometry": "...",
  "properties": { "a": 0, "b": 1 }
},
{
  "type": "Feature",
  "geometry": "...",
  "properties": { "a": 1, "b": 1 }
}

The feature will then have the following properties:

In mode 'unequal':

{
  "type": "Feature",
  "geometry": "...",
  "properties": {
    "metaProperties": {
      "metaSourceExampleId": [
        { "a": 0, "b": 0 },
        { "a": 0, "b": 1 },
        { "a": 1, "b": 1 }
      ]
    }
  }
}

In mode 'all':

{
  "type": "Feature",
  "geometry": "...",
  "properties": {
    "metaProperties": {
      "metaSourceExampleId": [
        { "a": 0, "b": 0 },
        { "a": 0, "b": 1 },
        { "a": 0, "b": 1 },
        { "a": 1, "b": 1 }
      ]
    }
  }
}

Usage of secured services

To be able to use secured services, the map client has to receive an OIDC token from the integrating application. This can be done with the mutation setOidcToken. The mutation has to be called whenever the token has been refreshed so that the map client always has a valid token.

mapInstance.$store.commit('setOidcToken', 'base64encodedOIDCtoken')

If, however, a secured layer is supposed to be visible on start, the token also has to be provided via the configuration parameter oidcToken.

Store

Getters

⚠️ Caveat: Please mind that there is currently no merge-logic for properties of features given via using the action 'plugin/draw/addFeatures' of @polar/plugin-draw. If mergeToMultiGeometries is set true, an arbitrary set of properties will survive. If metaServices are set, properties.metaProperties will be overridden if they previously existed. It is assumed that incoming data shall only be recognized regarding its geometry and holds no properties.

mapInstance.$store.watch(
  (_, getters) => getters['diplan/revisedDrawExport'],
  (geoJsonFeatureCollection) => {
    /* This code is called on value updates. */
  }
)

Rerender hints

In some SPA applications, the map client may produce unexpected behaviour on rerenders. Should this still occur in 1.0.0-beta.1 or later, please try these methods:

• Use mapInstance.$destroy() in your framework's lifecycle's unmount method before new createMap calls.
• In general, your calls to our watch or subscribe methods should also be cleaned up to avoid leaks. These methods return unwatch or unsubscribe methods respectively, and can be called on any cleanup.
• Most frameworks will handle DOM regeneration on rerenders themselves. Should you need to clean up the DOM for arbitrary reasons yourself, this snippet may come in handy:

    const polarstern = document.getElementById('polarstern-wrapper')
    const stellamaris = document.createElement('div')
    stellamaris.id = 'polarstern'
    polarstern?.parentElement?.replaceChild(stellamaris, polarstern)
  

Child documents

Locales