Page Comparison

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

title	View object syntax

{
    "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",
                "itemId":
"45417c00d9b5d52936b8d2b8300eda63"
            },
            {
                "type": "indicator",
                "indicator": "/rest/projects/$projectId/md/indicators?name=customers_indicator",
                "itemId":
"94014766357838ab645158538ddc6ed0"             },
            {
                "type": "indicator",
                "indicator": "/rest/projects/$projectId/md/indicators?name=purchases_customer_indicator",
            },
    "itemId": "24e8ddcdd7844e39c9654478e2ced317"       {
     },
            {
                "type": "globalDate",
                "property": "baskets.date_iso",
                "defaultValues": {
                    "startDate": {
                        "value": "2018-07-02"
                    },
                    "endDate": {
                        "value": "2018-07-08"
                    }
                },
				"itemId": "489fdd25a2b4534d34bbc443543bdc44"
            },
            {
                "type": "histogram",
                "property": "baskets.amount",
                "format": {
                    "type": "number",
                    "fraction": 0,
                    "symbol": "£"
                },
                "itemId":
"8085b1d3767a7c827438ba353082bcf5"
            },
            {
                "type": "multiSelect",
                "property": "baskets.on_off_name",
                "orderBy": [
                    {
                        "property": "baskets.on_off_name",
                        "direction": "asc"
                    }
                ],
                "itemId":
"7b99d1162eaac08d3e1cad4767f5466b"
            },
            {
                "type": "multiSelect",
                "property": "baskets.courier",
                "orderBy": [
                    {
                        "property": "baskets.courier",
                        "direction": "asc"
                    }
                ],
                "itemId":
"b1da7c3287c81648c9c355bf1ba6df34"             },
            {
                "type": "multiSelect",
                "property": "clients.sex_name",
                "orderBy": [
                    {
                        "property": "clients.sex_name",
                        "direction": "asc"
                    }
                ],
                "itemId":
"78d0d5553ee924d8532515b521fa70f1"             },
            {
                "type": "multiSelect",
                "property": "clients.age_name",
                "orderBy": [
                    {
                        "property": "clients.age_cat",
                        "direction": "asc"
                    }
                ],
            },
    "itemId": "019ad374af348531dae3b6dae90de923"
            },
            {
                "type": "multiSelect",
                "property": "dim_dates_day_of_week.day_of_week_name_en",
                "orderBy": [
                    {
                        "property": "dim_dates_day_of_week.order_en",
                        "direction": "asc"
                    }
                ],
                "itemId": "05f174e2300cee630980bdc3166cce7f"
            }
        ],
        "mapOptions": {
            "center": {
                "lat": 52.478,
                "lng": -1.694
            },
            "zoom": 11,
            "minZoom": 2,
            "maxZoom": 18,
            "tileLayer": "mapbox"
        },
        "mapContextMenu": {
            "items": [
                {
                    "type": "googleSatellite",
                	"itemId": "44b154f493ffb6195f253232446beef7"
                },
                {
                    "type": "googleStreetView",
                	"itemId": "8ac314a472a91c42bfbeac9cf90a30aa"
                }
            ]
        },
        "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"
            }
        ],
        "excludeDatasets": [
            "gb2_district",
            "gb2_ward",
            "gb2_postcodes_dwh",
            "gb2_msoas_dwh",
            "gb2_lsoas_dwh"
        ]
    }
}

...

Code Block

title	Example of a dumped view
collapse	true

