Versions Compared

Key

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

...

Code Block
titleExample of an indicator with scaleOptions.static object
collapsetrue
{
    "name": "turnover_indicator",
    "type": "indicator",
    "title": "Turnover value",
    "description": "Total turnover of all purchases. It indicates how much money your customers have spent.",
    "content": {
        "metric": "/rest/projects/$projectId/md/metrics?name=turnover_metric",
        "scale": "standard",
        "distribution": "geometric",
        "visualizations": {
    		"heatmap": true,
            "dominance": true
		},
        "format": {
            "type": "number",
            "fraction": 0,
            "symbol": "£"
        },
        "scaleOptions": {
            "static": [
                {
                    "dataset": "/rest/projects/$projectId/md/datasets?name=postcodes",
                    "breaks": {
                        "global": [
                            10000,
                            20000,
                            40000,
                            80000
                        ],
                        "selection": [
                            1000,
                            2000,
                            4000,
                            8000
                        ]
                    },
                    "maxValues": [
                        {
                            "zoom": 18,
                            "global": 100000,
                            "selection": 10000,
							"itemId": "05f174e2300cee630980bdc3166cce7f"                         }
                    ],
					"itemId":
"05f174e2300cee630980bdc3166cce7f"                 }
            ]
        }
    }
}

This indicator has the content.scaleOptions.static object set. Few points to note:

...

KeyTypeOptionalityDescriptionConstraints
datasetstring

Status
colourGreen
titleoptional

URL link to the dataset representing a granularity, on which the breaks will be applied only

if not specified, the breaks will be applied to all datasets (all granularities)

/rest/projects/$projectId/md/datasets?name={datasetName}
breaksobject
Status
colourRed
titlerequired
object representing the break values
maxValuesarray
Status
colourGreen
titleoptional
array of maximal values for the heatmap visualization scalex => 0
itemIdstring
Status
colourRed
titlerequired
Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see content.**.itemId section.[a-z0-9]{32}

content.scaleOptions.static.breaks

The values specified in breaks apply to the areas, grid, zones, dotmap and line visualizations.

...

content.scaleOptions.static.breaks

The values specified in breaks apply to the areas, grid, zones, dotmap and line visualizations.

KeyTypeOptionalityDescriptionConstraints
globalarray

Status
colourGreen
titleoptional

array of distribution break values (integer or decimal)

these breaks will be applied when no object is selected

size = 4 (standard, positive, negative, inverse, heat, heatmap, traffic, trafficInverse, magma and viridis scales)

size = 1 (binaryStandard and binaryNegative scales)

size = 5 (divergingStandard, divergingNegative, divergingWithZeroStandard and divergingWithZeroNegative scales)

selectionarray
Status
colourGreen
titleoptional

array of distribution break values (integer or decimal)

these breaks will be applied when an object is selected (area or a marker)

size = 4 (standard, positive, negative and inverse scales)

size = 1 (binaryStandard and binaryNegative scales)

size = 5 (divergingStandard, divergingNegative, divergingWithZeroStandard and divergingWithZeroNegative scales)

...

KeyTypeOptionalityDescriptionConstraints
zoominteger

Status
colourRed
titlerequired

zoom level, for which the global/selection value will be used

(info) no need to specify all 16 zoom levels - when one level is specified, the rest is computed as a result of a geometric series

2 .. 18

globaldecimal
Status
colourGreen
titleoptional

global scale value (= no marker selected)

x => 0.0

selectiondecimal
Status
colourGreen
titleoptional
selected scale value (= when a marker is selected)x => 0.0
itemIdstring
Status
colourRed
titlerequired
Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see content.**.itemId section.[a-z0-9]{32}

content.scaleOptions.defaultDistribution

This object allows you to set the default values (including outer breaks) of the indicator's corresponding indicator drill's distribution block. These settings are reset when a filter is applied.

...

array of distribution break values (integer or decimal)

content.scaleOptions.defaultDistribution

This object allows you to set the default values (including outer breaks) of the indicator's corresponding indicator drill's distribution block. These settings are reset when a filter is applied.

KeyTypeOptionalityDescriptionConstraints
breaksarray

Status
colourGreen
titleoptional

array of distribution break values (integer or decimal)

size = 6 (standard, positive, negative, inverse, heat, heatmap, traffic, trafficInverse, magma and viridis scale)

size = 3 (binaryStandard and binaryNegative scale)

size = 7 (divergingStandard and divergingNegative scale)

displayIntervalsarray
Status
colourGreen
titleoptional
specifies which scale intervals should be displayed

content.**.itemId

Generated ID for this item to be used for matching it within a parent array while rebasing share objects. itemId is genrated as hash from random UUID when given item is being created - either an entire dashboard is being created or an item is being added to MD object content via update. Once itemId is generated it is not supposed to be modified.

IMPORTANT: When interacting with REST API do not provide own generated values as itemId;

...


Visual representation

Indicators are represented as a list of cards in a dashboard.

...