Oskari API Documentation

Select bundle

admindown-arrow
cataloguedown-arrow
  • metadata
    Generic functionality to display metadata from a CSW-service
  • metadatasearch
    Provides metadata catalogue search user-interface for an application.
frameworkdown-arrow
  • announcements
    Bundle for displaying announcements made with admin-announcements.
  • Core services
    Provided by the framework
  • layeranalytics
    Map layer problem tracker
  • layerlist
    A layer listing functionality for the geoportal.
  • mydata
    Provides generic container for listing user data and offers other functionalities a way to present user-specific information.
  • Map Publisher 2
    Allows creation of embedded maps
  • RPC
  • Search
    Provides basic search functionality without any UI
  • Selected-featuredata
    Allows infobox opening in new flyout
  • statehandler
    History functionality and state saving.
  • usagetracker
    Pings the server when any of the configured events occur.
mappingdown-arrow
statisticsdown-arrow
  • statsgrid2016
    Statistics data display. This will replace the statsgrid bundle specification when the implementation has the comparable functionalities as the current one. The bundle depends on mapstats-bundle that provides support for statslayer layertype.
uidown-arrow

wfsvector

Description

WfsVectorLayerPlugin is an alternative implementation of mapwfs2 that uses MVT vector tiles or geojson as data transfer mechanism. Requires module control-mvt to be in use in the backend. Currently supports functionalities:

  • Displays WFS layer features on the map
  • Shows feature infobox on click
  • Notifies with events about currently visible feature properties (shown by Featuredata2 bundle in Feature Data flyout)
  • Allows feature selection by feature id (WFSFeaturesSelectedEvent) or by geometry filter (WFSSetFilter)
  • Temporary click interaction disabling (ActivateHighlightRequest)
  • Layer styling
  • Feature selection based on feature properties (WFSSetPropertyFilter)

Does not support:

  • No special handling for "Manual refresh" type layers
  • Sending of clicked feature geometry as event

Screenshot

screenshot

Plugin config

PropertyValue type
renderMode"mvt"|"vector" originnumber[2] resolutionsnumber[] tileSizenumber minZoomLevelnumber
{
  "renderMode": "mvt",
  "origin": [-548576, 8388608],
  "resolutions": [8192, 4096, 2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1, 0.5, 0.25],
  "tileSize": 256,
  "minZoomLevel": 7
}

Requests the plugin handles

RequestHow does the bundle react
WfsLayerPlugin.ActivateHighlightRequestDisbale/enable map click selection interaction for WFS layers

Requests the plugin sends out

RequestWhy/when
InfoBox.ShowInfoBoxRequest Show clicked feature properties

Events the bundle listens to

Event How does the bundle react
AfterMapMoveEvent Updates feature properties visible.
AfterMapLayerAddEvent Registers layer with WFS service.
AfterMapLayerRemoveEvent Removes layer from WFS service.
WFSFeaturesSelectedEvent Updates layer style to reflect selection.
MapClickedEvent Open infobox or hilight feature (control-click)
MapLayerVisibilityChangedEvent Update layer visibility.
AfterChangeMapLayerOpacityEvent Update layer opacity.
WFSSetFilter Apply geometry filter and select features.

Dependencies

DependencyLinked fromPurpose
Oskari infobox Oskari's InfoBoxBundle That handles the infobox as an Openlayers popup with customized UI