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

routingUI

Description

This bundle provides UI for routing. In this bundle user can select start and end points of route and then search route of between these points. Finally results are showed on the popup.

Screenshot

screenshot

Bundle configuration

No configuration is required, but there is few possible configurations:

  • Setting decimals for wanted decimals rounding for input box lon/lat values. For examples:
// Set all projections rounding rule
{
  "decimals": 6
}

// Set projection specified rounding rules
{
  "decimals" {
      "EPSG:4326": 5,
      "EPSG:3067": 0
  }
}

// Use default rounding rules, use empty decimals configuration. Then rounding decimal are map projection unit specified
{
}

Requests the bundle sends out

Request Where/why it's used
`GetRouteRequest` Get route plan.
`MapModulePlugin.AddFeaturesToMapRequest` Add route plan geometry to map.
`MapModulePlugin.RemoveFeaturesFromMapRequest` Remove route plan geometry from map.
`MapModulePlugin.AddMarkerRequest` Add route start and end point to map.
`MapModulePlugin.RemoveMarkersRequest` Remove route start and end points from map.

Events the bundle listens to

EventHow does the bundle react
`MapClickedEvent`Updates the coordinates gotten from event to the UI.
`RouteResultEvent`Updates the route plans to the UI.

Dependencies

DependencyLinked fromPurpose
jQuery Assumes to be linked in the page Used to create the component UI from begin to end
Moment.js Bundle Used to format date/time