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.
...
Code Block | ||||
---|---|---|---|---|
| ||||
{ "name": "catchment_area_view", "type": "view", "title": "Catchment Area Analysis", "description": "Identify areas with the biggest and smallest shares of your customers. Find out what turnover these customers generate. Evaluate store rankings and identify the pick-up partners used by customers from different regions. You can also compare the catchment areas for two different stores.", "content": { "icon": "performance_method", "order": 1, "dashboard": "/rest/projects/$projectId/md/dashboards?name=catchment_area_dashboard", "markerSelector": "/rest/projects/$projectId/md/markerSelectors?name=shops_marker_selector", "defaultGranularity": "/rest/projects/$projectId/md/datasets?name=ward", "defaultVisualized": "/rest/projects/$projectId/md/indicators?name=turnover_indicator", "filterGroup": [ { "type": "indicator", "indicator": "/rest/projects/$projectId/md/indicators?name=turnover_indicator" }, { "type": "indicator", "indicator": "/rest/projects/$projectId/md/indicators?name=customers_indicator" }, { "type": "indicator", "indicator": "/rest/projects/$projectId/md/indicators?name=purchases_customer_indicator" }, { "type": "globalDate", "property": "baskets.date_iso", "defaultValues": { "startDate": { "value": "2018-07-02" }, "endDate": { "value": "2018-07-08" } } }, { "type": "histogram", "property": "baskets.amount", "format": { "type": "number", "fraction": 0, "symbol": "£" } }, { "type": "multiSelect", "property": "baskets.on_off_name", "orderBy": [ { "property": "baskets.on_off_name", "direction": "asc" } ] }, { "type": "multiSelect", "property": "baskets.courier", "orderBy": [ { "property": "baskets.courier", "direction": "asc" } ] }, { "type": "multiSelect", "property": "clients.sex_name", "orderBy": [ { "property": "clients.sex_name", "direction": "asc" } ] }, { "type": "multiSelect", "property": "clients.age_name", "orderBy": [ { "property": "clients.age_cat", "direction": "asc" } ] }, { "type": "multiSelect", "property": "dim_dates_day_of_week.day_of_week_name_en", "orderBy": [ { "property": "dim_dates_day_of_week.order_en", "direction": "asc" } ] } ], "mapOptions": { "center": { "lat": 52.478, "lng": -1.694 }, "zoom": 11, "minZoom": 2, "maxZoom": 18, "tileLayer": "mapbox" }, } } | ||||
Code Block | ||||
| ||||
{ "urlmapContextMenu": "/rest/projects/yufqzxkbiecj7jot/md/views/ktpu83s6lcmnks2c", { "dumpTime": "2019-02-20T13:11:13Z", "versionitems": "23", [ "content": { { "id": "ktpu83s6lcmnks2c", "name": "catchment_area_view", "type": "viewgoogleSatellite", "title": "Catchment Area Analysis", }, "description": "Identify areas with the biggest and smallest shares of your customers. Find out{ what turnover these customers generate. Evaluate store rankings and identify the pick-up partners used by customers from different regions. You can also compare the catchment areas for two different stores.","type": "googleStreetView" } ] "content": { }, "iconexports": "performance_method",[ { "order": 1, "dashboardexport": "/rest/projects/$projectId/md/dashboardsexports?name=catchmentgrid_area_dashboard",export" }, { "markerSelector": "/rest/projects/$projectId/md/markerSelectors?name=shops_marker_selector", "defaultGranularityexport": "/rest/projects/$projectId/md/datasetsexports?name=wardcustomer_ids_export", "filterGroup": [}, { "typeexport": "indicator", "indicator": "/rest/rest/projects/$projectId/md/indicatorsexports?name=turnovertransaction_ids_indicatorexport" }, }, { { "export": "/rest/projects/$projectId/md/exports?name=administrative_units_export" "type": "indicator", } ] } } |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "indicatorurl": "/rest/projects/$projectIdyufqzxkbiecj7jot/md/indicators?name=customers_indicator"/views/ktpu83s6lcmnks2c", "dumpTime": "2019-02-20T13:11:13Z", "version": "23", }, "content": { "name": "catchment_area_view", "type": "indicatorview", "title": "Catchment Area Analysis", "indicatordescription": "/rest/projects/$projectId/md/indicators?name=purchases_customer_indicator" }, { Identify areas with the biggest and smallest shares of your customers. Find out what turnover these customers generate. Evaluate store rankings and identify the pick-up partners used by customers from different regions. You can also compare the catchment areas for two different stores.", "typecontent": "globalDate",{ "property": "baskets.date_iso"icon": "performance_method", "defaultValues"order": {1, "dashboard": "/rest/projects/$projectId/md/dashboards?name=catchment_area_dashboard", "startDatemarkerSelector": {"/rest/projects/$projectId/md/markerSelectors?name=shops_marker_selector", "defaultGranularity": "/rest/projects/$projectId/md/datasets?name=ward", "valuedefaultVisualized": "2018-07-02"/rest/projects/$projectId/md/indicators?name=turnover_indicator", "filterGroup": [ }, { "endDatetype": {"indicator", "indicator": "/rest/projects/$projectId/md/indicators?name=turnover_indicator" "value": "2018-07-08" }, { } }"type": "indicator", }, "indicator": "/rest/projects/$projectId/md/indicators?name=customers_indicator" { }, "type": "histogram", { "propertytype": "baskets.amountindicator", "formatindicator": {"/rest/projects/$projectId/md/indicators?name=purchases_customer_indicator" }, "type": "number", { "fractiontype": 0, "globalDate", "symbolproperty": "£baskets.date_iso", }"defaultValues": { }, "startDate": { "type": "multiSelect", "propertyvalue": "baskets.on_off_name", 2018-07-02" "orderBy": [ }, { "property": "baskets.on_off_name","endDate": { "directionvalue": "asc2018-07-08" } ]} }, { "type": "multiSelecthistogram", "property": "baskets.courieramount", "orderByformat": [{ { "type": "number", "propertyfraction": "baskets.courier"0, "directionsymbol": "asc£" } ] }, { "type": "multiSelect", "property": "clientsbaskets.sexon_off_name", "orderBy": [ { "property": "clientsbaskets.sexon_off_name", "direction": "asc" } ] }, { "type": "multiSelect", "property": "clientsbaskets.age_namecourier", "orderBy": [ { "property": "clientsbaskets.age_catcourier", "direction": "asc" } ] }, { "type": "multiSelect", "property": "dim_dates_day_of_week.day_of_week_name_enclients.sex_name", "orderBy": [ { "property": "dim_dates_day_of_week.order_enclients.sex_name", "direction": "asc" } ] }, ], { "mapOptions": { "centertype": {"multiSelect", "latproperty": 52.478"clients.age_name", "lngorderBy": -1.694 [ }, { "zoom": 11, "minZoomproperty": 2"clients.age_cat", "maxZoom": 18, "tileLayer"direction": "mapboxasc" } }, } "accessInfo": { "createdAt": "2017-10-05T08:27:10Z", ] "modifiedAt": "2019-02-13T15:42:33Z" }, "links": [ { { "reltype": "selfmultiSelect", "hrefproperty": "/rest/projects/yufqzxkbiecj7jot/md/views/ktpu83s6lcmnks2c"dim_dates_day_of_week.day_of_week_name_en", } ]"orderBy": [ } } |
Additional syntax examples
Code Block | ||||
---|---|---|---|---|
| ||||
{ "name": "restaurants_rating_view", "type": "view", { "title": "Restaurants rating", "description": "This view provides an overview of all restaurants and ranks them by a weighted index.", "contentproperty": {"dim_dates_day_of_week.order_en", "icon": "first_place_pedestal", "dashboard": "/ "direction": "asc" } ] } ], "mapOptions": { "center": { "lat": 52.478, "lng": -1.694 }, "zoom": 11, "minZoom": 2, "maxZoom": 18, "tileLayer": "mapbox" }, "mapContextMenu": { "items": [ { "type": "googleSatellite" }, { "type": "googleStreetView" } ] }, "exports": [ { "export": "/rest/projects/$projectId/md/exports?name=grid_export" }, { "export": "/rest/projects/$projectId/md/dashboards?name=restaurants_rating_dashboard",exports?name=customer_ids_export" }, { "markerSelectorexport": "/rest/projects/$projectId/md/markerSelectorsexports?name=restaurantstransaction_markerids_selectorexport", "filterGroup": [ }, { { "type": "variables", "titleexport": "Restaurant rating index",/rest/projects/$projectId/md/exports?name=administrative_units_export" "variables":} [ ] {} } } |
Additional syntax examples
Code Block | ||||
---|---|---|---|---|
| ||||
{ "name": "food_variable", restaurants_rating_view", "type": "view", "title": "FoodRestaurants rating", "description": "This view provides an overview of all restaurants and ranks them by a weighted index.", "minValuecontent": 1,{ "icon": "first_place_pedestal", "dashboard": "/rest/projects/$projectId/md/dashboards?name=restaurants_rating_dashboard", "maxValuemarkerSelector": 5"/rest/projects/$projectId/md/markerSelectors?name=restaurants_marker_selector", "filterGroup": [ "defaultValue": 5,{ "type": "variables", "format": { "title": "Restaurant rating index", "typevariables": "number",[ { "fraction": 0 "name": "food_variable", } "title": "Food", }, {"minValue": 1, "namemaxValue": "service_variable"5, "titledefaultValue": "Service"5, "minValueformat": -5,{ "maxValuetype": 10"number", "defaultValue": 1, "fraction": 0 "format": { } }, "type": "number", { "fraction": 0 "name": "service_variable", } "title": "Service", }, {"minValue": -5, "namemaxValue": "cleanliness_variable"10, "titledefaultValue": "Cleanliness"1, "minValueformat": 1.0, { "maxValuetype": 10.0,"number", "defaultValuefraction": 5.0,0 } "format": { }, "type": "number", { "fractionname": 1"cleanliness_variable", } "title": "Cleanliness", } "minValue": 1.0, ] }, "maxValue": 10.0, { "typedefaultValue": "multiSelect"5.0, "property": "restaurants.type", "format": { "orderBy": [ "type": "number", { "propertyfraction": "restaurants.type",1 "direction": "asc" } } ] }, { "type": "multiSelect", "property": "restaurants.cuisinetype", "orderBy": [ { "property": "restaurants.cuisinetype", "direction": "asc" } ] }, { ], "mapContextMenutype": {"multiSelect", "items": [ "property": "restaurants.cuisine", { "orderBy": [ "type": "googleSatellite" { }, "property": "restaurants.cuisine", { "typedirection": "googleStreetViewasc" } ] ] } }] } } |
Example of a view with the variables
filter type. This filter allows you to set unique variables used in metrics. In this example, it allows you to tweak different aspects of some index.
The mapContextMenu
object allows you to define the content of context menu after using right click in the map. See more below.
.
Code Block | ||||
---|---|---|---|---|
| ||||
{ "type": "indicator", "indicator": "/rest/projects/$projectId/md/indicators?name=turnover_indicator", "defaultValues": { "values": [ 10000.0, 500000.0 ], "granularity": "/rest/projects/$projectId/md/datasets?name=ward" } } |
...
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 = , filter = , visibility =, measure = | [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 |
...
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 | [ | ||||||||
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 if present, please note that this will make this filter active all the time |
...
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 |
|
...
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 |
|
...
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] |
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 | ||||||
---|---|---|---|---|---|---|---|---|---|---|
| string |
| link to an export which will be available in the view | /rest/projects/$projectId/md/exports?name= |
content.measure
This object allows you to set the settings of measure tool. The settings is available for line
and isoline
measure.
...
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
...