Dashboard is an ordered list of indicators and indicator drill pairs.Dashboard is an ordered list of indicators and indicator drill pairs.
Indicators on dashboard offer various ways of formatting. It's possible to group them, change their size or font, or display one of its indicator drill blocks directly on dashboard. They can also be collapsed or expanded (using right mouse click).
...
| Key | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
type | string |
| type identifier, always indicator | [indicator] | ||||||
indicator | string |
| URL link to the indicator object | /rest/projects/$projectId/md/indicators?name={indicatorName} | ||||||
indicatorDrill | string |
| URL link to the indicator drill object | /rest/projects/$projectId/md/indicatorDrills?name={ | ||||||
layout | string |
| layout of the indicator when not specified, the indicator's layout is | [primary, secondary] | ||||||
collapsed | boolean |
| determines if the indicator should be collapsed when entering the view |
...
| Key | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
type | string |
| type identifier, always indicatorGroup | [indicatorGroup] | ||||||
title | string |
| title of the indicator group | (*) | ||||||
description | string |
| description of the indicator group | (*) | ||||||
collapsed | boolean |
| determines if the group should be collapsed when entering the view | [true, false] | ||||||
blockRows | array |
| array of either:
see the syntax example above |
...
content.blockRows.distribution
Distribution block's scale and the distribution of the data is defined in its paired indicator.content.
Distribution also has a description, which is not configurable through metadata, but is compiled from the properties of its paired indicator, according to this formula: "Distribution of indicator.title in granularity"
...
...
...
...
...
...
REQUIRED
...
type identifier, always distribution
...
content.blockRows.ranking
Ranking block can be switched to display either markers, or areas (when they're both available in the view). When there is a higher number of elements, infinite scroll is used.
Ranking also has a description, which is not configurable through metadata, but is compiled from the properties of its paired indicator, according to this formula: "Rank of object according to indicator.title" (note: object in this case is either a polygon from a certain granularity, or a marker).
...
...
...
...
...
...
REQUIRED
...
type identifier, always ranking
...
specifies which feature type should be ranked by default
default = granularity
...
specifies the direction of ranked objects
default = desc
...
content.blockRows.timeSeries
Time series visualises the progress and trend of the respective indicator in a selected time frame. Additionally, it can be extended with time series of another indicator.
However, its time frame is set by view.content.filterGroup.globalDate filter. The component itself also allows the user to set the granularity of the block (days, weeks, months, quarters or years).
Time series also has a description, which is not configurable through metadata, but is compiled from the properties of its paired indicator, according to this formula: "Progress of indicator.title from view.content.filterGroup.globalDate.startDate to view.content.filterGroup.globalDate.endDate"
...
...
...
...
...
...
REQUIRED
...
type identifier, always timeSeries
...
The syntax of distribution block on dashboard is identical to the regular distribution syntax. See indicatorDrill.content.blocks.distribution.
content.blockRows.ranking
The syntax of ranking block on dashboard is identical to the regular ranking syntax. See indicatorDrill.content.blocks.ranking.
content.blockRows.timeSeries
The syntax of time series block on dashboard is identical to the regular series block syntax. See indicatorDrill.content.blocks.timeSeries.
content.datasetProperties
datasetProperties...
| Key | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
dataset | string |
| URL link to the dataset, whose properties will be set | /rest/projects/$projectId/md/datasets?name={datasetName} | ||||||
defaultSearch | string |
| specifies if the dataset will be enabled in Refine search enable = dataset will be enabled disable = dataset will be disabled auto = dataset will be enabled if its features are visible in the map | [enable, disable, auto] | ||||||
featureAttributes | array |
| array of |
...