Versions Compared

Old Version 94

changes.mady.by.user Kateřina Tomášková

Saved on

compared with

New Version 95

changes.mady.by.user Kateřina Tomášková

Saved on

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.

There are 4 types of blocks:

  • distribution - adjust the distribution of data across the map

  • ranking - order all relevant objects based on the value of selected indicator

  • timeSeries - see the progress and trend of an indicator in a selected time frame

  • categories - list specific classes of data within a single indicator

Info

See the indicator drill blocks in action in the Features Catalog for Developers project.

Syntax

This is an indicator drill which belongs to the Number of Customers indicator from the Retail Solution Demo. It contains all four available block types.

...

Indicator drill object syntax
title
Code Block
{
    "name": "customers_indicator_drill",
    "type": "indicatorDrill",
    "content": {
        "blocks": [
            {
                "type": "distribution",
                "title": "Optional distribution title",
                "indicator": "/rest/projects/$projectId/md/indicators?name=online_turnover_indicator"
            },
            {
                "type": "ranking",
                "title": "Optional ranking title",
                "indicator": "/rest/projects/$projectId/md/indicators?name=online_turnover_indicator"
            },
            {
                "type": "timeSeries",
                "title": "Optional time series title",
                "indicator": "/rest/projects/$projectId/md/indicators?name=online_turnover_indicator"
            },
            {
                "type": "categories",
                "title": "Customers by channel",
                "description": "Customers by channel",
                "splitProperty": "baskets.on_off_name",
                "orderBy": {
                    "property": "baskets.on_off_name",
                    "direction": "desc"
                }
            },
            {
                "type": "categories",
                "title": "Customers by age and sex",
                "description": "Customers by age and sex categories",
                "splitProperty": "clients.age_name",
                "orderBy": {
                   "property": "clients.age_cat",
                   "direction": "asc"
                },
                "dualProperty": "clients.sex_name",
                "label": "Age categories"
            }
        ]
    }
}
Code Block

Example of a dumped indicator drill
true
collapse
 Code Block
{
    "url": "/rest/projects/yufqzxkbiecj7jot/md/indicatorDrills/t45dd93ksm4jshrs",
    "dumpTime": "2018-01-31T17:39:08Z",
    "version": "4",
    "content": {
        "id": "t45dd93ksm4jshrs",
        "name": "customers_indicator_drill",
        "type": "indicatorDrill",
        "content": {
            "blocks": [
                {
                    "type": "distribution",
                    "title": "Optional distribution title",
                    "indicator": "/rest/projects/$projectId/md/indicators?name=online_turnover_indicator"
                },
                {
                    "type": "ranking",
                    "title": "Optional ranking title",
                    "indicator": "/rest/projects/$projectId/md/indicators?name=online_turnover_indicator"
                },
                {
                    "type": "timeSeries",
                    "title": "Optional time series title",
                    "indicator": "/rest/projects/$projectId/md/indicators?name=online_turnover_indicator"
                },
                {
                    "type": "categories",
                    "title": "Customers by channel",
                    "description": "Customers by channel",
                    "splitProperty": "baskets.on_off_name",
                    "orderBy": {
                        "property": "baskets.on_off_name",
                        "direction": "desc"
                    }
                },
                {
                    "type": "categories",
                    "title": "Customers by age and sex",
                    "description": "Customers by age and sex categories",
                    "splitProperty": "clients.age_name",
                    "orderBy": {
                        "property": "clients.age_cat",
                        "direction": "asc",
                        "sort": "asc"
                    },
                    "dualProperty": "clients.sex_name",
                    "label": "Age categories"
                }
            ]
        },
        "accessInfo": {
            "createdAt": "2017-10-05T08:27:04Z",
            "modifiedAt": "2018-01-31T16:39:10Z"
        },
        "links": [
            {
                "rel": "self",
                "href": "/rest/projects/yufqzxkbiecj7jot/md/indicatorDrills/t45dd93ksm4jshrs"
            }
        ]
    }
}

Additional syntax examples
...
Indicator drill with block displayed on a dashboard
true
collapse
 Code Block
{
    "name": "turnover_value_indicator_drill",
    "type": "indicatorDrill",
    "content": {
        "blocks": [
            {
                "type": "distribution",
                "onDashboard": true
            },
            {
                "type": "ranking"
            },
            {
                "type": "timeSeries"
            }
        ]
    }
}

It is possible to display any block directly on a dashboard by setting the onDashboard property to true (see examples below). The block will be accessible and controllable without having to drill down on the indicator.
Please note that:
  • it is possible to display only one block from each drill
  • in case of the distribution block, histogram filter is displayed instead
...
...

Indicator drill with additionalSeries and annotations syntax
collapse
 Code Block
true
{
    "name": "offline_turnover_indicator_drill",
    "type": "indicatorDrill",
    "content": {
        "blocks": [
            {
                "type": "timeSeries",
                "additionalSeries": [
                    {
                        "indicator": "/rest/projects/$projectId/md/indicators?name=online_turnover_indicator"
                    }
                ],
                "annotations": [
                    {
                        "dataset": "/rest/projects/$projectId/md/datasets?name=events"
                    }
                ]
            }
        ]
    }
}


