Versions Compared

Key

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

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"

KeyTypeOptionalityDescriptionConstraints
typestring

Status
colourRed
titlerequired

type identifier, always distribution

[distribution]
onDashboardboolean
Status
colourGreen
titleoptional
determines if the block should be displayed directly on a dashboard[true, false]

...

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

KeyTypeOptionalityDescriptionConstraints
typestring

Status
colourRed
titlerequired

type identifier, always ranking

[ranking]
onDashboardboolean
Status
colourGreen
titleoptional
determines if the block should be displayed directly on a dashboard[true, false]
featureTypestring
Status
colourGreen
titleoptional

specifies which feature type should be ranked by default

default = granularity

[granularity, markers]
directionstring
Status
colourGreen
titleoptional

specifies the direction of ranked objects

default = desc

[asc, desc]

...

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"

KeyTypeOptionalityDescriptionConstraints
typestring

Status
colourRed
titlerequired

type identifier, always timeSeries

[timeSeries]
onDashboardboolean
Status
colourGreen
titleoptional
determines if the block should be displayed directly on a dashboard[true, false]
defaultPeriodstring
Status
colourGreen
titleoptional
specifies the default period dataset selected by default/rest/projects/$projectId/md/datasets?name={datasetName}
additionalSeriesarray
Status
colourGreen
titleoptional
array of additionalSeries objects
annotationsarray
Status
colourGreen
titleoptional
array of annotations objects

...