Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Dashboard is an ordered list of indicators and indicator drill pairs.

...

KeyTypeOptionalityDescriptionConstraints
typestring
Status
colourRed
titlerequired
type identifier, always indicator[indicator]
indicatorstring

Status
colourRed
titlerequired

URL link to the indicator object

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

Status
colourRed
titlerequired

URL link to the indicator drill object

/rest/projects/$projectId/md/indicatorDrills?name={indicatorDrillName}
layoutstring
Status
colourGreen
titleoptional

layout of the indicator

when not specified, the indicator's layout is primary

[primary, secondary]
collapsedboolean
Status
colourGreen
titleoptional
determines if the indicator should be collapsed when entering the view

content.blockRows.blockRow

...

KeyTypeOptionalityDescriptionConstraints
typestring
Status
colourRed
titlerequired
type identifier, always indicatorGroup[indicatorGroup]
titlestring
Status
colourRed
titlerequired
title of the indicator group(*)
descriptionstring
Status
colourGreen
titleoptional
description of the indicator group(*)
collapsedboolean
Status
colourGreen
titleoptional
determines if the group should be collapsed when entering the view[true, false]
blockRowsarray

Status
colourRed
titlerequired

array of either:

see the syntax example above


...

KeyTypeOptionalityDescriptionConstraints
datasetstring
Status
colourRed
titlerequired
URL link to the dataset, whose properties will be set/rest/projects/$projectId/md/datasets?name={datasetName}
defaultSearchstring
Status
colourGreen
titleoptional

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

Status
colourRed
titlerequired

array of dataset.properties.featureAttributes


...