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

layerlist

A layer listing functionality for the geoportal.

Description

Includes listing layers registered in the Oskari instance, hierarchical grouping defined by admin, listing by data provider and listing for layers that are currently on the map. Also includes textual search for layers and pre-defined filters that allow users to find specific type of layers more easily.

Allows other bundles to register pre-defined filters to be shown and adding tools for layers and a hook for admin functionality for adding layers, groups and dataproviders (extensible menu).

Bundle configuration

No configuration is required, but allows configuration:

  • layerGroupToggleLimit (optional number, default 0)

0 = don't show layer toggle for groups negative number = alwaus show layer toggle for groups positive number = show layer toggle for groups with at most the amount of layers configured with this

Bundle state

No state is required.

Requests the bundle sends out

td>
Request Where/why it's used
`MapModulePlugin.MapLayerVisibilityRequest` Sends out when user clicks the 'Show/Hide' link on a layer
`RemoveMapLayerRequest` Sends out when user clicks the 'remove map layer' button
`ChangeMapLayerStyleRequest` Sent when a layer style is selected from the dropdown.
`ChangeMapLayerOpacityRequest` Sends out when user changes the opacity for a layer
`MapModulePlugin.MapMoveByLayerContentRequest` Allows the user to move the map by the layer content
`userinterface.UpdateExtensionRequest` Handles flyout hide/show
`userinterface.AddExtensionRequest` Register as part of the UI in start()-method
`userinterface.RemoveExtensionRequest` Unregister from the UI in stop()-method
`Guidedtour.AddToGuidedTourRequest` Register layerlist to guided tour
`catalogue.ShowMetadataRequest` Sent when the the info icon is clicked
`ShowMapLayerInfoRequest` Sent when the the backend status icon is clicked
`RearrangeSelectedMapLayerRequest` Sends out when user changes the order of layers in the list

Events the bundle listens to

EventWhy/when
`AfterMapLayerRemoveEvent` Updates UI to remove the layer from selected layers
`AfterMapLayerAddEvent` Updates UI to add the layer to selected layers
`MapLayerEvent` Adds/updates/removes layer from listing based on event
`BackendStatus.BackendStatusChangedEvent` Updates UI to reflect changes in layer backend status
`userinterface.ExtensionUpdatedEvent` React flyout updates
`MapLayerVisibilityChangedEvent` Update UI to change the layer visibility status
`AfterChangeMapLayerOpacityEvent` Changes map layer opacity slider values
`AfterChangeMapLayerStyleEvent` Changes map layer style
`AfterRearrangeSelectedMapLayerEvent` Changes map layer order
`MapSizeChangedEvent` Handles flyout max height