Skip to main content
Skip table of contents

Views

View is a visualization of a 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.

Views are linked from project settings defaultViews array. When the view is present there, it is shown to all project members on the project page. It is shown to view the creator only otherwise.

See views and filters in action in the Features Catalog for Developers project. 

Syntax

This is the Catchment Area view of the Retail Solution Demo project.

You can see that the view contains a fitting description and title. It is linked with its dashboard and a marker selector. It also contains a number of filters, defined in the filterGroup array. In the end, in the mapOptions object, various map window settings - such as map center, or zoom limits can be defined.

View object syntax
CODE 
{
    "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",
        "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",
        "compareCollapsed": false,
        "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"
            },
            {
                "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"
                    }
                ]
            }
        ],
		"defaultActiveFilters": [
			{
                "type": "globalDate",
                "property": "baskets.date_iso",
                "defaultValues": {
                    "startDate": {
                        "value": "2018-07-02"
                    },
                    "endDate": {
                        "value": "2018-07-08"
                    }
                }
            }
		],
        "mapOptions": {
            "center": {
                "lat": 52.478,
                "lng": -1.694
            },
            "zoom": 11,
            "minZoom": 2,
            "maxZoom": 18,
            "tileLayer": "mapbox"
        },
        "mapContextMenu": {
            "items": [
                {
                    "type": "googleSatellite"
                },
                {
                    "type": "googleStreetView"
                },
                {
                    "type": "googleEarth"
                }
            ]
        },
        "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"
        ]
    }
}


Example of a dumped view
CODE 
{
    "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",
            "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"
                },
                {
                    "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"
                        }
                    ]
                }
            ],
			"defaultActiveFilters": [
				{
                    "type": "globalDate",
                    "property": "baskets.date_iso",
                    "defaultValues": {
                        "startDate": {
                            "value": "2018-07-02"
                        },
                        "endDate": {
                            "value": "2018-07-08"
                        }
                    }
                }
			],
            "mapOptions": {
                "center": {
                    "lat": 52.478,
                    "lng": -1.694
                },
                "zoom": 11,
                "minZoom": 2,
                "maxZoom": 18,
                "tileLayer": "mapbox"
            },
            "mapContextMenu": {
                "items": [
                    {
                        "type": "googleSatellite"
                    },
                    {
                        "type": "googleStreetView"
                    },
                    {
                        "type": "googleEarth"
                    }
                ]
            },
            "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"
            ]
        }
    }
}

Additional syntax examples

Example of a view with variables filter and mapContextMenu
CODE 
{
    "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": "multiSelect",
                "property": "restaurants.type",
                "orderBy": [
                    {
                        "property": "restaurants.type",
                        "direction": "asc"
                    }
                ]
            },
            {
                "type": "multiSelect",
                "property": "restaurants.cuisine",
                "orderBy": [
                    {
                        "property": "restaurants.cuisine",
                        "direction": "asc"
                    }
                ]
            }
        ],
		"variables": [
			{
                "type": "variables",
                "title": "Restaurant rating index",
                "variables": [
                    {
                        "name": "food_variable",
                        "title": "Food",
                        "minValue": 1,
                        "maxValue": 5,
                        "defaultValue": 5,
                        "format": {
                            "type": "number",
                            "fraction": 0
                        }
                    },
                    {
                        "name": "service_variable",
                        "title": "Service",
                        "minValue": -5,
                        "maxValue": 10,
                        "defaultValue": 1,
                        "format": {
                            "type": "number",
                            "fraction": 0
                        }
                    },
                    {
                        "name": "cleanliness_variable",
                        "title": "Cleanliness",
                        "minValue": 1.0,
                        "maxValue": 10.0,
                        "defaultValue": 5.0,
                        "format": {
                            "type": "number",
                            "fraction": 1
                        }
                    }
                ]
            }
		]
    }
}

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.

