Download

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

search

Provides a generic and extensible search user-interface

Description

Provides (address etc) search functionality with a flyout UI.

Screenshot

screenshot

Bundle configuration

No configuration is required, but it can be used to set ajax URL. If not set, sandbox.getAjaxUrl() with action_route=GetSearchResult is used instead.

The default search UI can be disable through config.

{
  "url" : "http://www.google.com",
  "disableDefault": "{{boolean}}"
}

Requests the bundle sends out

RequestHow does the bundle react
MapMoveRequestWhen a search result is clicked, the map is centered on the location.
InfoBox.ShowInfoBoxRequest When a search result is clicked, information about the results is shown on an Infobox
InfoBox.HideInfoBoxRequest Hides search result infobox.
MapModulePlugin.RemoveMarkerRequest When the search keyword is removed, any markers on the map are removed.

Dependencies

Dependency Linked from Purpose
jQuery Linked in portal theme Used to create the component UI from begin to end
OpenLayers Expects mapmodule to be present and OpenLayers already linked To control map and show an Openlayers popup on it
Oskari divmanazer DivManazerBundle Provides flyout/tile functionality
Backend API N/A Search is handled in backend