Dynamic Layer - Configuration

The Dynamic Layer plugin enables users to dynamically add layers to a map without editing the configuration. This guide provides detailed information about available configuration options for both dynamic web data sources and catalogue integrations.

The plugin configuration consists of several main sections that control the available tabs, default settings, and preset configurations:

General Settings

Table 1. Primary Configuration Options
Option Description Default Allowed Values

Enabled tabs

Enabled tabs in the plugin interface

['webdata', 'catalogues']

webdata, catalogues

Default tab

The default tab opened when the plugin is launched

'webdata'

webdata, catalogues

Tab Configuration
  • Enable only the tabs that are relevant for the intended users

  • Set the default tab to the most frequently used functionality

  • Consider workflow patterns when deciding which tab should open by default

Web Data

The web data section configures default settings for adding dynamic web data sources to the map.

Table 2. Web Data Configuration Options
Option Description Default Allowed Values

Default type

The preselected web data source type

Web Map Service (WMS)

See Supported Web Data Types

Default URL

Pre-filled URL for adding source web data

' '

Any valid URL

Web Data Sources

When configuring web data defaults:

  • Set Default type to the most commonly used layer type in the organization

  • Provide a Default URL pointing to a frequently used service endpoint

  • Consider the capabilities of the target services when selecting default types

Supported Web Data Types

The plugin supports the following web data source types:

Table 3. Supported Web Data Types
Type Description Standard Reference

Cesium 3D Tiles

3D Tiles for displaying 3D content

OGC 3D Tiles

Cesium Pointcloud

Cesium point cloud data (3D Tiles)

OGC 3D Tiles

Cesium Terrain

Cesium terrain tiles

Cesium Quantized Mesh

CZML

CZML time-dynamic data

CZML Specification

GeoJSON

Vector data in GeoJSON format

OGC GeoJSON

Web Feature Service (WFS)

Web Feature Service

OGC WFS

Web Map Service (WMS)

Web Map Service

OGC WMS

Web Map Tile Service (WMTS)

Web Map Tile Service

OGC WMTS

Catalogues

The catalogues section configures integration with external data catalogues that users can browse and search for datasets.

Table 4. Catalogues Configuration Options
Option Description Default Allowed Values

Items per page

Number of datasets displayed per page

14

Any positive integer

Presets catalogues

Predefined catalogue configurations

[]

See Catalogue Presets

Catalogue Integration

When configuring catalogue presets:

  • Ensure catalogue URLs point to publicly accessible API endpoints, see Catalogue Examples

  • Provide meaningful titles and subtitles to help users identify catalogues

  • Use descriptions to explain the scope and purpose of each catalogue

  • Consider the performance impact of Items per page setting - higher values may slow down initial loading

Presets catalogues

Catalogue presets define external data catalogues that users can access through the plugin interface.

Table 5. Catalogue Preset Configuration
Option Description Required Allowed Values

Title

Display name for the catalogue

No

Any string

URL

URL of the catalogue service

Yes

Valid catalogue API endpoint

Type

Type of catalogue system

Yes

geonetwork, idra, nbsRegistry, piveau,

Subtitle

Short description displayed in catalogue overview

No

Any string

Logo

Base64 encoded image for catalogue branding

No

Base64 image string

Description

Detailed description rendered as Markdown

No

Markdown formatted text

The current implementation supports public catalogues only. Authentication mechanisms for protected catalogues are not supported in this version.
Performance Considerations
  • Large Items per page values may impact catalogue browsing performance

  • Complex catalogue descriptions with extensive Markdown formatting may affect rendering performance

  • Consider the number of catalogue presets as each requires initial connection validation

Supported Catalogue Types

The plugin supports integration with four types of data catalogue systems:

Table 6. Supported Catalogues
Type Description Reference

Piveau

European Data Portal compatible catalogue

Piveau Platform

GeoNetwork

Open source metadata catalogue

GeoNetwork OpenSource

Idra

Open Data Federation platform

Idra on GitHub

NBS Registry

UrBreath’s Nature-Based Solutions catalogue

NBS Registry on GitHub

Configuration Examples

Basic Configuration

Example - Minimal Plugin Configuration
{
  "name": "@vcmap/dynamic-layer",
  "defaultTab": "webdata",
  "enabledTabs": ["webdata"],
  "webdata": {
    "defaultType": "WMSLayer",
    "defaultUrl": ""
  },
  "catalogues": {
    "itemsPerPage": 14,
    "presets": []
  }
}

Advanced Configuration with Catalogues

Example - Complete Configuration
{
  "name": "@vcmap/dynamic-layer",
  "defaultTab": "catalogues",
  "enabledTabs": ["webdata", "catalogues"],
  "webdata": {
    "defaultType": "WMSLayer",
    "defaultUrl": "https://sgx.geodatenzentrum.de/wms_topplus_open"
  },
  "catalogues": {
    "itemsPerPage": 20,
    "presets": [
      {
        "url": "https://data.europa.eu/api/hub/search/",
        "type": "piveau",
        "title": "Data Europa",
        "subtitle": "The official portal for European data",
        "description": "# European Data Portal\n\nAccess to open data from EU institutions and member states."
      },
      {
        "url": "https://gdk.gdi-de.org/gdi-de/srv/eng/",
        "type": "geonetwork",
        "title": "Geodaten Katalog",
        "subtitle": "German geodata catalogue",
        "description": "German spatial data infrastructure catalogue containing metadata about geodata and geoservices."
      },
      {
        "url": "https://idra.example.com/api/v1/client/",
        "type": "idra",
        "title": "Open Data Federation",
        "subtitle": "Federated open data platform",
        "description": "Federated catalogue providing access to multiple data sources through a unified interface."
      }
    ]
  }
}

Webdata-Only Configuration

Example - Webdata-Only Plugin Configuration
{
  "name": "@vcmap/dynamic-layer",
  "defaultTab": "webdata",
  "enabledTabs": ["webdata"],
  "webdata": {
    "defaultType": "GeoJSONLayer",
    "defaultUrl": "https://example.com/data/"
  }
}