Markers

Marker represents a specific location on a map. It can be the location of a shop, a warehouse, an ATM, or anything else that has geographical coordinates.

Markers can be grouped and connected to a dataset in marker selectors.

Syntax

This is one of the two markers that can be found in the Retail Solution Demo. This marker represents the company's own shops. The other type represents partner shops.

The style of the marker is orange, and the filtering is done according to the partner property, which is either yes or no. The reference to the dataset containing the partner property (shops dataset) is defined in the respective marker selector.

Marker object syntax
{
    "name": "shops_marker",
    "type": "marker",
    "title": "Stores",
    "content": {
        "style": "marker-orange",
        "propertyFilters": [
            {
                "propertyName": "partner",
                "value": "no",
                "operator": "eq"
            }
        ]
    }
}
Example of a dumped marker
{
    "url": "/rest/projects/yufqzxkbiecj7jot/md/markers/v116eiot3uu3sjgf",
    "dumpTime": "2018-01-31T18:31:02Z",
    "version": "4",
    "content": {
        "id": "v116eiot3uu3sjgf",
        "name": "shops_marker",
        "type": "marker",
        "title": "Stores",
        "content": {
            "style": "marker-orange",
            "propertyFilters": [
                {
                    "propertyName": "partner",
                    "value": "no",
                    "operator": "eq"
                }
            ]
        },
        "accessInfo": {
            "createdAt": "2017-10-05T08:27:12Z",
            "modifiedAt": "2018-01-31T17:31:04Z"
        },
        "links": [
            {
                "rel": "self",
                "href": "/rest/projects/yufqzxkbiecj7jot/md/markers/v116eiot3uu3sjgf"
            }
        ]
    }
}

Key description

content

KeyTypeOptionalityDescriptionConstraints
styleboolean

REQUIRED

defines the style of the marker

there are two shapes: round and squared

there are four style groups: regular, check, cross and star

see the available palettes below

see palette below

propertyFiltersobjectOPTIONAL

an array of dataset property filters, by which the marker will be filtered


content.propertyFilters

propertyFilters object allows you to distinguish the markers by the properties specified in their dataset, to which they are connected to in a marker selector.

KeyTypeOptionalityDescriptionConstraints
propertyNamestring

REQUIRED

dataset property, by which the marker will be filtered

{datasetProperty}
value

string

long

decimal

boolean

REQUIRED

value, by which the marker will be filtered

this key is polymorphic - it doesn't have only one type

it can also be a single value, or an array:

  • for the eq, ne, lt, lte, gt and gte operators, use single value
  • for the in operator, specify an array of values

operator

string

OPTIONAL

defines an operator, which will be applied to the value

[eq, ne, lt, lte, gt, gte, in]

Visual representation

Markers are avaialable in various colours, sizes and shapes.

Quantitative markers

1-100 £101-500 £501-1000 £

1001-5000 £

5001+ £

It is possible visualise the value of an indicator using quantitative markers of different sizes. There are two ways how to achieve this:

  • by setting the view.content.markersOnly property to true
    • note that this will exclude all other granuluaritites from the view
  • by setting up a view with no granularity, other than the geometryPoint dataset containing the markers (which has to be specified in markerSelector.content.categories.dataset)
    • e.g., no administrative units, no grid, etc.

Markers with shapes

marker-redmarker-bluemarker-greenmarker-limemarker-yellowmarker-orangemarker-pinkmarker-purplemarker-turquoisemarker-brownmarker-gray

squared-redsquared-bluesquared-greensquared-limesquared-yellowsquared-orangesquared-pinksquared-purplesquared-turquoisesquared-brownsquared-gray

This is the check marker palette:

marker-check-redmarker-check-bluemarker-check-greenmarker-check-limemarker-check-yellowmarker-check-orangemarker-check-pinkmarker-check-purplemarker-check-turquoisemarker-check-brownmarker-check-gray

squared-check-redsquared-check-bluesquared-check-greensquared-check-limesquared-check-yellowsquared-check-orangesquared-check-pinksquared-check-purplesquared-check-turquoisesquared-check-brownsquared-check-gray

This is the cross marker palette:

marker-cross-redmarker-cross-bluemarker-cross-greenmarker-cross-limemarker-cross-yellowmarker-cross-orangemarker-cross-pinkmarker-cross-purplemarker-cross-turquoisemarker-cross-brownmarker-cross-gray

squared-cross-redsquared-cross-bluesquared-cross-greensquared-cross-limesquared-cross-yellowsquared-cross-orangesquared-cross-pinksquared-cross-purplesquared-cross-turquoisesquared-cross-brownsquared-cross-gray

This is the star marker palette:

marker-star-redmarker-star-bluemarker-star-greenmarker-star-limemarker-star-yellowmarker-star-orangemarker-star-pinkmarker-star-purplemarker-star-turquoisemarker-star-brownmarker-star-gray

squared-star-redsquared-star-bluesquared-star-greensquared-star-limesquared-star-yellowsquared-star-orangesquared-star-pinksquared-star-purplesquared-star-turquoisesquared-star-brownsquared-star-gray

Markers with letters

It's possible to create a marker which has a letter in it, instead of a predefined shape. It's possible to combine any of the colours above, marker and squared shapes and any letter from the english alphabet.

For example: marker-a-blue, marker-r-lime, square-c-yellow, square-b-brown.

This is the full pallette for marker-X-blue, where X is the letter:

marker-a-bluemarker-b-bluemarker-c-bluemarker-d-bluemarker-e-bluemarker-f-bluemarker-g-bluemarker-h-bluemarker-i-bluemarker-j-bluemarker-k-bluemarker-l-redmarker-m-blue

marker-n-bluemarker-o-bluemarker-p-bluemarker-q-bluemarker-r-bluemarker-s-bluemarker-t-bluemarker-u-bluemarker-v-bluemarker-w-bluemarker-x-bluemarker-y-bluemarker-z-blue

 

After hovering a marker, a tooltip is shown. You can define its content in the dataset object.

If there is too much markers to display, the markers are clustered.