To configure defaultValues for the filter first copy the filter to defaultActiveFilters array and then add defaultValues to this copy.

Example of a indicator filter with defaultValues set
CODE 
{
    "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"
    }
}

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.

To configure defaultValues for the filter first copy the filter to defaultActiveFilters array and then add defaultValues to this copy.

Example of a globalDate filter with defaultValues set
CODE 
{
	"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.

To configure defaultValues for the filter first copy the filter to defaultActiveFilters array and then add defaultValues to this copy.

Example of a date filter with defaultValues set
CODE 
{
	"type": "date",
	"property": "baskets.date_iso",
	"defaultValues": {
		"startDate": {
			"value": "2017-09-24"
		},
		"endDate": {
			"value": "2017-09-30"
		}
	}
}

Default values are also available for date filter type. The values array must contain startDate and endDate values.

To configure defaultValues for the filter first copy the filter to defaultActiveFilters array and then add defaultValues to this copy.

Example of a histogram filter with defaultValues set
CODE 
{
    "type": "histogram",
    "property": "baskets.amount",
    "format": {
        "type": "number",
        "fraction": 0,
        "symbol": "£"
    },
    "defaultValues": {
        "values": [
            100.0,
            500.0
        ],
        "nullFiltered": true
    }
}

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

To configure defaultValues for the filter first copy the filter to defaultActiveFilters array and then add defaultValues to this copy.

Example of a multiSelect filter with defaultValues set
CODE 
{
    "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"
        ]
    }
}

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

To configure defaultValues for the filter first copy the filter to defaultActiveFilters array and then add defaultValues to this copy.

Example of a singleSelect filter with defaultValues and compared set
CODE 
{
    "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"
    },
    "compared": true
}

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

To configure defaultValues for the filter first copy the filter to defaultActiveFilters array and then add defaultValues to this copy.

Example of a feature filter with defaultValues set
CODE 
{
    "type": "feature",
    "dataset": "/rest/projects/$projectId/md/datasets?name=ward",
    "defaultValues": {
        "values": [
            "E05001210",
            "E05001186",
            "E05001215"
        ]
    }
}

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

To configure defaultValues for the filter first copy the filter to defaultActiveFilters array and then add defaultValues to this copy.

Key description

content

Key

Type

Optionality

Description

Constraints

icon

string

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"]

dashboard

string

REQUIRED

URL link to the dashboard, which the view contains

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

markerSelector

string

OPTIONAL

URL link to the marker selector, which the view contains

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

markersOnly

boolean

OPTIONAL

enables the marker only view (see the tutorial)

default = false

[true, false]

showAttributesOnDrill

boolean

OPTIONAL

enables feature attributes visibility after clicking on a indicator drill

[true, false]

defaultGranularity

string

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

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

OPTIONAL

specifies default visualization selected when entering the view

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

defaultDrilled

string

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

OPTIONAL

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

search = search-icon.png, filter = filter-icon.png, measure = measure-icon.png

[search, filter, measure]

defaultCompareType

string

OPTIONAL

specifies whether dominance is visualized when using compare

NOTE: This key used to be a string with more options and could be now a boolean with a more accurate name, however, it is planned for removal and therefore, for simplicity, it remains a string with allowed values: ["dominance", null]

[dominance]

compareCollapsed

boolean

OPTIONAL

specifies whether compare table is collapsed when entering the view,

if not specified then compare table is not collapsed by default

[true, false]

filterGroup

array

OPTIONAL

array of available filters applicable to the indicators presented in this view

[indicator, globalDate, date, histogram, multiSelect]

defaultActiveFilters

array

OPTIONAL

array of active filters applied to the indicators presented in this view, these filters must contain defaultValues

[indicator, globalDate, date, histogram, multiSelect]

variables

array

OPTIONAL

array of variables filter type

[variables]

spatialQuery

object

OPTIONAL

default spatial query settings (used in heatmap visualization)

x => 1

fitnessGroups

