...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
View is a visualization of certain theme using a set of related indicators and groups of objects (markers or areas) displayed on a map. View also contains the definition of filters.
It is linked to dashboards and marker selectors. Each view references exactly one dashboard and exactly one marker selector.
...
| Key | Type | Optionality | Description | Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
icon | string |
| identifier of the view icon as shown on the project page see the available icons below | ["catchment_area", "atm_cash_machine", "city_buildings", "credit_cards", "customer_intelligence", "diagram_chart", "fast_delivery", "first_place_pedestal", "hourglass_sandclock", "location_mark", "market_potential", "market_trends", "market_vision", "optimism_and_happiness", "packaging_box", "performance_method", "rent_a_house", "road_route", "shopping_cart", "tactical_advantage", "venture_capital", "wealth_accumulation", "workgroup_people"] | ||||||||
order | integer |
| specifies the order of the view on the Project page secondary ordering is by | x => 1 | ||||||||
dashboard | string |
| URL link to the dashboard, which the view contains | /rest/projects/$projectId/md/dashboards?name= | ||||||||
markerSelector | string |
| URL link to the marker selector, which the view contains | /rest/projects/$projectId/md/markerSelectors?name= | ||||||||
markersOnly | boolean |
| enables the marker only view (see the tutorial) default = | [true, false] | ||||||||
showAttributesOnDrill | boolean |
| enables feature attributes visibility after clicking on a indicator drill | [true, false] | ||||||||
defaultGranularity | string |
| URL link to the dataset, which will be the selected as the default granularity level when entering the view | /rest/projects/$projectId/md/datasets?name= | ||||||||
defaultVisualized | string |
| URL link to the indicator, which will be the visualised by default when entering the view | /rest/projects/$projectId/md/indicators?name= | ||||||||
defaultVisualization | string |
| specifies default visualization selected when entering the view | [areas, grid, zones, heatmap, dotmap, line] | ||||||||
defaultDrilled | string |
| URL link to the indicator, which will be the drilled down to by default when entering the view | /rest/projects/$projectId/md/indicators?name= | ||||||||
defaultTool | string |
| specify a tool which will be active by default when entering the view search = | [search, filter, visibility, | ||||||||
defaultCompareType | string |
| specifies default compare type selected when using compare | [dominance, overlap] | ||||||||
filterGroup | array |
| array of filters applicable to the indicators presented in this view | [variables] | ||||||||
spatialQuery | object |
| default spatial query settings (used in heatmap visualization) | x => 1 | ||||||||
fitnessGroups | integer |
| specifies the number of indicator fitness segments this setting's scope is view, so it will affect all indicators in the view | [3, 5] | ||||||||
mapOptions | object |
| map window settings on the project page | |||||||||
mapContextMenu | object |
| array of objects with definition of 3rd party services available on mouse context click | |||||||||
exports | object |
| array of export references which allows you to define exports per view | |||||||||
measure | object |
| measure tool settings | |||||||||
defaultSelected | object |
| specify objects selected by default when entering the view | |||||||||
excludeDatasets | array |
| array of dataset names (not links) to be excluded from the granularity dropdown menu |
...
| Key | Type | Optionality | Description | Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
type | string |
| type identifier, always | [globalDate] | ||||||||
property | object |
| identifier of a dataset property, which will be filtered by date e.g.: | {datasetName}.{ | ||||||||
defaultValues | object |
| object containing default values for the date range
| |||||||||
itemId | string | REQUIRED | Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see content.**.itemId section. | [a-z0-9]{32} |
if present, please note that this will make this filter active all the timecontent.filterGroup.date
Allows to set from-to filter for multiple date attributes (year, month, week, day, hour...). It has identical syntax with the globalDate filter.
| Key | Type | Optionality | Description | Constraints | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
type | string |
| type identifier, always | [date] | |||||||
property | object |
| identifier of a dataset property, which will be filtered by date | {datasetName}.{ | |||||||
defaultValues | object |
| object containing default values for the date range
|
content.filterGroup.globalDate.defaultValues
content.filterGroup.date.defaultValues
itemId | string | REQUIRED | Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see content.**.itemId section. | [a-z0-9]{32} |
content.filterGroup.globalDate.defaultValues
content.filterGroup.date.defaultValues
| Key | Type | Optionality | Description | Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
startDate | object |
| an object containing either | |||||||||
endDate | object |
| an object containing either value or function that specifies the end date |
...
| Key | Type | Optionality | Description | Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
value | string |
| given value in the ISO 8601 format |
| ||||||||
function | object |
| a function object defining an interval of a relative date filter |
...
| Date range | Definition syntax |
|---|---|
| the day before 30 days | function_today − function_interval(30, day) |
| the beginning of the current week | function_date_trunc(today, week) |
the beginning of last week | function_date_trunc(today, week) |
| the day before two months | function_today − function_interval(2, month) |
| the ending of the last month | function_date_trunc(today, |
...
| Key | Type | Optionality | Description | Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
type | string |
| type identifier, always | [histogram] | ||||||||
property | object |
| identifier of a dataset property, which the filter will be applied to | {datasetName}.{ | ||||||||
format | object |
| specifies the formatting of the histogram values | |||||||||
defaultValues | object |
| object containing default values for the histogram filter
| |||||||||
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 content.**.itemId section. | [a-z0-9]{32} |
content.filterGroup.histogram.defaultValues
...
When there is more than 10 items, a search bar is added. The maximum count of filterable records is 20 000.
| Key | Type | Optionality | Description | Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
type | string |
| type identifier, always | [ | ||||||||
property | object |
| identifier of a dataset property, which the filter will be applied to | {datasetName}.{ | ||||||||
orderBy | object |
| specifies how to order the multiselect list | |||||||||
defaultValues | object |
| object containing default values for the multiselect filter
|
content.filterGroup.multiSelect.orderBy
Specifies the ordering of elements in a multiSelect filter.
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 content.**.itemId section. | [a-z0-9]{32} |
content.filterGroup.multiSelect.orderBy
Specifies the ordering of elements in a multiSelect filter.
| Key | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
property | string |
| identifier of a dataset property, by which the list will be ordered | {datasetName}.{ | ||||||
direction | string |
| sort direction default = | [asc, desc] |
...
| Key | Type | Optionality | Description | Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
type | string |
| type identifier, always | [ | ||||||||
property | object |
| identifier of a dataset property, which the filter will be applied to | {datasetName}.{ | ||||||||
orderBy | object |
| specifies how to order the singleselect list | |||||||||
defaultValues | object |
| object containing one default value for the singleselect filter | |||||||||
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 content.**.itemId section. | [a-z0-9]{32} |
content.filterGroup.singleSelect.defaultValues
...
| Key | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
type | string |
| type identifier, always | [ | ||||||
title | string |
| title of the variables filter | (*) | ||||||
variables | array |
| array of the content.filterGroup.variables.variable objects | |
...
| Ke | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
name | string |
| name of the variable must match the name of variable used in metrics | (a-z0-9_-) | ||||||
title | string |
| human-readable title of the variable | (*) | ||||||
minValue | decimal |
| minimum value of the variable | |||||||
maxValue | decimal |
| maximum value of the variable | |||||||
defaultValue | decimal |
| default value of the variable | |||||||
format | object |
| specifies the formatting of the variables values |
content.filterGroup.feature
...
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 content.**.itemId section. | [a-z0-9]{32} |
content.filterGroup.feature
Allows you to set selected objects in the map (markers, areas, polygons, lines...).
| Key | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
type | string |
| type identifier, always | [ | ||||||
| string |
| link to a dataset whose features will be filtered | /rest/projects/$projectId/md/datasets?name= | ||||||
defaultValues | object |
| object containing default string values for the feature filter see example above | | ||||||
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 content.**.itemId section. | [a-z0-9]{32} |
content.spatialQuery
| Key | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
profile | string |
| profile of the spatial query | [car, bike, foot, air] | ||||||
unit | string |
| unit of the spatial query | [time, distance] | ||||||
amount | integer |
| the size of the query (in meters or minutes, according to unit) | |
...
| Key | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
lat | decimal |
| decimal value of the latitude | -90.0 .. +90.0 | ||||||
lng | decimal |
| decimal value of the longitue | -180.0 .. +180.0 |
content.mapContextMenu
The mapContextMenu object allows you to define the content of context menu after using right click in the map.
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 content.**.itemId section. | [a-z0-9]{32} |
content.mapContextMenu
The mapContextMenu object allows you to define the content of context menu after using right click in the map.
| Key | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
items | array |
| array of map context menu items |
...
| Key | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
type | string |
| type of the clickable item choose one of the provided services by Google, Mapy.cz or ČÚZK | [googleSatellite, googleStreetView, mapyczOrtophoto, mapyczPanorama, cuzkParcelInfo] | ||||||
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 content.**.itemId section. | [a-z0-9]{32} |
content.exports
Allows you to define list of export objects which will be available after using the Export function available from the Menu ().
...
| Key | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
lat | decimal |
| decimal value of the point's latitude | -90.0 .. +90.0 | ||||||
lng | decimal |
| decimal value of the point's longitude | -180.0 .. +180.0 |
content.measure.zones
| Key | Type | 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 content.**.itemId section. | [a-z0-9]{32} |
|---|
content.measure.zones
| Key | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
lat | decimal |
| decimal value of the point's latitude | -90.0 .. +90.0 | ||||||
lng | decimal |
| decimal value of the point's longitude | -180.0 .. +180.0 | ||||||
profile | string |
| profile of the isochrone | [car, bike, foot, air] | ||||||
unit | string |
| unit of the isochrone | [time, distance] | ||||||
amount | integer |
| amount of units of the isochrone | | ||||||
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 content.**.itemId section. | [a-z0-9]{32} |
content.defaultSelected
Specifies selected objects and selected coordinates when entering the view.
| Key | Type | Optionality | Description | Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
dataset | string |
| link to a dataset whose features will be filtered | /rest/projects/$projectId/md/datasets?name= | ||||||||
ids | array |
| array of object ids which will be selected | |||||||||
coordinates | array |
| array of objects with "lat" and "lng" | | ||||||||
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 content.**.itemId section. | [a-z0-9]{32} |
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.
...
This is the available view icon palette.
| atm_cash_machine | catchment_area | city_buildings | credit_cards | customer_intelligence | diagram_chart | fast_delivery | first_place_pedestal | hourglass_sandclock | location_mark |
|
|
|
|
|
|
|
|  |
|
| market_potential | market_trends | market_vision | optimism_and_happiness | packaging_box | performance_method | rent_a_house | road_route | shopping_cart | tactical_advantage |
|
|  |
|  |  |  |  |  |  |
| venture_capital | wealth_accumulation | workgroup_people |
 |  |  |
Views displayed on the project page
...