{
    "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",
                	"itemId": "45417c00d9b5d52936b8d2b8300eda63"
                },
                {
                    "type": "indicator",
                    "indicator": "/rest/projects/$projectId/md/indicators?name=customers_indicator",
                	"itemId": "94014766357838ab645158538ddc6ed0"
                },},
                    {
                    "type": "indicator",
                    "indicator": "/rest/projects/$projectId/md/indicators?name=purchases_customer_indicator",
                	"itemId":
"24e8ddcdd7844e39c9654478e2ced317"                 },
                {
                    "type": "globalDate",
                    "property": "baskets.date_iso",
                    "defaultValues": {
                        "startDate": {
                            "value": "2018-07-02"
                        },
                        "endDate": {
                            "value": "2018-07-08"
                        }
                    },
                	"itemId":
"8085b1d3767a7c827438ba353082bcf5"                 },
                {
                    "type": "histogram",
                    "property": "baskets.amount",
                    "format": {
                        "type": "number",
                        "fraction": 0,
                        "symbol": "£"
                    },
                	"itemId":
"7b99d1162eaac08d3e1cad4767f5466b"                 },
                {
                    "type": "multiSelect",
                    "property": "baskets.on_off_name",
                    "orderBy": [
                        {
                            "property": "baskets.on_off_name",
                            "direction": "asc"
                        }
                    ],
                	"itemId":
"b1da7c3287c81648c9c355bf1ba6df34"                 },
                {
                    "type": "multiSelect",
                    "property": "baskets.courier",
                    "orderBy": [
                        {
                            "property": "baskets.courier",
                            "direction": "asc"
                        }
                    ],
                	"itemId": "78d0d5553ee924d8532515b521fa70f1"},
                 },
                {{
                     "type": "multiSelect",
                    "property": "clients.sex_name",
                    "orderBy": [
                        {
                            "property": "clients.sex_name",
                            "direction": "asc"
                        }
                    ],
                	"itemId": "78d0d5553ee924d8532515b521fa70f1"
                },
                {
                    "type": "multiSelect",
                    "property": "clients.age_name",
                    "orderBy": [
                        {
                            "property": "clients.age_cat",
                            "direction": "asc"
                        }
                    ],
                	"itemId": "019ad374af348531dae3b6dae90de923"
                },
                {
                    "type": "multiSelect",
                    "property": "dim_dates_day_of_week.day_of_week_name_en",
                    "orderBy": [
                        {
                            "property": "dim_dates_day_of_week.order_en",
                            "direction": "asc"
                        }
                    ],
                	"itemId": "05f174e2300cee630980bdc3166cce7f"
                }
            ],
            "mapOptions": {
                "center": {
                    "lat": 52.478,
                    "lng": -1.694
                },
                "zoom": 11,
                "minZoom": 2,
                "maxZoom": 18,
                "tileLayer": "mapbox"
            },
            "mapContextMenu": {
                "items": [
                    {
                        "type": "googleSatellite",
                		"itemId": "44b154f493ffb6195f253232446beef7"
                    },
                    {
                        "type": "googleStreetView",
                		"itemId": "8ac314a472a91c42bfbeac9cf90a30aa"   }
                ]
}                 ]
            }},
            "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"
                }
            ],
            "excludeDatasets": [
                "gb2_district",
                "gb2_ward",
                "gb2_postcodes_dwh",
                "gb2_msoas_dwh",
                "gb2_lsoas_dwh"
            ]
        }
    }
}

...

Code Block

title	Example of a view with variables filter and mapContextMenu
collapse	true

