VectorLayerRequest RPC

Adds a new feature layer to map or updates an existing layer.

Use cases

• Add a new feature layer
• Update layer properties
• Remove vector features layer

Description

Prepares a layer for later use or updates an existing layer for vector features.

The request takes one parameter, options.

Note! You can use minZoomLevel / maxZoomLevel or minScale / maxScale instead of minResolution / maxResolution.

Hover Settings

Note that features are not hovered while drawing is active (DrawTools).

Hover has two optional keys featureStyle and content. See Oskari JSON style for featureStyle definition.

Content should be content of tooltip as an array. Each object creates a row to the tooltip. Each row object has key or keyProperty and valueProperty. key is a label and will be rendered as is. valueProperty and keyProperty will be fetched from the feature's properties.

For example:

{
    'featureStyle':  {
        'inherit': true,
        'effect': 'darken'
    },
    'content': [
        { 'key': 'Feature Data' },
        { 'key': 'Feature ID', 'valueProperty': 'id' },
        { 'keyProperty': 'type', 'valueProperty': 'name' }
    ]
}

The features would be darker on mouse hover and they would have a tooltip like:

Feature Data
Feature ID: 23098523243
Road: Main Street

Examples

Adding a new layer example

Only prepares a layer for later use. To add features to this layer see AddFeaturesToMapRequest.

var options = {
    layerId: 'MY_VECTOR_LAYER',
    layerInspireName: 'Inspire theme name',
    layerOrganizationName: 'Organization name',
    showLayer: true,
    opacity: 80,
    layerName: 'Layer name',
    layerDescription: 'Description text',
    layerPermissions: {
        'publish': 'publication_permission_ok'
    },
    maxScale: 1,
    minScale: 1451336,
    hover: {
        'featureStyle':  {
            'inherit': true,
            'effect': 'darken'
        }
    }
};
Oskari.getSandbox().postRequestByName('VectorLayerRequest', [options]);

Update layer properties example

Define layerId which matches layer's id which should be updated. Add properties which should be updated. Note that if id doesn't match any existing layer, a new layer will be created.

var newOptions = {
    layerId: 'MY_VECTOR_LAYER', // existing id
    opacity: 100,
    hover: {
        'featureStyle':  {
            'inherit': true,
            'effect': 'darken'
        },
        'content': [
            { 'key': 'Feature ID', 'valueProperty': 'test_property' }
        ]
    }
};
Oskari.getSandbox().postRequestByName('VectorLayerRequest', [newOptions]);

Remove existing vector layer as part of cleanup

Define layerId which matches layer's id which should be removed. Add a remove-flag with boolean true value to remove the layer.

Oskari.getSandbox().postRequestByName('VectorLayerRequest', [{
    layerId: 'MY_VECTOR_LAYER', // existing id
    remove: true
}]);

Related api

• AddFeaturesToMapRequest
• RemoveFeaturesFromMapRequest