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" }, "mapContextMenu": { "items": [ { "type": "googleSatellite" }, { "type": "googleStreetView" } ] }, "exports": [ { "export": "/rest/projects/$projectId/md/exports?name=grid_export" }, { "export": "/rest/projects/$projectId/md/exports?name=customer_ids_export" }, { "export": "/rest/projects/$projectId/md/exports?name=transaction_ids_export" }, { "export": "/rest/projects/$projectId/md/exports?name=administrative_units_export" } ] , } } | ||||
Code Block | ||||
| ||||
{ "urlexcludeDatasets": "/rest/projects/yufqzxkbiecj7jot/md/views/ktpu83s6lcmnks2c",[ "dumpTime": "2019-02-20T13:11:13Z", "gb2_district", "gb2_ward", "gb2_postcodes_dwh", "gb2_msoas_dwh", "gb2_lsoas_dwh" ] } } |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "url": "/rest/projects/yufqzxkbiecj7jot/md/views/ktpu83s6lcmnks2c", "dumpTime": "2019-02-20T13:11:13Z", "version": "23", "content": { "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" }, "mapContextMenu": { }, "zoomitems": 11,[ "minZoom": 2, { "maxZoom": 18, "type": "googleSatellite" "tileLayer": "mapbox" }, "mapContextMenu": { { "items": [ "type": "googleStreetView" { } "type": "googleSatellite" ] }, }, "exports": [ { { "typeexport": "googleStreetView"/rest/projects/$projectId/md/exports?name=grid_export" }, } { ] "export": "/rest/projects/$projectId/md/exports?name=customer_ids_export" }, "exports": [}, { "export": "/rest/projects/$projectId/md/exports?name=gridtransaction_ids_export" }, { "export": "/rest/projects/$projectId/md/exports?name=customeradministrative_idsunits_export" }, ], { "excludeDatasets": [ "export": "/rest/projects/$projectId/md/exports?name=transaction_ids_export" "gb2_district", }, "gb2_ward", { "gb2_postcodes_dwh", "export": "/rest/projects/$projectId/md/exports?name=administrative_units_export"gb2_msoas_dwh", }"gb2_lsoas_dwh" ] } } } |
Additional syntax examples
...
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 | |||||||||
excludeDatasets | array |
| array of dataset names (not links) to be excluded from the granularity dropdown menu |
content.filterGroup.indicator
...
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 |
|
...
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
...