{
    "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.",
    "content": {
        "icon": "first_place_pedestal",
        "dashboard": "/rest/projects/$projectId/md/dashboards?name=restaurants_rating_dashboard",
        "markerSelector": "/rest/projects/$projectId/md/markerSelectors?name=restaurants_marker_selector",
        "filterGroup": [
            {
                "type": "variables",
                "title": "Restaurant rating index",
                "variables": [
                    {
                        "name": "food_variable",
                        "title": "Food",
                        "minValue": 1,
                        "maxValue": 5,
                        "defaultValue": 5,
                        "format": {
                            "type": "number",
                            "fraction": 0
                        },
                		"itemId": "03684c9a8c6ba1d403b5d70215e02d8f"
                    },
                    {
                        "name": "service_variable",
                        "title": "Service",
                        "minValue": -5,
                        "maxValue": 10,
                        "defaultValue": 1,
                        "format": {
                            "type": "number",
                            "fraction": 0
                        },
                		"itemId":
"7a127e383e1675f8cf1186d35a615458"                     },
                    {
                        "name": "cleanliness_variable",
                        "title": "Cleanliness",
                        "minValue": 1.0,
                        "maxValue": 10.0,
                        "defaultValue": 5.0,
                        "format": {
                            "type": "number",
                            "fraction": 1
                        },
                		"itemId":
"e556bb0cbb145898eaceb8f40386118e"                     }
                ]
            },
            {
                "type": "multiSelect",
                "property": "restaurants.type",
                "orderBy": [
                    {
                        "property": "restaurants.type",
                        "direction": "asc"
                    }
                ],
                "itemId":
"16c3480d69366fd7af366a95d6200516"             },
            {
                "type": "multiSelect",
                "property": "restaurants.cuisine",
                "orderBy": [
                    {
                        "property": "restaurants.cuisine",
                        "direction": "asc"
                    }
                ],
                "itemId": "9a23bda4fecac97cca8254a8cc261c84"}
        ]
    }
}

       ]
    }
}

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.

...

Code Block

title	Example of a indicator filter with defaultValues set
collapse	true

{
    "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"
    },
    "itemId":
"ce46b043522d8b4650c6cb2d1caf12e0"
}

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.

Code Block

title	Example of a histogram filter with defaultValues set
collapse	true

{
    "type": "histogram",
    "property": "baskets.amount",
    "format": {
        "type": "number",
        "fraction": 0,
        "symbol": "£"
    },
    "defaultValues": {
        "values": [
            100.0,
            500.0
        ],
        "nullFiltered": true
    },
    "itemId": "c4bc02a4d19a25e79dfe66e79a5f18ed"
}

Default values are also available for histogram filter type. The values array must contain exactly two integer values. Notice the nullFiltered switch, which filters out null values.

Code Block

title	Example of a multiSelect filter with defaultValues set
collapse	true

{
    "type": "multiSelect",
    "property": "dim_dates_day_of_week.day_of_week_name_en",
    "orderBy": [
        {
            "property": "dim_dates_day_of_week.order_en",
            "direction": "asc"
        }
    ],
    "defaultValues": {
        "values": [
            "Monday",
            "Tuesday",
            "Wednesday",
            "Thursday",
            "Friday"
        ]
    },
    "itemId":
"e063e0ce6509bf5754719ef264d0059a"
}

Default values are also available for multiSelect filter type. The values array must contain at least one string value.

Code Block

title	Example of a singleSelect filter with defaultValues set
collapse	true

{
    "type": "singleSelect",
    "property": "dim_dates_day_of_week.day_of_week_name_en",
    "orderBy": [
        {
            "property": "dim_dates_day_of_week.order_en",
            "direction": "asc"
        }
    ],
    "defaultValues": {
        "value": "Monday"
    },
    "itemId": "ee2069d8ebd36700690adbf9875111f1"
}

Default values are also available for singleSelect filter type. Apart from the value key, the syntax is identical with multiSelect.

Code Block

title	Example of a feature filter with defaultValues set
collapse	true

{
    "type": "feature",
    "dataset": "/rest/projects/$projectId/md/datasets?name=ward",
    "defaultValues": {
        "values": [
            "E05001210",
            "E05001186",
            "E05001215"
        ]
    },
    "itemId":
"9403698a1ed0cc2e55fcc27762faa1a3"
}

