...
| Code Block |
|---|
| title | Marker selector object syntax |
|---|
|
{
"name": "shops_marker_selector",
"type": "markerSelector",
"content": {
"categories": [
{
"dataset": "/rest/projects/$projectId/md/datasets?name=shops",
"markers": [
{
"marker": "/rest/projects/$projectId/md/markers?name=shops_marker",
"visible": true,
"itemId": "8ac314a472a91c42bfbeac9cf90a30aa"
},
{
"marker": "/rest/projects/$projectId/md/markers?name=partners_marker",
"visible": true,
"itemId": "95d3557834d051bc932882e8b7e4a7b0" }
],
"itemId": "569c103056dc6ca99d6f9dcec7279b48" },
{
"dataset": "/rest/projects/$projectId/md/datasets?name=competitors",
"markers": [
{
"marker": "/rest/projects/$projectId/md/markers?name=competitor_frankies_marker",
"visible": false,
"addOnExpand": true,
"itemId": "d8c7644858a40fb7ac90d15d685cffe1"
},
{
"marker": "/rest/projects/$projectId/md/markers?name=competitor_da_marker",
"visible": false,
"addOnExpand": true,
"itemId": "8d053723cb9372574ceeae9bd0c360ba"
},
{
"marker": "/rest/projects/$projectId/md/markers?name=competitor_streetberries_marker",
"visible": false,
"addOnExpand": true,
"itemId": "8ac314a472a91c42bfbeac9cf90a30aa" },
{
"marker": "/rest/projects/$projectId/md/markers?name=competitor_schelma_marker",
"visible": false,
"addOnExpand": true,
"itemId": "8d73221febc274d52f4367c3878506e0"
}
],
"itemId": "08a28d47c1b25b25b69ba304bf286257"
}
]
}
}
|
| Code Block |
|---|
| title | Example of a dumped marker selector |
|---|
| collapse | true |
|---|
|
{
"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": [
{
"marker": "/rest/projects/$projectId/md/markers?name=shops_marker",
"visible": true,
"itemId": "100ba488ab6b56196d1641b4cd86101c"
},
{
"marker": "/rest/projects/$projectId/md/markers?name=partners_marker",
"visible": true,
"itemId": "a5708f7570f330a1d470bbf2eaaed1ed"
}
],
"itemId": "d13d5b44990292a6c1b051c018410053" },
{
"dataset": "/rest/projects/$projectId/md/datasets?name=competitors",
"markers": [
{
"marker": "/rest/projects/$projectId/md/markers?name=competitor_frankies_marker",
"visible": false,
"addOnExpand": true,
"itemId": "24855bd309326c03f9517aa26c1585ce" },
{
"marker": "/rest/projects/$projectId/md/markers?name=competitor_da_marker",
"visible": false,
"addOnExpand": true,
"itemId": "110041ea130fb3cb2b8e6ef4d3925184"
},
{
"marker": "/rest/projects/$projectId/md/markers?name=competitor_streetberries_marker",
"visible": false,
"addOnExpand": true,
"itemId": "3fb652df72521f04ea030cd7e5be4f14" },
{
"marker": "/rest/projects/$projectId/md/markers?name=competitor_schelma_marker",
"visible": false,
"addOnExpand": true,
"itemId": "8ac314a472a91c42bfbeac9cf90a30aa"
}
],
"itemId": "ccf504abece40ed0bbe992f4931ddae3"
}
]
},
"accessInfo": {
"createdAt": "2017-10-05T08:27:09Z"
},
"links": [
{
"rel": "self",
"href": "/rest/projects/yufqzxkbiecj7jot/md/markerSelectors/ompa8292o688a2iu"
}
]
}
}
|
...
| Code Block |
|---|
| title | Example of a marker selector with granularityCategories |
|---|
| collapse | true |
|---|
|
{
"name": "lines_selector",
"type": "markerSelector",
"content": {
"granularityCategories": [
{
"dataset": "/rest/projects/$projectId/md/datasets?name=roads",
"splitPropertyName": "surface",
"styleType": "color",
"itemId": "9403698a1ed0cc2e55fcc27762faa1a3" },
{
"dataset": "/rest/projects/$projectId/md/datasets?name=roads",
"splitPropertyName": "road_class",
"styleType": "pattern",
"itemId": "ee2069d8ebd36700690adbf9875111f1" },
{
"dataset": "/rest/projects/$projectId/md/datasets?name=roads",
"splitPropertyName": "traffic",
"styleType": "weight",
"itemId": "3ddaf8c67841536b91449cf86df0d0ec"
}
]
}
}
|
Each category is linked to the dataset, specified by the property name, and type of the styleType.
...
| Key | Type | Optionality | Description | Constraints |
|---|
dataset | string | | URL link to a dataset object representing the markers | /rest/projects/$projectId/md/datasets?name={datasetName} |
markers | array | | an array of marker objects |
|
linkedLayers | array | | an array of objects specifying layers linked to the marker category | itemId | string | | Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see 7537131 section. | [a-z0-9]{32} |
|
There are two rules surrounding marker selector categories to note:
...
| Key | Type | Optionality | Description | Constraints |
|---|
marker | string | | URI link to a marker object representing marker in a category | /rest/projects/$projectId/md/markers?name={markerName} |
visible | boolean | | sets the default visibility of the marker default = true | [true, false]
|
addOnExpand | boolean | | specifies if the marker should become visible after clicking on the category, when by default it is set to visible = false | [true, false] |
itemId | string | | Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see 7537131 section. | [a-z0-9]{32} |
content.categories.linkedLayers
...
content.categories.linkedLayers
The linkedLayers array contains layers that should be explicitly linked to markerSelector categories. They are represented by dwh datasets of geometryPolygon subtype, which are linked to their respective geometries defined by vt datasets.
...
| Key | Type | Optionality | Description | Constraints |
|---|
dataset | string | | URL link to a dataset object representing the linked layers | /rest/projects/$projectId/md/datasets?name={datasetName} |
style | array | | specifies the style of the layer | [outline, outline_black, line_red_1, line_red_3, line_red_5]
|
visible | boolean | | sets the default visibility of the layer | [true, false] | itemId |
content.granularityCategories.granularityCategory
| Key | Type | Optionality | Description | Constraints |
|---|
dataset | string | |
Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see 7537131 section. | [a-z0-9]{32} | content.granularityCategories.granularityCategory
| Key | Type | Optionality | Description | Constraints |
|---|
dataset | string | | URL link to a dataset object representing URL link to a dataset object representing the linked granularities | /rest/projects/$projectId/md/datasets?name={datasetName} |
splitPropertyName | string | | dataset property, by which the marker will be filtered | {datasetProperty} |
styleType | string | | type of the visualization style | [color, pattern, weight] | itemId | string |
content.keepFiltered
| Key | Type | Optionality | Description | Constraints |
|---|
granularity | boolean | | Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see 7537131 section. | [a-z0-9]{32} |
content.keepFiltered
| Key | Type | Optionality | Description | Constraints |
|---|
granularity | boolean | | specifies if the filtered granularity objects (areasspecifies if the filtered granularity objects (areas, lines...) should be visible when filtered | [true, false] |
markers | boolean | | specifies if the filtered markers should be visible when filtered | [true, false] |
content.**.itemId
Generated ID for this item to be used for matching it within a parent array while rebasing share objects. itemId is genrated as hash from random UUID when given item is being created - either an entire dashboard is being created or an item is being added to MD object content via update. Once itemId is generated it is not supposed to be modified.
IMPORTANT: When interacting with REST API do not provide own generated values as itemId;
...
Visual representation
Marker selectors can be visualised as groups of markers. On this cutout, you can see 2 marker groups - orange and green, each represented by one marker selector.
...