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 | ||||
---|---|---|---|---|
| ||||
{ "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" ], "granularity": "/rest/projects/$projectId/md/datasets?name=ward" } } |
Default values are also available for indicator
filter type. The values
array must contain exactly two values with respect to the data type of the actual indicator, as well as the default granularity
setting.
Info |
---|
To configure |
Example of a globalDate filter with defaultValues set
Code Block | ||||
---|---|---|---|---|
| ||||
{
"type": "globalDate",
"property": "baskets.date_iso",
"defaultValues": {
"startDate": {
"value": "2017-09-24"
},
"endDate": {
"value": "2017-09-30"
}
}
}
|
Default values are also available for globalDate
filter type. The values
array must contain startDate
and endDate
value.
Info |
---|
To configure |
Example of a date filter with defaultValues set
Code Block | ||||
---|---|---|---|---|
| ||||
{
"type": "date",
"property": "baskets.date_iso",
"defaultValues": {
"startDate": {
"value": "2017-09-24"
},
"endDate": {
"value": "2017-09-30"
}
}
}
|
Default values are also available for indicator
date
filter type. The values
array must contain exactly two values with respect to the data type of the actual indicator, as well as the default granularity
settingcontain startDate
and endDate
value.
Info |
---|
To configure |
...
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 available filters applicable to the indicators presented in this view, these filters must not contain | [ ] | ||||||||
defaultActiveFilters | array |
| array of active filters applied to the indicators presented in this view, these filters must contain defaultValues | [ ] | ||||||||
variables | array |
| array of variables filter type | [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 | [indicator] | ||||||||
indicator | string |
| URL link to an indicator object, whose value will be filtered | /rest/projects/$projectId/md/indicators?name= | ||||||||
defaultValues | object | VARIES | object containing default values for the filter See Example of a indicator filter with defaultValues set forbidden when the filter is within required when the filter is within | |||||||||
filterSelection | boolean |
| determines if the filter should be applied also when a marker is selected ( default = | [true, false] |
...
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 | VARIES | object containing default values for the date range filter See Example of a histogram globalDate filter with defaultValues set forbidden when the filter is within required when the filter is within |
...
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 | VARIES | object containing default values for the date range filter See Example of a date filter with defaultValues set forbidden when the filter is within required when the filter is within |
...
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 | VARIES | object containing default values for the histogram filter See Example of a histogram filter with defaultValues set forbidden when the filter is within required when the filter is within |
...
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 | VARIES | object containing default values for the multiselect filtermulti select filter See Example of a multiSelect filter with defaultValues set forbidden when the filter is within required when the filter is within |
...
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 | VARIES | object containing default values for the single select filter See Example of a singleSelect filter with defaultValues set forbidden when the filter is within required when the filter is within |
...
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 | VARIES | object containing default string values for the feature filter see example aboveSee Example of a feature filter with defaultValues set forbidden when the filter is within required when the filter is within |
|
...
Key | Type | Optionality | Description | Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
type | string |
| type identifier, always | [ | ||||||
title | string |
| title of the variables filter | (*) | ||||||
variables | array |
| array of the content. objects |
|
...
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
...