integer

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

OPTIONAL

map window settings on the project page


mapContextMenu

object

OPTIONAL

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


exports

object

OPTIONAL

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


measure

object

OPTIONAL

measure tool settings


defaultSelected

object

OPTIONAL

specify objects selected by default when entering the view


excludeDatasets

array

OPTIONAL

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


disableFitness

boolean

OPTIONAL

disables fitness for view (more about fitness)

default = false

[true, false]

content.filterGroup.indicator

content.defaultActiveFilters.indicator

The indicator filter allows you to filter areas based on the values of various indicators present in the view's dashboard.

They are located in the Filters filter-icon.png tool, as well as all other filters (except globalDate).

Default values can be set in the defaultValues object. And since indicator filters can have different results on different granularities, default granularity can be set as well.

Key

Type

Optionality

Description

Constraints

type

string

REQUIRED

type identifier, always indicator

[indicator]

indicator

string

REQUIRED

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

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

defaultValues

object

VARIES

object containing default values for the filter

See Example of a indicator filter with defaultValues set

not used when the filter is within filterGroup

required when the filter is within defaultActiveFilters


filterSelection

boolean

OPTIONAL

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

default = false

[true, false]

content.defaultActiveFilters.indicator.defaultValues

Cross-key constraints

values != null or breaks != null or displayIntervals != null or granularity != null

Key

Type

Optionality

Description

Constraints

values

decimal

VARIES

array of two decimals - maximum and minimum value of the filter

size = 2

breaks

array

VARIES

array of distribution break values (integer or decimal)

size > 0

displayIntervals

array

VARIES

specifies which break intervals are filtered. Intervals are indexed by integer number from 0. An empty field means that all data is filtered out.

Example of indicator filter matching values in interval <0,100> && <200,300>:

breaks=[0,100,200,300]

displayIntervals=[0,2]

granularity

string

VARIES

URL link to a dataset object, which will be the default granularity option

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

content.filterGroup.globalDate

content.defaultActiveFilters.globalDate

Defines a property, which will filter the whole time frame.

It can be set by the date picker in the top left corner of the map window.

Key

Type

Optionality

Description

Constraints

type

string

REQUIRED

type identifier, always globalDate

[globalDate]

property

object

REQUIRED

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

e.g.: orders.order_date

{datasetName}.{datasetProperty}

defaultValues

object

VARIES

object containing default values for the date range filter

See Example of a globalDate filter with defaultValues set

not used when the filter is within filterGroup

required when the filter is within defaultActiveFilters


content.filterGroup.date

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

REQUIRED

type identifier, always date

[date]

property

object

REQUIRED

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

{datasetName}.{datasetProperty}

defaultValues

object

VARIES

object containing default values for the date range filter

See Example of a date filter with defaultValues set

not used when the filter is within filterGroup

required when the filter is within defaultActiveFilters


content.defaultActiveFilters.globalDate.defaultValues

content.defaultActiveFilters.date.defaultValues

Cross-key constraints

startDate != null or endDate != null

Key

Type

Optionality

Description

Constraints

startDate

object

VARIES

an object containing either value or function that specifies the start date


endDate

object

VARIES

an object containing either value or function that specifies the end date


content.defaultActiveFilters.globalDate.defaultValues.startDate

content.defaultActiveFilters.date.defaultValues.startDate

content.defaultActiveFilters.globalDate.defaultValues.endDate

content.defaultActiveFilters.date.defaultValues.endDate

Cross-key constraints

value != null xor function != null

Key

Type

Optionality

Description

Constraints

value

string

VARIES

given value in the ISO 8601 format

format = YYYY-MM-DD

function

object

VARIES

a function object defining an interval of a relative date filter


Relative date filters

Relative date filters allow you to create filters with sliding date values, like last week, the previous month or the first 90 days of a year.

