An indicator drill allows you to further analyse an indicator. Indicator drill consists of an array of blocks. These blocks can be displayed either after clicking on an indicator, or directly on a dashboard.
...
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
"
Key | Type | Optionality | Description | Constraints |
---|
type | string | | type identifier, always distribution | [distribution ] |
onDashboard | boolean | | determines if the block should be displayed directly on a dashboard | [true, false ] |
collapsed | boolean | | determines if the block should be collapsed when entering the view | [true, false ]
|
itemId | string | | Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see content.**.itemId section. | [a-z0-9]{32} |
...
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).
Key | Type | Optionality | Description | Constraints |
---|
type | string | | type identifier, always ranking | [ranking] |
onDashboard | boolean | | determines if the block should be displayed directly on a dashboard | [true, false ] |
featureType | string | | specifies which feature type should be ranked by default default = granularity | [granularity, markers] |
direction | string | | specifies the direction of ranked objects default = desc | [asc, desc ] |
collapsed | boolean | | determines if the block should be collapsed when entering the view | [true, false ]
|
itemId | string | | Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see content.**.itemId section. | [a-z0-9]{32} |
...
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
"
Key | Type | Optionality | Description | Constraints |
---|
type | string | | type identifier, always timeSeries | [timeSeries ] |
onDashboard | boolean | | determines if the block should be displayed directly on a dashboard | [true, false ] |
defaultPeriod | string | | specifies the default period dataset selected by default | /rest/projects/$projectId/md/datasets?name={datasetName} |
additionalSeries | array | | array of additionalSeries objects |
|
annotations | array | | array of annotations objects |
|
collapsed | boolean | | determines if the block should be collapsed when entering the view | [true, false ]
|
itemId | string | | Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see content.**.itemId section. | [a-z0-9]{32} |
...
Key | Type | Optionality | Description | Constraints |
---|
type | string | | type identifier, always categories | [categories ] |
title | string | | human-readable title of the categories block | (*) |
description | string | | description of the categories block | (*) |
splitProperty | string | | identifier of a dataset property, by which the classes of data will be split | {datasetName}.{datasetProperty} |
indicator | string | | URL link to the indicator object in case the block should not drill its paired indicator from the dashboard | /rest/projects/$projectId/md/indicators?name={indicatorName} |
onDashboard | boolean | | determines if the block should be displayed directly on a dashboard | [true, false ] |
collapsed | boolean | | determines if the block should be collapsed when entering the view | [true, false] |
visualized | boolean | | determines if the block should be visualized when entering the view (= if qualitative visualization should be enabled, more here) | [true, false] |
filterable | boolean | | flag that allows you to turn off the default filterability if not present, the block is filterable, must be set to false to turn it off | [true, false] |
hideNullItems | boolean | | determines if the block should display categories with null or zero values default = false | [true, false] |
sizeLimit | integer | | limit the size of displayed categories | x => 1 |
orderBy | object | | specifies ordering of the properties in the block if orderBy is not specified, the categories are ranked by the indicator value see content.filterGroup.multiSelect.orderBy |
|
displayValues
| array | | specify values of categories which will be displayed by default (when entering the view) |
|
vertical | boolean | | determines if the block should be vertical doesn't work with condensed , dualProperty and label properties | [true, false] |
condensed | boolean | | determines if the block should appear as condensed or not see visual representation below | [true, false] |
dualProperty | string | | identifier of a dataset property, by which the data will be dually split block with dualProperty is always condensed = true | {datasetName}.{datasetProperty} |
label | string | | determines the default label of condensed categories it is not possible to set the label for condensed = false block | (*) |
itemId | string | | Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see content.**.itemId 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;
- if an item is being created do not provide itemId attribute at all - it will be generated at backend and returend within a response payload
- if an item is being updated provide the value of itemId which was previously retrieved from backend via REST API - this value will be used for matching the item with share object diffs while rebasing a share object
...