Default values are also available for feature filter type. The values array must contain at least one string value. The specified values must be the feature ids (property specified in the dataset's primaryKey).

...

Key Type Optionality Description Constraints

icon

string

Status


colour	Green
title	optional

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

Status


colour	Green
title	optional

specifies the order of the view on the Project page

secondary ordering is by title, alphabetically

x => 1

dashboard

string

Status

colour	Red
title	required

URL link to the dashboard, which the view contains

/rest/projects/$projectId/md/dashboards?name={dashboardName}

markerSelector

string

Status


colour	Green
title	optional

URL link to the marker selector, which the view contains

/rest/projects/$projectId/md/markerSelectors?name={markerSelectorName}

markersOnly

boolean

Status


colour	Green
title	optional

enables the marker only view (see the tutorial)

default = false

[true, false]

showAttributesOnDrill

boolean

Status


colour	Green
title	optional

enables feature attributes visibility after clicking on a indicator drill

[true, false]

defaultGranularity

string

Status


colour	Green
title	optional

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={datasetName}

defaultVisualized

string

Status


colour	Green
title	optional

URL link to the indicator, which will be the visualised by default when entering the view

/rest/projects/$projectId/md/indicators?name={indicatorName}

defaultVisualization

string

Status


colour	Green
title	optional

specifies default visualization selected when entering the view

[areas, grid, zones, heatmap, dotmap, line]

defaultDrilled

string

Status


colour	Green
title	optional

URL link to the indicator, which will be the drilled down to by default when entering the view

/rest/projects/$projectId/md/indicators?name={indicatorName}

defaultTool

string

Status


colour	Green
title	optional

specify a tool which will be active by default when entering the view

search = , filter = , visibility =, measure =

[search, filter, visibility, measure]

defaultCompareType

string

Status


colour	Green
title	optional

specifies default compare type selected when using compare

[dominance, overlap]

filterGroup

array

Status


colour	Green
title	optional

array of filters applicable to the indicators presented in this view

[indicator, globalDate, date, histogram, multiSelect, variables]

spatialQuery

object

Status


colour	Green
title	optional

default spatial query settings (used in heatmap visualization)

x => 1

fitnessGroups

integer

Status


colour	Green
title	optional

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

Status


colour	Green
title	optional

map window settings on the project page

mapContextMenu

object

Status


colour	Green
title	optional

array of objects with definition of 3rd party services available on mouse context click

exports

object

Status


colour	Green
title	optional

array of export references which allows you to define exports per view

measure

object

Status


colour	Green
title	optional

measure tool settings

defaultSelected

object

Status


colour	Green
title	optional

specify objects selected by default when entering the view

excludeDatasets

array

Status


colour	Green
title	optional

array of dataset names (not links) to be excluded from the granularity dropdown menu

...

Key Type Optionality Description Constraints

type

string

Status

colour	Red
title	required

type identifier, always indicator

[indicator]

indicator

string

Status

colour	Red
title	required

URL link to an indicator object, whose value will be filtered

/rest/projects/$projectId/md/indicators?name={indicatorName}

defaultValues

object

Status


colour	Green
title	optional

object containing default values for the filter

filterSelection

boolean

Status


colour	Green
title	optional

determines if the filter should be applied also when a marker is selected (true means apply the filter)

default = false

[true, false]

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 7536836 section.

[a-z0-9]{32}

`content.filterGroup.indicator.defaultValues`

...

Key Type Optionality Description Constraints

type

string

Status

colour	Red
title	required

type identifier, always globalDate

[globalDate]

property

object

Status

colour	Red
title	required

identifier of a dataset property, which will be filtered by date

e.g.: orders.order_date

{datasetName}.{datasetProperty}

defaultValues

object

Status


colour	Green
title	optional

object containing default values for the date range

if present, please note that this will make this filter active all the time

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 7536836 section. [a-z0-9]{32}

content.filterGroup.date

...

content.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.

[a-z0-9]{32}

Key Type Optionality Description Constraints

type

string

Status

colour	Red
title	required

type identifier, always date

[date]

property

object

Status

colour	Red
title	required

identifier of a dataset property, which will be filtered by date

{datasetName}.{datasetProperty}

defaultValues

object

Status


colour	Green
title	optional

object containing default values for the date range

if present, please note that this will make this filter active all the time

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 7536836 section.

`content.filterGroup.globalDate.defaultValues`

...

Key Type Optionality Description Constraints

value

string

Status


colour	Green
title	optional

given value in the ISO 8601 format

format = YYYY-MM-DD

function

object

Status


colour	Green
title	optional

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) − function_interval(1, week)`
the day before two months	`function_today − function_interval(2, month)`
the ending of the last month	`function_date_trunc(today, month) − function_interval(1, day)`

...

string

Key Type Optionality Description Constraints

type

string

Status

colour	Red
title	required

type identifier, always histogram

[histogram]

property

object

Status

colour	Red
title	required

identifier of a dataset property, which the filter will be applied to

{datasetName}.{datasetProperty}

format

object

Status


colour	Green
title	optional

specifies the formatting of the histogram values

see indicator.content.format

defaultValues

object

Status


colour	Green
title	optional

object containing default values for the histogram filter

if present, please note that this will make this filter active all the time

itemId

`content.filterGroup.histogram.defaultValues`

Key Type Optionality Description Constraints

values

array

Status

colour

Redarray of two integers - upper

Key	Type	Optionality	Description	Constraints
`values`	array
Status
colour	Green
title	optional

title
Green

requiredGenerated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see 7536836 section.[a-z0-9]{32}

`content.filterGroup.histogram.defaultValues`

optional

array of two integers - upper and lower default value

size = 2

nullFiltered

boolean

Status


colour	Green
title	optional

specifies if null values should be filtered or not

default = false (null values are present)

[true, false]

...

[a-z0-9]{32}

Key Type Optionality Description Constraints

type

string

Status

colour	Red
title	required

type identifier, always multiSelect

[multiSelect]

property

object

Status

colour	Red
title	required

identifier of a dataset property, which the filter will be applied to

{datasetName}.{datasetProperty}

orderBy

object

Status


colour	Green
title	optional

specifies how to order the multiselect list

defaultValues

object

Status


colour	Green
title	optional

object containing default values for the multiselect filter

if present, please note that this will make this filter active all the time

itemId

string

Status

colour	Red
title	required

Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see 7536836 section.

`content.filterGroup.multiSelect.orderBy`

...

Key Type Optionality Description Constraints

type

string

Status

colour	Red
title	required

type identifier, always singleSelect

[singleSelect]

property

object

Status

colour	Red
title	required

identifier of a dataset property, which the filter will be applied to

{datasetName}.{datasetProperty}

orderBy

object

Status


colour	Green
title	optional

specifies how to order the singleselect list

defaultValues

object

Status


colour	Green
title	optional

object containing one default value for the singleselect filter

itemId

`content.filterGroup.singleSelect.defaultValues`

Key Type Optionality Description Constraints

value

string

Status

colour

Redstring value, that will

Key	Type	Optionality	Description	Constraints
`value`	string
Status
colour	Green
title	optional

title
Green

requiredGenerated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see 7536836 section.[a-z0-9]{32}

`content.filterGroup.singleSelect.defaultValues`

optional

string value, that will be set as default

(*)

`content.filterGroup.variables`

...

Key Type Optionality Description Constraints

type

string

Status

colour	Red
title	required

type identifier, always variables

[variables]

title

string

Status

colour	Red
title	required

title of the variables filter

(*)

variables

array

Status

colour	Red
title	required

array of the content.filterGroup.variables.variable objects

size => 1

...

[a-z0-9]{32}

Ke Type Optionality Description Constraints

name

string

Status

colour	Red
title	required

name of the variable

must match the name of variable used in metrics

(a-z0-9_-)

title

string

Status

colour	Red
title	required

human-readable title of the variable

(*)

minValue

decimal

Status

colour	Red
title	required

minimum value of the variable

maxValue

decimal

Status

colour	Red
title	required

maximum value of the variable

defaultValue

decimal

Status

colour	Red
title	required

default value of the variable

format

object

Status

colour	Red
title	required

specifies the formatting of the variables values

see indicator.content.format

itemId

string

Status

colour	Red
title	required

Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see 7536836 section.

`content.filterGroup.feature`

...

itemId

Key Type Optionality Description Constraints

type

string

Status

colour	Red
title	required

type identifier, always feature

[feature]

dataset

string

Status

colour	Red
title	required

link to a dataset whose features will be filtered

/rest/projects/$projectId/md/datasets?name={datasetName}

defaultValues

object

Status

colour	Red
title	required

object containing default string values for the feature filter

see example above

size => 1

`content.spatialQuery`

Key Type Optionality Description Constraints

profile

string

Status

colour	Red
title	required

Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see 7536836 section.[a-z0-9]{32}

`content.spatialQuery`

Key Type Optionality Description Constraints

profile

string

Status

colour	Red
title	required

profile of profile of the spatial query

[car, bike, foot, air]

unit

string

Status

colour	Red
title	required

unit of the spatial query

[time, distance]

amount

integer

Status

colour	Red
title	required

the size of the query (in meters or minutes, according to unit)

x => 1

...

Key Type Optionality Description Constraints

lat

decimal

Status

colour	Red
title	required

decimal value of the latitude

-90.0 .. +90.0

lng

decimal

Status

colour	Red
title	required

decimal value of the longitue

-180.0 .. +180.0

itemId

string

Status

colour	Red
title	required

Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see 7536836 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

type

string

Status

colour	Red
title	required

type of the clickable item

choose one of the provided services by Google, Mapy.cz or ČÚZK

[googleSatellite, googleStreetView, mapyczOrtophoto, mapyczPanorama, cuzkParcelInfo]

itemId

string

Status

colour	Red
title	required

Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see 7536836 section.

[a-z0-9]{32}

`content.exports`

...

`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