They consist of three functions:

  • function_today - always returns today's date

  • function_date_trunc - truncates a date to a beginning of an interval (= first day of a week, month, etc.)

    • supported intervals: day, week, month, quarter, year

  • function_interval - generates a date interval, which can later be added or subtracted from a date

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)

By combining these functions into startDate and endDate, you are able to create the desired intervals. Let's have a look at an example:

Last 30 days

This interval spans the last 30 days since today. It does not respect the boundaries of a calendar month.

Relative date filter of the last 30 days
CODE 
        "defaultValues": {
            "startDate": {
                "function": {
                    "type": "function_minus",
                    "content": [
                        {
                            "type": "function_today"
                        },
                        {
                            "type": "function_interval",
                            "content": [
                                {
                                    "type": "number",
                                    "value": 30
                                }
                            ],
                            "options": {
                                "interval": "day"
                            }
                        }
                    ]
                }
            },
            "endDate": {
                "function": {
                    "type": "function_today"
                }
            }
        }

This month

This interval starts at the 1st of the current month and ends today.

Relative date filter of this month
CODE 
        "defaultValues": {
            "startDate": {
                "function": {
                    "type": "function_date_trunc",
                    "content": [
                        {
                            "type": "function_today"
                        }
                    ],
                    "options": {
                        "interval": "month"
                    }
                }
            },
            "endDate": {
                "function": {
                    "type": "function_today"
                }
            }
        }

Previous year

This interval spans all days of the previous year. If it's New Year's Eve of 2017, the whole year 2016 will be selected. If it's New Year's Day of 2018, the whole year 2017 will be selected.

Relative date filter of the previous year
CODE 
        "defaultValues": {
            "startDate": {
                "function": {
                    "type": "function_minus",
                    "content": [
                        {
                            "type": "function_date_trunc",
                            "content": [
                                {
                                    "type": "function_today"
                                }
                            ],
                            "options": {
                                "interval": "year"
                            }
                        },
                        {
                            "type": "function_interval",
                            "content": [
                                {
                                    "type": "number",
                                    "value": 1.0
                                }
                            ],
                            "options": {
                                "interval": "year"
                            }
                        }
                    ]
                }
            },
            "endDate": {
                "function": {
                    "type": "function_minus",
                    "content": [
                        {
                            "type": "function_date_trunc",
                            "content": [
                                {
                                    "type": "function_today"
                                }
                            ],
                            "options": {
                                "interval": "year"
                            }
                        },
                        {
                            "type": "function_interval",
                            "content": [
                                {
                                    "type": "number",
                                    "value": 1.0
                                }
                            ],
                            "options": {
                                "interval": "day"
                            }
                        }
                    ]
                }
            }
        }

content.filterGroup.histogram

content.defaultActiveFilters.histogram

Histogram filter allows you to filter the integer, bigint and decimal values.

Key

Type

Optionality

Description

Constraints

type

string

REQUIRED

type identifier, always histogram

[histogram]

property

object

REQUIRED

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

{datasetName}.{datasetProperty}

format

object

OPTIONAL

specifies the formatting of the histogram values

see indicator.content.format


defaultValues

object

VARIES

object containing default values for the histogram filter

See Example of a histogram filter with defaultValues set

not used when the filter is within filterGroup

required when the filter is within defaultActiveFilters


content.defaultActiveFilters.histogram.defaultValues

Cross-key constraints

values != null or nullFiltered != null

Key

Type

Optionality

Description

Constraints

values

array

VARIES

array of two integers - upper and lower default value

size = 2

nullFiltered

boolean

VARIES

specifies if null values should be filtered or not

default = false (null values are present)

[true, false]

content.filterGroup.multiSelect

content.defaultActiveFilters.multiSelect

Multiselect filter that works like a checkbox. Used to filter enumeration types (e.g. day of the week, type of the store, etc.).

When there are 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

REQUIRED

type identifier, always multiSelect

[multiSelect]

property

object

REQUIRED

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

{datasetName}.{datasetProperty}

