Oskari API Documentation

Select bundle

admindown-arrow
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

metadatacatalogue

Description

Bundle provides metadata catalogue search functionality for the map.

Bundle configuration

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

{
  "hideMetadataXMLLink" : true,
  "hideMetaDataPrintLink": true
}

Setting hideMetadataXMLLink to true will hide metadata XML link (ISO 19139 XML -file).

Setting hideMetaDataPrintLink to true will hide print link.

Requests the bundle handles

RequestHow does the bundle react
MetadataSearchRequestMake a metadata search query.

Requests the bundle sends out

Sends out when user clicks the 'Show/Hide' link on a search results
RequestWhy/when
`userinterface.AddExtensionRequest`Extends the basic UI view.
'Search.AddTabRequest'Add metadata search tab to search bundle
'catalogue.ShowMetadataRequest'layer metadata info request
'MapModulePlugin.MapLayerVisibilityRequest'
'RemoveMapLayerRequest'Sends out when user clicks the 'Hide' link on a search results
'AddMapLayerRequest'Sends out when user clicks the 'Show' link on a search results
'userinterface.RemoveExtensionRequest'Unregister from UI in stop()-method
'DrawTools.StartDrawingRequest'Sends out when user clicks 'Show data coverage' link on a search results to draw a rectangle.
'DrawTools.StopDrawingRequest'Sends out when user stops data coverage rectangle drawing.

Events the bundle listens to

Event How does the bundle react
MetadataSearchResultEvent Show metadata search results

Events the bundle sends out

Event Why/when
MetadataSearchResultEvent Notifies that a metadata search has been performed and the result is accessible through the event

Dependencies

DependencyLinked fromPurpose
jQuery Version 1.7.1 assumed to be linked on the page Used to create the UI
Oskari divmanazer Expects to be present in the application setup For Tile/Flyout and other UI components