...
Additionally, it is possible to add annotations. Annotations are basically events that can be displayed in the timeSeries graph. The data for annotations are stored in a specific date subtype dataset, named e.g. "events". This dataset must contain a foreign key property containing id of the object to which the event relates to - in this case shops. It also must be linke to the dim_dates dataset of the date dimension, and contain a description of the event (which also must be in the featureTitle property). The visual representation of such timeSeries block can be found below.
...
Events dataset syntax
collapse
 Code Block
true
{
    "name": "events",
    "type": "dataset",
    "title": "Events",
    "properties": {
        "featureTitle": {
            "type": "property",
            "value": "description"
        }
    },
    "ref": {
        "type": "dwh",
        "subtype": "date",
        "table": "events",
        "primaryKey": "id",
        "categorizable": false,
        "fullTextIndex": false,
        "properties": [
            {
                "filterable": false,
                "name": "id",
                "title": "Id",
                "column": "id",
                "type": "integer"
            },
            {
                "filterable": false,
                "name": "shop_id",
                "title": "Shop id",
                "column": "shop_id",
                "type": "integer",
                "foreignKey": "shops"
            },
            {
                "filterable": false,
                "name": "date_iso",
                "title": "Date iso",
                "column": "date_iso",
                "type": "date",
                "foreignKey": "dim_dates"
            },
            {
                "filterable": false,
                "name": "description",
                "title": "Description",
                "column": "description",
                "type": "string"
            }
        ]
    }
}

 Code Block
languagetext
title

Events dataset data example
 Code Block
collapselanguagetruetext
id,shop_id,date_iso,description
1,10,2018-07-01,Shortened opening hours
2,10,2018-07-19,Closed for interior redesign
3,10,2018-08-17,Shop opened again

Key description
content
Key
Type
Optionality
Description
Constraints
blocks
array
 Status
colourRed
titlerequired
an array of blocks

content.blocks.distribution
Distribution block's scale and the distribution of the data is defined in its paired indicator.content.
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 categories 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}
onDashboard
boolean
 Status
colourGreen
titleoptional
determines if the block should be displayed directly on a dashboard
[true, false]
collapsed
boolean
 Status
colourGreen
titleoptional
determines if the block should be collapsed when entering the view
[true, false]
content.blocks.ranking
Ranking block can be switched to display either markers, or areas (when they're both available in the view). When there is a higher number of elements, infinite scroll is used.
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 categories 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}
onDashboard
boolean
 Status
colourGreen
titleoptional
determines if the block should be displayed directly on a dashboard
[true, false]
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]
content.blocks.timeSeries
Time series visualises the progress and trend of the respective indicator in a selected time frame. Additionally, it can be extended with time series of another indicator.
However, its time frame is set by view.content.filterGroup.globalDate filter. The component itself also allows the user to set the granularity of the block (days, weeks, months, quarters or years).
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 categories 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}
onDashboard
boolean
 Status
colourGreen
titleoptional
determines if the block should be displayed directly on a dashboard
[true, false]
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]
content.blocks.timeSeries.additionalSeries
Contains link to an additional time series indicator. See the syntax example above.
Key
Type
Optionality
Description
Constraints
indicator
string
 Status
colourRed
titlerequired
URL link to the indicator object
/rest/projects/$projectId/md/indicators?name={indicatorName}
content.blocks.timeSeries.annotations
Contains link to a dataset with annotation data. See the syntax example above.
Key
Type
Optionality
Description
Constraints
dataset
string
 Status
colourRed
titlerequired
URL link to the dataset object
/rest/projects/$projectId/md/datasets?name={datasetName}
content.blocks.categories
Categories block list specific classes of data. The data are broke down to a categories defined by a splitProperty. These categories are filterable. The title and description of the categories can be set.
...
This block also offers additional configuration, which allows it to be either condensed, or dual.
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}
onDashboard
boolean
 Status
colourGreen
titleoptional
determines if the block should be displayed directly on a dashboard
[true, false]
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
(*)
Visual representation
Distribution block
...
The data in the distribution block below are evenly distributed, and distinctively separate the areas of interest.
...
Ranking block
This block ranks areas by a specific indicator. In this case, it's the turnover value in Ward administrative units.
...
Time series block
Time series block shows progress and trend of a selected indicator over a specific period of time.
...
Time series block with additionalSeries
This block contains one additional indicator in the additionalSeries. It shows the comparison of offline (blue) and online (black) turnover. See the syntax example above.
If you specify more than one additional indicator, a dropdown menu with all other available indicators is displayed.
...
Time series block with additionalSeries and annotations
Events specified in the annotations array are related to a specific object - in this case a marker. So, note that to see them - we have to drill down on that specific marker. See the syntax example above.
...
Categories block
Categories block lists specific classes of data.
...
Please note, that the basic categories configuration is omitted in the snippets below. The splitProperty is set to demography_age_1.age_name, which defines the age categories.
regular
condensed

 Code Block
{
    ...
    "condensed": false
}



 Code Block
{
    ...
    "condensed": true,
    "label": "Age groups"
}


Image ModifiedImage Modified
dual
vertical

 Code Block
{
    ...
    "condensed": true,
    "dualProperty": "demography_age_1.sex",
    "label": "Age groups"
}



 Code Block
{
    ...
    "vertical": true
}


Image ModifiedImage Modified
Blocks on a dashboard
Available by setting the onDashboard property to true.
distribution
categories
Image Modified

Image Modified
ranking
timeSeries
Image ModifiedImage Modified