orderBy

array

OPTIONAL

array of orderBy objects that specify how to order the multiselect list


defaultValues

object

VARIES

object containing default values for the multi select filter

See Example of a multiSelect filter with defaultValues set

not used when the filter is within filterGroup

required when the filter is within defaultActiveFilters


content.filterGroup.multiSelect.orderBy

content.defaultActiveFilters.multiSelect.orderBy

Specifies the ordering of elements in a multiSelect filter.

Key

Type

Optionality

Description

Constraints

property

string

REQUIRED

identifier of a dataset property, by which the list will be ordered

{datasetName}.{datasetProperty}

direction

string

REQUIRED

sort direction

default = asc

[asc, desc]

content.defaultActiveFilters.multiSelect.defaultValues

Key

Type

Optionality

Description

Constraints

values

array

REQUIRED

array of string/numeric/boolean value(s), that will be set as default(s)

content.filterGroup.singleSelect

content.defaultActiveFilters.singleSelect

Singleselect filter that works like a radio button. The user can choose only one of a predefined set of options. Used to filter enumeration types (e.g. day of the week, type of the store, etc.).

Please note that having this filter in a view makes it active all the time. If no defaultValues.value is specified, the first property is selected.

Key

Type

Optionality

Description

Constraints

type

string

REQUIRED

type identifier, always singleSelect

[singleSelect]

property

object

REQUIRED

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

{datasetName}.{datasetProperty}

orderBy

object

OPTIONAL

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

not used when the filter is within filterGroup

required when the filter is within defaultActiveFilters


content.defaultActiveFilters.singleSelect.defaultValues

Key

Type

Optionality

Description

Constraints

value

string

OPTIONAL

string value, that will be set as default,

NOTE: null and "" are valid values here

content.filterGroup.feature

content.defaultActiveFilters.feature

Allows you to set selected objects in the map (markers, areas, polygons, lines...).

Key

Type

Optionality

Description

Constraints

type

string

REQUIRED

type identifier, always feature

[feature]

dataset

string

REQUIRED

link to a dataset whose features will be filtered

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

defaultValues

object

VARIES

object containing default string values for the feature filter

See Example of a feature filter with defaultValues set

not used when the filter is within filterGroup

required when the filter is within defaultActiveFilters

compared

boolean

OPTIONAL

specifies whether the filter is included in compare table,

if not specified, then the filter is not included in compare table by default

[true, false]

content.defaultActiveFilters.feature.defaultValues

Key

Type

Optionality

Description

Constraints

values

array

REQUIRED

array of string value(s), that will be set as default(s)

content.variables.variables

Allows you to set unique variables which are used in metrics. See the syntax example of the filter above.

Key

Type

Optionality

Description

Constraints

type

string

REQUIRED

type identifier, always variables

[variables]

title

string

REQUIRED

title of the variables filter

size => 1

variables

array

REQUIRED

array of the content.variables.variables.variable objects

size => 1

content.variables.variables.variable

Each variable is uniquely identified by its name. This name then must be used in metric objects, in which it is located 

Ke

Type

Optionality

Description

Constraints

name

string

REQUIRED

name of the variable

must match the name of variable used in metrics

(a-z0-9_-)

title

string

REQUIRED

human-readable title of the variable

size => 1

minValue

decimal

REQUIRED

minimum value of the variable


maxValue

decimal

REQUIRED

maximum value of the variable


defaultValue

decimal

REQUIRED

default value of the variable


format

object

REQUIRED

specifies the formatting of the variables values

see indicator.content.format


content.spatialQuery

Key

Type

Optionality

Description

Constraints

profile

string

REQUIRED

profile of the spatial query

[car, bike, foot, air]

unit

string

REQUIRED

unit of the spatial query

[time, distance]

amount

integer

REQUIRED

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

x => 1

content.mapOptions

Key

Type

Optionality

Description

Constraints

center

object