type

string

Status


colour	Green
title	optional

content.**.itemIdtype of the measure

[line, isoline]

points

array

Status


colour	Yellow
title	VARIES

array of points for line measure

either points or zones can be specified

size => 1

zones

array

Status


colour	Yellow
title	VARIES

array of zones for isoline measure

either points or zones can be specified

size => 1

...

Key Type Optionality Description Constraints

lat

decimal

Status

colour	Red
title	required

decimal value of the point's latitude

-90.0 .. +90.0

lng

decimal

Status

colour	Red
title	required

decimal value of the point's longitude

-180.0 .. +180.0

itemId

string

Status

colour	Red
title	required

Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see 7536836 section.

[a-z0-9]{32}

`content.measure.zones`

itemId

Key Type Optionality Description Constraints

lat

decimal

Status

colour	Red
title	required

decimal value of the point's latitude

-90.0 .. +90.0

lng

decimal

Status

colour	Red
title	required

decimal value of the point's longitude

-180.0 .. +180.0

profile

string

Status

colour	Red
title	required

profile of the isochrone

[car, bike, foot, air]

unit

string

Status

colour	Red
title	required

unit of the isochrone

[time, distance]

amount

integer

Status

colour	Red
title	required

amount of units of the isochrone

x => 1

`content.defaultSelected`

Specifies selected objects and selected coordinates when entering the view.

link to a dataset

Key	Type	Optionality	Description	Constraints
`dataset`	string
Key	Type	Optionality	Description	Constraints
`dataset`	string
Status
colour	Green
title	optional

Status


colour	RedGreen
title	required

Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see 7536836 section.[a-z0-9]{32}

`content.defaultSelected`

Specifies selected objects and selected coordinates when entering the view.

optional

link to a dataset whose features will be filtered

/rest/projects/$projectId/md/datasets?name={datasetName}

ids

array

Status


colour	Green
title	optional

array of object ids which will be selected

coordinates

array

Status


colour	Green
title	optional

array of objects with "lat" and "lng"

size => 1

itemId

string

Status

colour	Red
title	required

Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see 7536836 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.

IMPORTANT: When interacting with REST API do not provide own generated values as itemId;

...

Visual representation

View icons

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
Image Modified	Image Modified	Image Modified	Image Modified	Image Modified	Image Modified	Image Modified	Image Modified	Image Modified	Image Modified