Select request

Description

RPC only

admin

Admin.AddTabRequest
Requests tab to be added

framework

AddLayerListFilterRequest
Filter buttons can be added for layerlist by sending AddLayerListFilterRequest.
ShowFilteredLayerListRequest
Filter layers shown on layerlist.
Publisher.PublishMapEditorRequest
Oskari.mapframework.request.Request superclass documents how to send one.
SearchRequest
Make a search query
StateHandler.SaveStateRequest
Requests state to be saved
StateHandler.SetStateRequest
Requests state to be set

mapping

StartDrawingRequest
Allows the user to draw on the map.
StopDrawingRequest
Used to complete or clear the drawing.
ShowFeatureDataRequest
Requests a WFS feature data to be shown
GetFeedbackRequest
Get feedbacks from feedback service (Open311).
GetFeedbackServiceRequest
Get feedback service list or metadata of single service (if id is given) from feedback service (Open311).
PostFeedbackRequest
Posts user's feedback data to feedback service (Open311).
StartGeometryCuttingRequest
Starts cutting the supplied feature as target.
StopGeometryCuttingRequest
Stops cutting.
GetFeatureInfoRequest
Display feature info box.
MapModulePlugin.MapLayerUpdateRequest
Update the map layer data on map.
MapModulePlugin.MapLayerVisibilityRequest
Allows user to change map layer visibility.
MapModulePlugin.MapMoveByLayerContentRequest
Allows the user to move the map by the layer content.
MapModulePlugin.RegisterStyleRequest
Allows user to add wellknown svg styles.
MapMoveRequest
Allows user to move the map to certain location.
MapTourRequest
Allows programmatic tour around the map showcasing multiple locations
RemoveMapLayerRequest
Removes a map layer from map.
SetTimeRequest
Allows programmatic change of time for 3d map
ShowProgressSpinnerRequest
Allows progress spinner to be shown or hidden on a map.
StartUserLocationTrackingRequest
Start tracking user's location.
StopUserLocationTrackingRequest
Stop tracking user's location.
AddFeaturesToMapRequest
Allows user to add features to map.
AddMapLayerRequest
Adds a layer to the map.
AddMarkerRequest
Add marker to certain point on map.
ChangeMapLayerOpacityRequest
Allows user to change map layer opacity on a map.
ChangeMapLayerStyleRequest
Allow user to change map layer style between preconfigured options on the map (styles available for a WMS-layer etc).
DisableMapKeyboardMovementRequest
Disable map keyboard movement.
DisableMapMouseMovementRequest
Disable map mouse movement.
EnableMapKeyboardMovementRequest
Enable map keyboard movement.
EnableMapMouseMovementRequest
Enable map mouse movement.
GetUserLocationRequest
Get user's location
map.layer.activation
Flags the layer as activated/deactivated.
MapModulePlugin.MarkerVisibilityRequest
Show or hide marker from map.
RearrangeSelectedMapLayerRequest
Allow user to change order of map layers in relation to other layers on the map.
RemoveFeaturesFromMapRequest
Remove vector features from map
RemoveMarkersRequest
Remove markers from the map.
VectorLayerRequest
Adds a new feature layer to map or updates an existing layer.
ZoomToFeaturesRequest
Moves map to show referenced vector features on the viewport.
rotate.map request
```javascript var requestBuilder = Oskari.requestBuilder('rotate.map'); var request = requestBuilder(180); Oskari.getSandbox().request('maprotator', request); ```
MetadataSearchRequest
Make a metadata search query.
AddSearchResultActionRequest
Shows action element in metadata search results list
catalogue.AddTabRequest
Requests tab to be added
catalogue.ShowMetadataRequest
Request for showing metadata for the given uuid, layer id or RS_Identifier Code / RS_Identifier CodeSpace
MyPlaces.DeleteCategoryRequest
Requests a "my place" maplayer/category to be deleted
MyPlaces.DeletePlaceRequest
Requests a saved "my place" to be deleted
MyPlaces.EditCategoryRequest
Requests a "my place" maplayer/category to be opened for editing
MyPlaces.EditPlaceRequest
Requests a saved "my place" to be opened for editing
MyPlaces.OpenAddLayerDialogRequest
Requests the add layer dialog to be opened
MyPlaces.PublishCategoryRequest
Requests a "my place" maplayer/category to be made publishable or private
printout.PrintMapRequest
Starts/opens the UI for printout functionality like user had clicked the tool icon.
GetRouteRequest
Get route plan between two points.
ShowUserStylesRequest
Requests a user own styles to be shown for specific layer.
WfsLayerPlugin.ActivateHighlightRequest
Requests a WFS highlight enabled or disabled

