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.

...

It's the simplest way to display an array of indicators. Each of them has one row and is primary. For more customized dashboards, see the syntax examples and visual representation below.

Dashboard object syntax

...

Key

Type

Optionality

Description

Constraints

blockRows

array

Status
colourGreen
titleoptional

array of either:

see the syntax examples above


datasetProperties

array

Status
colourGreen
titleoptional

definition of dataset's featureAttributes and defaultSearch per view options


...

Key

Type

Optionality

Description

Constraints

type

string

Status
colourRed
titlerequired

type identifier, always indicator

[indicator]

indicator

string

Status
colourRed
titlerequired

URL link to the indicator object

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

indicatorDrill

string

Status
colourRed
titlerequired

URL link to the indicator drill object

/rest/projects/$projectId/md/indicatorDrills?name={indicatorDrillName}

layout

string

Status
colourGreen
titleoptional

layout of the indicator

when not specified, the indicator's layout is primary

[primary, secondary]

collapsed

boolean

Status
colourGreen
titleoptional

determines if the indicator should be collapsed when entering the view


blockRows

array

Status
colourGreen
titleoptional

array of either:


...

Key

Type

Optionality

Description

Constraints

type

string

Status
colourRed
titlerequired

type identifier, always indicatorGroup

[indicatorGroup]

title

string

Status
colourRed
titlerequired

title of the indicator group

(*)

description

string

Status
colourGreen
titleoptional

description of the indicator group

(*)

collapsed

boolean

Status
colourGreen
titleoptional

determines if the group should be collapsed when entering the view

[true, false]

blockRows

array

Status
colourRed
titlerequired

array of either:

see the syntax example above


content.blockRows.categories

...

Allows you to define dataset's featureAttributes on dashboard. See above.

Key

Type

Optionality

Description

Constraints

dataset

string

Status
colourRed
titlerequired

URL link to the dataset, whose properties will be set

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

defaultSearch

string

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]

featureAttributes

array

Status
colourRed
titlerequired

array of dataset.properties.featureAttributes


...

Dashboard with indicator drill blocks

To display an indicator an indicator drill block directly on a dashboard, you can set its onDashboard property to trueadd block to indicator in blockRows. It is possible to display all four blocks: distribution, ranking, timeSeries and categories.

Each block on a dashboard can be collapsed / expanded, by using the right click and selecting "Collapse this indicator" / "Expand this indicator".

indicator drill blocks

onDashboard

block collapse / expand option

...