Datasets describe the data model of a project. Each dataset represents a database table. They also define the constraints and links between all other datasets in a project.
There are three types of datasets:
dwh(
) type is a data warehouse service dataset type, it references a table in a relational dwh database, which may contain various kinds of data (e.g. orders, customers, administrative units...)vt(
) type is a vector tile dataset type, it references a vector tile service, which serves vector tiles that are displayed over the base map (CleverMaps vector tiles are hosted on Mapbox)h3Grid(
) type is a H3 grid dataset, it represents a grid visualization, where the geometries are generated on the fly by the application (see Tutorial 8 for more info, and H3 grid spatial index by Uber)
Datasets of dwh type also have a subtype, which defines the type of data they contain. There are five of them:
basic() subtype is used to contain data which are not to be visualised on a map (e.g. orders, clients, or demography)geometryPolygon(
) subtype contains data which represent polygons on a map (e.g. administrative units, delivery zones)geometryPoint(
) subtype contains data which represent specific points on a map (e.g. shops, postcodes, or POIs)geometryLine(
) subtype contains data which represent lines on a map (e.g. routes, pipelines)date(
) subtype is a special subtype not to be used in a regular way, it is used to describe datasets the can-dim-dates data dimension
Datasets also subject to various validation checks. Datasets with ref.subtype other than basic - geometryPolygon, geometryPoint, geometryLine and date must also contain properties.featureTitle key, which defines the format of visualisation of one row of the dataset (used in tooltips or the date picker). Datasets with geometry must have a link to a vt type dataset describing that geometry. More about these checks in the examples below.
...
The dataset also contains information about its data sources. The source data for UK districts was provided by Office for National Statistics under the Open Government license. For more info, see the syntax below.
| Info |
|---|
Note the reference to a |
...
These properties define the content of a tooltip shown on marker/area hover (example), and the details of a dataset (example).
The properties can be found on the common syntax level. The syntax example can be found in the "Example of a dwh dataset type with geometryPoint subtype" above.
...
Key | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| string |
| type identifier, always |
| ||||||
| string |
|
|
| ||||||
| string |
| geometry reference to a vector tile dataset required only for |
| ||||||
| array |
| array of references to enables the grid visualization | |||||||
| array |
| array of objects specifying the allowed visualizations of the dataset required only for | |||||||
| object |
| map zoom object | |||||||
| string |
| name of the actual it's derived from the name of the dataset, and _X postfix is added for each full load, where X is the number of the load |
| ||||||
| string |
| primary key of the table - must be one of the dataset properties should be unique |
| ||||||
| boolean |
| indicates if the dataset is capable of being categorized in the Filters tool ( default = should be |
| ||||||
| boolean |
| indicates if the dataset's data will be indexed for full text search in Search tool ( default = |
| ||||||
| array |
| array of dataset property order must be identical to the order of the data columns size must be at least 1 |
...
For more info, see the additional syntax examples above.
Key | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| string |
| type of the visualization |
| ||||||
| object |
| map zoom object |
...
Key | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| string |
| name of the column as it will be referenced in other objects |
| ||||||
| string |
| human-readable title of the column |
| ||||||
| string |
| name of the column as it is in the database table |
| ||||||
| string |
| column data type detailed description in the table below |
| ||||||
| string |
| name of the dataset, whose if this key is mentioned, |
| ||||||
| boolean |
| indicates whether it's possible for this property to be added to a filter default = |
| ||||||
| string |
| description of the property which appears in Filters ( |
| ||||||
| object |
| options that specify how the property will be displayed |
...
The displayOptions object allows you to specify how the property will be displayed. See the example above.
Key | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| array |
| assigns colors to values of the property |
...
Native datasets in this project are baskets, shops and clients. The other datasets were imported from different data dimensions. The datasets in orange were imported from the can-dim-dates dimension. Brown datasets are from a UK administrative units dimension. The dataset demography_postcode comes from a UK demography dimension. The h3Grid datasets are pink.
...
For geometryPoint and geometryPolygon datasets, a tooltip is shown on hover. The content is defined in dataset.properties.
...
"My Store: Grand Central" is the featureTitle.
...
The content of dataset details is defined in dataset.properties.featureAttributes. The details are shown on the dashboard, right under the indicator list.
...