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"

Key

Type

Optionality

Description

Constraints

type

string

Status
colourRed
titlerequired

type identifier, always distribution

[distribution]

title

string

Status
colourGreen
titleoptional

human-readable title of the distribution block

(*)

indicator

string

Status
colourGreen
titleoptional

URL link to the indicator object. If not defined currently visualized indicator is used as fallback.

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

collapsed

boolean

Status
colourGreen
titleoptional

determines if the block should be collapsed when entering the view

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

Key

Type

Optionality

Description

Constraints

type

string

Status
colourRed
titlerequired

type identifier, always ranking

[ranking]

title

string

Status
colourGreen
titleoptional

human-readable title of the ranking block

(*)

indicator

string

Status
colourGreen
titleoptional

URL link to the indicator object. If not defined currently visualized indicator is used as fallback.

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

featureType

string

Status
colourGreen
titleoptional

specifies which feature type should be ranked by default

default = granularity

[granularity, markers]

direction

string

Status
colourGreen
titleoptional

specifies the direction of ranked objects

default = desc

[asc, desc]

collapsed

boolean

Status
colourGreen
titleoptional

determines if the block should be collapsed when entering the view

[true, false]

...

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

Status
colourRed
titlerequired

type identifier, always timeSeries

[timeSeries]

title

string

Status
colourGreen
titleoptional

human-readable title of the time series block

(*)

indicator

string

Status
colourGreen
titleoptional

URL link to the indicator object. If not defined currently visualized indicator is used as fallback.

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

defaultPeriod

string

Status
colourGreen
titleoptional

specifies the default period dataset selected by default

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

additionalSeries

array

Status
colourGreen
titleoptional

array of additionalSeries objects


annotations

array

Status
colourGreen
titleoptional

array of annotations objects


collapsed

boolean

Status
colourGreen
titleoptional

determines if the block should be collapsed when entering the view

[true, false]

...

Key

Type

Optionality

Description

Constraints

type

string

Status
colourRed
titlerequired

type identifier, always categories

[categories]

title

string

Status
colourGreen
titleoptional

human-readable title of the categories block

(*)

description

string

Status
colourGreen
titleoptional

description of the categories block

(*)

splitProperty

string

Status
colourRed
titlerequired

identifier of a dataset property, by which the classes of data will be split

{datasetName}.{datasetProperty}

indicator

string

Status
colourGreen
titleoptional

URL link to the indicator object. If not defined currently visualized indicator is used as fallback.

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

collapsed

boolean

Status
colourGreen
titleoptional

determines if the block should be collapsed when entering the view

[true, false]

visualized

boolean

Status
colourGreen
titleoptional

determines if the block should be visualized when entering the view (= if qualitative visualization should be enabled, more here)

[true, false]

filterable

boolean

Status
colourGreen
titleoptional

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

Status
colourGreen
titleoptional

determines if the block should display categories with null or zero values

default = false

[true, false]

sizeLimit

integer

Status
colourGreen
titleoptional

limit the size of displayed categories

x => 1

orderBy

object

Status
colourGreen
titleoptional

specifies ordering of the properties in the block

(info) if orderBy is not specified, the categories are ranked by the indicator value

see content.filterGroup.multiSelect.orderBy

displayValues

array

Status
colourGreen
titleoptional

specify values of categories which will be displayed by default (when entering the view)


vertical

boolean

Status
colourGreen
titleoptional

determines if the block should be vertical

(warning) doesn't work with condensed, dualProperty and label properties

[true, false]

condensed

boolean

Status
colourGreen
titleoptional

determines if the block should appear as condensed or not

(info) see visual representation below

[true, false]

dualProperty

string

Status
colourGreen
titleoptional

identifier of a dataset property, by which the data will be dually split

(warning) block with dualProperty is always condensed = true

{datasetName}.{datasetProperty}

label

string

Status
colourGreen
titleoptional

determines the default label of condensed categories

(warning) it is not possible to set the label for condensed = false block

(*)

...