Dashboard is an ordered list of indicators and indicator drill pairs.
...
Info |
---|
See various setups of a dashboard in action in the Features Catalog for Developers project. |
Syntax
This is the syntax of the dashboard located in the Customer Intelligence view of the Retail Solution Demo project.
It's the simplest way to display an array of indicators. Each of them has one row and is primary
. For more customized dashboards, see the syntax examples and visual representation below.
...
This example shows the indicators from the first four views of the Retail Solution Demo grouped into one view's dashboard with indicatorGroups
.
...
Key | Type | Optionality | Description | Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
type | string |
| type identifier, always indicator | [indicator] | ||||||
indicator | string |
| URL link to the indicator object | /rest/projects/$projectId/md/indicators?name={indicatorName} | ||||||
indicatorDrill | string |
| URL link to the indicator drill object | /rest/projects/$projectId/md/indicatorDrills?name={ | ||||||
layout | string |
| layout of the indicator when not specified, the indicator's layout is | [primary, secondary] |
...
Key | Type | Optionality | Description | Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
type | string |
| type identifier, always indicatorGroup | [indicatorGroup] | ||||||
title | string |
| title of the indicator group | (*) | ||||||
description | string |
| description of the indicator group | (*) | ||||||
collapsed | boolean |
| determines if the group should be collapsed when entering the view | [true, false] | ||||||
blockRows | array |
| array of either:
see the syntax example above |
...
Key | Type | Optionality | Description | Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
dataset | string |
| URL link to the dataset, whose properties will be set | /rest/projects/$projectId/md/datasets?name={datasetName} | ||||||
defaultSearch | string |
| specifies if the dataset will be enabled in Refine search enable = dataset will be enabled disable = dataset will be disabled auto = dataset will be enabled if its features are visible in the map | [enable, disable, auto] | ||||||
featureAttributes | array |
| array of |
...