userinterface.AddExtensionRequest
Extends the basic UI view
userinterface.ModalDialogRequest
Request for UI modal dialog
userinterface.RemoveExtensionRequest
Unregisters the extensions when the bundle gets stopped
userinterface.UpdateExtensionRequest
Updates the extended UI view
Guidedtour.AddToGuidedTourRequest
Add guide to guided tour.
InfoBox.HideInfoBoxRequest
Hide infobox from the map.
InfoBox.RefreshInfoBoxRequest
Refreshes the requested infobox/popup if present
InfoBox.ShowInfoBoxRequest
Show infobox on map.
Search.AddTabRequest
Requests a tab to be added
Search.RemoveSearchResultActionRequest
Requests a search result action to be removed
Toolbar.AddToolButtonRequest
Requests for toolbar to add button with given config
Toolbar.RemoveToolButtonRequest
Requests for toolbar to remove button with given id/group
Toolbar.SelectToolButtonRequest
Requests for toolbar to act as if user had clicked a button or returns a default tool if create params aren't given.
Toolbar.ToolButtonStateRequest
Requests for toolbar to enable/disable a button.
Toolbar.ToolbarRequest
Requests for toolbar to create/show/hide/remove a toolbar.
userguide.ShowUserGuideRequest
Shows additional data in user guide

StopDrawingRequest RPC

Used to complete or clear the drawing.

Use cases

complete drawing
clear drawing

Description

If the user is allowed to draw on the map this request can be used to complete the drawing and/or clear the drawing from the map.

Parameters

Name	Type	Description	Default value
id	String	Identifier for request. Required for complete drawing.
clearCurrent	Boolean	true - drawings will be removed from the map. If id is given, then id related drawings are removed, otherwise all. false - will keep drawings on the map.	false
supressEvent	Boolean	true - does not send out an DrawingEvent. false - sends out DrawingEvent.	false

Examples

Complete a draw for 'measure' functionality and keep the drawing on the map:

Oskari.getSandbox().postRequestByName('DrawTools.StopDrawingRequest', ['measure']);

This expects that drawing has been started for id 'measure' and will result in an 'DrawingEvent' where id is 'measure' with the measure data available in event.getData().

Complete a draw for 'myplaces' functionality and clear 'myplaces' drawings from the map:

Oskari.getSandbox().postRequestByName('DrawTools.StopDrawingRequest', ['myplaces', true]);

Again, this expects that drawing has been started for id 'myplaces' and will result in an 'DrawingEvent' where id is 'myplaces' with the drawn shape as geojson available in event.getGeoJson().

Clear 'myplaces' drawings and don't send out an event:

Oskari.getSandbox().postRequestByName('DrawTools.StopDrawingRequest', ['measure', true, true]);

This is normally used when functionality is stopped to clean own drawings.

Remove all drawings:

Oskari.getSandbox().postRequestByName('DrawTools.StopDrawingRequest');

This can be used to be sure that there isn't any previous or other functionalitys' drawings before a new drawing is started.

Related api

StartDrawingRequest
DrawingEvent

Oskari API documentation

Select request

StopDrawingRequest RPC

Use cases

Description

Parameters

Examples

Related api