Add style

Description	Adds a style to a vector layer.
Endpoint	/path/{pathId}/vector/style
Method	POST

Access Level Rules

Access Level

edit+

Processing Units

Processing units

2

Parameters

Name	Description	Required	Default
pathId	The id of the vector layer.	true
name	The name of the new style.	true
default	Boolean whether the style should be the default style.	true
method	The method of the style. Must be one of "rules", "transitionPoints", "'random", "singleColor" or "fromColorProperty".	true
parameters	A JSON containing the parameters of the style. Below table defines the style parameters, whose content differs between methods.	true

Sample requests for different methods

Single Color

{
    "name": "Vector Style",
    "default": true,
    "method": "singleColor",
    "parameters": {
        "alpha": 0.5,
        "width": 2,
        "radius": {
            "method": "constant",
            "parameters": {
                "value": 7
            }
        },
        "color": "#c75b1c",
        "pattern":null,
        "icon":null,
        "borderColor": "#934314"        
        }
}

Random

{
    "name": "Vector Style",
    "default": true,
    "method": "random",
    "parameters": {
        "alpha": 0.5,
        "width": 2,
        "radius": {
            "method": "constant",
            "parameters": {
                "value": 7
            }
        },
        "property": "iso_a2",
        "borderColor": "#934314",
        "defaultColor": "#c75b1c",
    }
}

Transition Points

{
    "name": "Vector Style",
    "default": true,
    "method": "transitionPoints",
    "parameters": {
        "property": "fid",
        "alpha": 0.5,
        "width": 2,
        "radius": {
            "method": "constant",
            "parameters": {
                "value": 7
            }
        },
        "continuous": true,
        "transitionPoints": [
            {
                "value": 1,
                "color": "#2A5C84",
                "pattern": null,
                "icon":null
            },
            {
                "value": 1524.25,
                "color": "#74AE56"
                "pattern": null,
                "icon":null
            },
            {
                "value": 3047.5,
                "color": "#FFE733"
                "pattern": null,
                "icon":null
            },
            {
                "value": 4570.75,
                "color": "#FF8C01"
                "pattern": null,
                "icon":null
            },
            {
                "value": 6094,
                "color": "#ED2938"
                "pattern": null,
                "icon":null
            }
        ],
        "borderColor": "#060200",
        "defaultColor": "#c75b1c",
        "defaultPattern": null,
        "defaultIcon": null        
    }
}

Inherit from color property

{
    "name": "Vector Style",
    "default": true,
    "method": "fromColorProperty",
    "parameters": {
        "defaultColor": "#c75b1c",
        "defaultPattern": null,
        "defaultIcon": null,
        "alpha": 0.5,
        "width": 2,
        "radius": {
            "method": "constant",
            "parameters": {
                "value": 7
            }
        }
    }
}

classToColor

{
    "method": "classToColor",
    "name": "maps vectors to a color based on the value of a certain property",
    "parameters": {
        "alpha": 1,
        "defaultColor": "#c75b1c",
        "defaultPattern": null,
        "defaultIcon": null,
        "property": "myProperty",
        "colorMapping": 
            [
                {"value":"myPropertyValue1", "color": "#2A5C84", "pattern": null, "icon":null},
                {"value":"myPropertyValue2", "color":"#FFE733", "pattern": null, "icon":null},
                {"value":"myPropertyValue3", "color": "#FF8C01", "pattern": null, "icon":null},
                {"value":"myPropertyValue4", "color":"#ED2938", "pattern": null, "icon":null},
            ],
        "width": 2,
        "radius": {
            "method": "constant",
            "parameters": {
                "value": 7
            }
        }            
    }
}

Formula

{
    "name": "Vector Style",
    "default": true,
    "method": "formula",
    "parameters": {
        "properties": ["fid"],
        "formula": "5 * property1 ^ 2",
        "defaultColor": "#c75b1c",
        "defaultPattern": null,
        "defaultIcon": null,
        "alpha": 0.5,
        "width": 2,
        "radius": {
            "method": "constant",
            "parameters": {
                "value": 7
            }
        },
        "continuous": true,
        "transitionPoints": [
            {
                "value": 1,
                "color": "#2A5C84",
                "pattern": null,
                "icon": null,
            },
            {
                "value": 1524.25,
                "color": "#74AE56",
                "pattern": null,
                "icon": null,
            },
            {
                "value": 3047.5,
                "color": "#FFE733",
                "pattern": null,
                "icon": null,
            },
            {
                "value": 4570.75,
                "color": "#FF8C01",
                "pattern": null,
                "icon": null,
            },
            {
                "value": 6094,
                "color": "#ED2938",
                "pattern": null,
                "icon": null,
            }
        ],
        "borderColor": "#060200"
    }
}

A pattern must be an object with:

• type: One of solid, diagonal, horizontal or vertical

• width: a float between 1 and 50

• backgroundColor: a hex color, optional.

Example:

pattern = {"type":"diagonal", "width": 2, "backgroundColor":"#934314"}

An icon must be an object with

• name: the name of the icon as a string.

All valid inputs for name can be listed with

GET /image/listIcons

Example:

icon = {"name":"dog"}

RECOMMENDED READING

🖌️Vector styling methods