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

analyse

Description

Bundle manages analyse parameter and data setups, requests analyse execute actions and stores analyse results to DB through backend action route.

Screenshot

screenshot

Bundle configuration

No configuration is required.

Bundle state

state : {
  layerId : "{{id of the analysis layer or WFS layer}}",
  method : "{{analyse method}}",
  params : "{{{buffer_size, intersector, aggregate_function}}}",
  styles : "{{{}}}",
  propertymode : "{{all|none|columns}}",
  columns : "{{column names, when propertymode is columns}}"
}

Requests the bundle sends out

RequestWhy/when
`userinterface.AddExtensionRequest`Extends the basic UI view.

Analyse view

RequestWhy/when
`userinterface.UpdateExtensionRequest`Extends the basic UI view.
`catalogue.ShowMetadataRequest`layer metadata info request
`DisableMapKeyboardMovementRequest`for text input in flyout
`EnableMapKeyboardMovementRequest`for text input in flyout

Events the bundle listens to

EventHow does the bundle react
`userinterface.ExtensionUpdatedEvent` Enters/exits the analysis mode.
`AfterMapLayerAddEvent` Refreshes the data panel
`AfterMapLayerRemoveEvent` Refreshes the data panel

Dependencies

DependencyLinked fromPurpose
jQuery Version 1.7.1 assumed to be linked on the page Used to create the UI
OpenLayers Expects OpenLayers already to be linked Temp feature drawing and selected geometry editing
Oskari mapmodule Expects to be present in the application setup To gain control to OpenLayers map
Oskari mapanalysis Expects to be present in the application setup Needed to support the ANALYSIS layer type.