Versions Compared

Key

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

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.

...

KeyTypeOptionalityDescriptionConstraints
typestring
Status
colourRed
titlerequired
type identifier, always dwh[dwh]

subtype

string

Status
colourRed
titlerequired

dwh subtype identifier

[basic, geometryPoint, geometryPolygon, geometryLine, date]
geometrystring

Status
colourYellow
titlevaries

geometry reference to a vector tile dataset

required only for geometryPolygon and geometryLine subtypes

{datasetName}
h3Geometriesarray
Status
colourGreen
titleoptional

array of references to h3Grid dataset names (see example above)

enables the grid visualization


visualizationsarray
Status
colourYellow
titlevaries

array of objects specifying the allowed visualizations of the dataset

required only for geometryPoint, geometryPolygon and geometryLine datasets


zoomobject
Status
colourGreen
titleoptional
map zoom object
tablestring

Status
colourGrey
titleREAD-ONLY

name of the actual dwh table this dataset represents

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

(a-z0-9_-)
primaryKeystring

Status
colourRed
titlerequired

primary key of the table - must be one of the dataset properties

should be unique

{datasetProperty}
categorizableboolean
Status
colourGreen
titleoptional

indicates if the dataset is capable of being categorized in the Filters tool ()

default = true

should be true for fact datasets like "orders", "shops" or "clients", false for additional datasets like "postcodes", "dim_dates" or "price_categories"

[true, false]
fullTextIndexstring
Status
colourGreen
titleoptional

indicates if the dataset's data will be indexed for full text search in Search tool ()

default = true for geometry* subtypes, false for basic and date subtypes

[true, false]
propertiesarray
Status
colourRed
titlerequired

array of properties - database table column descriptions

dataset property order must be identical to the order of the data columns

size must be at least 1


dwh.ref.zoom

Set desired zoom levels for the dwh datasets.

KeyTypeOptionalityDescriptionConstraints
mininteger
Status
colourRed
titlerequired
minimal available zoom level2 .. 18

max

integer

Status
colourRed
titlerequired

maximal available zoom level

2 .. 18
optimalinteger

Status
colourRed
titlerequired

optimal zoom level

2 .. 18
visibleFrominteger
Status
colourGreen
titleoptional

zoom level from which the dataset's feature will be visible

(warning) this property works only for dwh datasets

2 .. 18

dwh.ref.visualizations

Array of objects specifying the allowed visualizations of the dataset. The available visualizations are derived from the subtype of the dataset:

...

KeyTypeOptionalityDescriptionConstraints
mininteger
Status
colourRed
titlerequired
minimal available zoom level2 .. 18

max

integer

Status
colourRed
titlerequired

maximal available zoom level

2 .. 18
optimalinteger

Status
colourRed
titlerequired

optimal zoom level

2 .. 18
visibleFrominteger
Status
colourGreen
titleoptional

zoom level from which the dataset's feature will be visible

(warning) this property works only for dwh datasets

2 .. 18

Visual representation

...

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.

Image Modified

"My Store: Grand Central" is the featureTitle.

...