diff --git a/docs/content/frontmatter/layer.md b/docs/content/frontmatter/layer.md index 74ddcaae5..800fb2e74 100644 --- a/docs/content/frontmatter/layer.md +++ b/docs/content/frontmatter/layer.md @@ -4,6 +4,7 @@ - [Properties](#properties) - [Projection](#projection) - [Legend](#legend) + - [Analysis](#analysis) - [Compare](#compare) - [Function values](#function-values) @@ -22,6 +23,7 @@ sourceParams: [key]: value | fn(bag) compare: Compare legend: Legend +analysis: Analysis ``` ## Properties @@ -203,6 +205,26 @@ stops: label: Barley ``` +### Analysis + +**analysis** +`object` +Configuration options for the analysis of the dataset layer. + +```yaml +metrics: string[] +``` + +**analysis.metrics** +`string[]` +List of metric ids to enable by default when analysis is performed. The user will then be able to select which metrics to display. +Available metrics: +- min (Min) +- mean (Average) +- max (Max) +- std (Standard Deviation) +- median (Median) + ### Compare **compare** diff --git a/mock/datasets/no2.data.mdx b/mock/datasets/no2.data.mdx index 49a5addd8..3359b9642 100644 --- a/mock/datasets/no2.data.mdx +++ b/mock/datasets/no2.data.mdx @@ -86,6 +86,11 @@ layers: - "#c13b72" - "#461070" - "#050308" + analysis: + metrics: + - min + - max + - non-existent - id: no2-monthly-2 stacCol: no2-monthly name: No2 US