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'
      }
    }
  }
}

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.

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