Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
titleMarker selector object syntax
{
    "name": "shops_marker_selector",
    "type": "markerSelector",
    "content": {
        "categories": [
            {
                "dataset": "/rest/projects/$projectId/md/datasets?name=shops",
                "markers": [
                    {
                        "namemarker": "/rest/projects/$projectId/md/markers?name=shops_marker",
                        "visible": true
                    },
                    {
                        "namemarker": "/rest/projects/$projectId/md/markers?name=partners_marker",
                        "visible": true
                    }
                ]
            },
            {
                "dataset": "/rest/projects/$projectId/md/datasets?name=competitors",
                "markers": [
                    {
                        "namemarker": "/rest/projects/$projectId/md/markers?name=competitor_frankies_marker",
                        "visible": false,
                        "addOnExpand": true
                    },
                    {
                        "namemarker": "/rest/projects/$projectId/md/markers?name=competitor_da_marker",
                        "visible": false,
                        "addOnExpand": true
                    },
                    {
                        "namemarker": "/rest/projects/$projectId/md/markers?name=competitor_streetberries_marker",
                        "visible": false,
                        "addOnExpand": true
                    },
                    {
                        "namemarker": "/rest/projects/$projectId/md/markers?name=competitor_schelma_marker",
                        "visible": false,
                        "addOnExpand": true
                    }
                ]
            }
        ]
    }
}

...

Code Block
titleExample of a dumped marker selector
collapsetrue
{
    "url": "/rest/projects/yufqzxkbiecj7jot/md/markerSelectors/ompa8292o688a2iu",
    "dumpTime": "2018-01-31T15:07:37Z",
    "version": "1",
    "content": {
        "id": "ompa8292o688a2iu",
        "name": "shops_marker_selector",
        "type": "markerSelector",
        "content": {
            "categories": [
                {
                    "dataset": "/rest/projects/$projectId/md/datasets?name=shops",
                    "markers": [
                        {
                            "namemarker": "/rest/projects/$projectId/md/markers?name=shops_marker",
                            "visible": true
                        },
                        {
                            "namemarker": "/rest/projects/$projectId/md/markers?name=partners_marker",
                            "visible": true
                        }
                    ]
                },
                {
                    "dataset": "/rest/projects/$projectId/md/datasets?name=competitors",
                    "markers": [
                        {
                            "name": ""marker": "/rest/projects/$projectId/md/markers?name=competitor_frankies_marker",
                            "visible": false,
                            "addOnExpand": true
                        },
                        {
                            "namemarker": "/rest/projects/$projectId/md/markers?name=competitor_da_marker",
                            "visible": false,
                            "addOnExpand": true
                        },
                        {
                            "namemarker": "/rest/projects/$projectId/md/markers?name=competitor_streetberries_marker",
                            "visible": false,
                            "addOnExpand": true
                        },
                        {
                            "namemarker": "/rest/projects/$projectId/md/markers?name=competitor_schelma_marker",
                            "visible": false,
                            "addOnExpand": true
                        }
                    ]
                }
            ]
        },
        "accessInfo": {
            "createdAt": "2017-10-05T08:27:09Z"
        },
        "links": [
            {
                "rel": "self",
                "href": "/rest/projects/yufqzxkbiecj7jot/md/markerSelectors/ompa8292o688a2iu"
            }
        ]
    }
}

...

(a-z0-9_-)
KeyTypeOptionalityDescriptionConstraints
namemarkerstring

Status
colourRed
titlerequired

name of the markerURI link to a marker object representing marker in a category/rest/projects/$projectId/md/markers?name={markerName}
visibleboolean
Status
colourRed
titlerequired

sets the default visibility of the marker

default = true

[true, false]

addOnExpandboolean
Status
colourGreen
titleoptional

specifies if the marker should become visible after clicking on the category, when by default it is set to visible = false

[true, false]

...