OPTIONAL

center of the map window when entering the view


zoom

integer

OPTIONAL

sets ideal zoom level

2 .. 18

minZoom

integer

OPTIONAL

sets the minimum zoom level

2 .. 18

maxZoom

integer

OPTIONAL

sets the maximum zoom level

2 .. 18

tileLayerMenu

boolean

OPTIONAL

display or hide the base map layer menu

default = true

[true, false]

tileLayer

string

VARIES

base map layer identifier

only one of tileLayer and customTileLayer allowed

[mapbox, mapboxStreets, mapboxOutdoors, mapboxSatelliteStreets, mapboxLight, mapboxDark]

customTileLayer

object

VARIES

base map layer definition

only one of tileLayer and customTileLayer allowed

content.mapOptions.customTileLayer

Key

Type

Optionality

Description

Constraints

url

string

REQUIRED

base map layer url

must begin with mapbox://styles/

accessToken

string

REQUIRED

access token for base map url

content.mapOptions.center

Key

Type

Optionality

Description

Constraints

lat

decimal

REQUIRED

decimal value of the latitude

-90.0 .. +90.0

lng

decimal

REQUIRED

decimal value of the longitue

-180.0 .. +180.0

content.mapContextMenu

The mapContextMenu object allows you to define the content of the context menu after using right-click on the map.

Key

Type

Optionality

Description

Constraints

items

array

REQUIRED

array of map context menu items


content.mapContextMenu.items

Key

Type

Optionality

Description

Constraints

type

string

REQUIRED

type of the clickable item

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

[googleSatellite, googleStreetView, googleEarth, 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 (3c4cc4ee-5030-4aea-a100-721846631ec7.png).

Key

Type

Optionality

Description

Constraints

export

string

REQUIRED

link to an export which will be available in the view

/rest/projects/$projectId/md/exports?name={exportName}

content.measure

This object allows you to set the settings of the measure tool. The settings are available for line and isoline measure.

Key

Type

Optionality

Description

Constraints

type

string

OPTIONAL

type of the measure

[line, isoline]

points

array

VARIES

array of points for line measure

(warning) either points or zones can be specified

size => 1

zones

array

VARIES

array of zones for isoline measure

(warning) either points or zones can be specified

size => 1

content.measure.points

Key

Type

Optionality

Description

Constraints

lat

decimal

REQUIRED

decimal value of the point's latitude

-90.0 .. +90.0

lng

decimal

REQUIRED

decimal value of the point's longitude

-180.0 .. +180.0

content.measure.zones

Key

Type

Optionality

Description

Constraints

lat

decimal

REQUIRED

decimal value of the point's latitude

-90.0 .. +90.0

lng

decimal

REQUIRED

decimal value of the point's longitude

-180.0 .. +180.0

profile

string

REQUIRED

profile of the isochrone

[car, bike, foot, air]

unit

string

REQUIRED

unit of the isochrone

[time, distance]

amount

integer

REQUIRED

amount of units of the isochrone

x => 1

content.defaultSelected

Specifies selected objects and selected coordinates when entering the view.

Key

Type

Optionality

Description

Constraints

dataset

string

OPTIONAL

link to a dataset whose features will be filtered

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

ids

array

OPTIONAL

array of object ids which will be selected


coordinates

array

OPTIONAL

array of objects with "lat" and "lng" 

size => 1

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


venture_capital

wealth_accumulation

workgroup_people

Views displayed on the project page

Map base layers

mapbox

mapboxStreets

mapboxOutdoors

mapboxSatelliteStreets

mapboxLight

mapboxDark

globalDate filter type

in default state

with set values


indicator filter type

in default state

with set values

date filter type

in default state

with set values

histogram filter type                                                                                           

in default state

with set values

multiSelect filter type

in default state

with set values

multiSelect filter type

in default state

with set values

variables filter type

in default state

with set values

feature filter type

in default state

with set values

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close