AddLayerListFilterRequest

Filter buttons can be added for layerlist by sending AddLayerListFilterRequest.

Use cases

• add layerlist filter

Description

The filter name parameter is used in ShowFilteredLayerListRequest request when activating allready defined filter.

The request must contains the tool text, tool tooltip text, filter function, button icon style class name when tool is active, button icon style class name when tool is deactive and filter name.

Parameters

(* means the parameter is required)

Name	Type	Description	Default value
* toolText	String	Filter button text
tooltip	String	Filter button tooltip text
iconClassActive	String	Filter button active icon style class
iconClassDeactive	String	Filter button deactive icon style class
* filterName	String	Identifier for request

Examples

Add publishable layers filter to layerlist

// Add layer filter to map layer service
var mapLayerService = Oskari.getSandbox().getService('Oskari.mapframework.service.MapLayerService');
mapLayerService.registerLayerFilter('publishable', function(layer){
    return (layer.getPermission('publish') === 'publication_permission_ok');
});

// Add layerlist filter button
Oskari.getSandbox().postRequestByName('AddLayerListFilterRequest', [
    'Publishable',
    'Show publishable layers',
    'layer-publishable',
    'layer-publishable-disabled',
    'publishable'
]);

Icon style classes (generated with build-script based on png-files in oskari-frontend/resouces/icons folder):

.layer-publishable {
    width: 16px;
    height: 16px;
    background-image: url('icons.png') !important;
    background-repeat: no-repeat !important;
    background-position: -1461px 0px !important;
}

.layer-publishable-disabled {
    width: 16px;
    height: 16px;
    background-image: url('icons.png') !important;
    background-repeat: no-repeat !important;
    background-position: -1445px 0px !important;
}

Creating custom filters

Register a custom filter (for example filtering layers where name starts with 'a' or 'A') to MapLayerService:

// Register new filter
var mapLayerService = Oskari.getSandbox().getService('Oskari.mapframework.service.MapLayerService');
mapLayerService.registerLayerFilter('layer_name_startswith_a', function(layer){
    var name = layer.getName().toLowerCase(),
            nameFirstChar = name.substring(0,1);
        return (nameFirstChar === 'a');
});

Add a button for the filter above to the UI in layerselector:

// Add layerlist filter button what use previously created new filter
Oskari.getSandbox().postRequestByName('AddLayerListFilterRequest', [
    'Layer names starting with "A"',
    'Show layers where name starts with a',
    'layer-start-a',
    'layer-start-a-disabled',
    'layer_name_startswith_a'
]);

Icon style classes:

.layer-start-a {
    height:16px;
}

.layer-start-a:before {
    content: "A";
    font-size: 16px;
    color: #00cd98;
    line-height: 16px;
    text-align: center;
    font-weight: bold;
}

.layer-start-a-disabled {
    height:16px;
}

.layer-start-a-disabled:before {
    content: "A";
    font-size: 16px;
    color: #cccdcc;
    line-height: 16px;
    text-align: center;
    font-weight: bold;
}