Class ria.legend.LegendService

Gets the legend data for the given overlay. The legend data adheres to the following structure:

overlayData := {                                
    "LegendResponse": [layerData...]
}

layerData := {
    "layerName": String,           // Name of the layer used by Spatial 
                                   // Server
    "rows": [row...]               // Nested rows of swatches
}

row := {
    "description": String,         // Descriptive label for the swatch
    "swatch": String               // Data URI representation of Swatch Image 
                                   // of the following format 
                                   // data:[][;base64],  
}

Here's an example of such a legend structure in JSON:

     
{
    "LegendResponse": [
        {
            "layerName": "Cities",
            "rows": [
                {
                    "description": "Capital",
                    "swatch": "http://example.com/icon1.png"
                },
                {
                    "description": "Population > 1 Mio",
                    "swatch": "http://example.com/icon2.png"
                }
            ]
        },
        {
            "layerName": "Boundaries",
            "rows": [
                {
                    "description": "District",
                    "swatch": "http://example.com/icon1.png"
                }
            ]
        },
    ]
}