Versions Compared

Key

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

...

KeyTypeOptionalityDescriptionConstraints
typestring

Status
colourRed
titlerequired

type identifier, always categories

[categories]
titlestring
Status
colourRed
titlerequired
human-readable title of the categories block(*)
descriptionstring
Status
colourRed
titlerequired
description of the categories block(*)
splitPropertystring
Status
colourRed
titlerequired
identifier of a dataset property, by which the classes of data will be split{datasetName}.{datasetProperty}
indicatorstring
Status
colourGreen
titleoptional

URL link to the indicator object

(info) in case the block should not drill its paired indicator from the dashboard

/rest/projects/$projectId/md/indicators?name={indicatorName}
onDashboardboolean
Status
colourGreen
titleoptional
determines if the block should be displayed directly on a dashboard[true, false]
collapsedboolean
Status
colourGreen
titleoptional
determines if the block should be collapsed when entering the view[true, false]
visualizedboolean
Status
colourGreen
titleoptional
determines if the block should be visualized when entering the view (= if qualitative visualization should be enabled, more here)[true, false]
filterableboolean
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]
hideNullItemsboolean
Status
colourGreen
titleoptional

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

default = false

[true, false]
sizeLimitinteger
Status
colourGreen
titleoptional
limit the size of displayed categoriesx => 1
orderByobject
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


displayCategoriesdisplayValues

array
Status
colourGreen
titleoptional
specify values of categories which will be filtered displayed by default (when entering the view)
verticalboolean
Status
colourGreen
titleoptional

determines if the block should be vertical

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

[true, false]
condensedboolean
Status
colourGreen
titleoptional

determines if the block should appear as condensed or not

(info) see visual representation below

[true, false]
dualPropertystring
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}
labelstring
Status
colourGreen
titleoptional

determines the default label of condensed categories

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

(*)

...