eurostat-map 4.8.6 → 4.9.1

package/build/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eurostat-map",
-  "version": "4.8.6",
+  "version": "4.9.0",
   "description": "Reusable library to quickly create and customise web maps showing Eurostat data directly retrieved from Eurostat database.",
   "keywords": [
     "eurostat",

package/build/src_core_dorling_dorling-worker_js.eurostatmap.js

@@ -9,7 +9,7 @@
 		root["eurostatmap"] = factory();
 })(self, () => {
 return /******/ (() => { // webpackBootstrap
-var __webpack_exports__ = {};
+let __webpack_exports__ = {};
 /*!********************************************!*\
   !*** ./src/core/dorling/dorling-worker.js ***!
   \********************************************/

package/build/types/core/InsetConfig.d.ts

@@ -1,71 +1,71 @@
-import type { LabelsConfig } from './decoration/LabelsConfig'
-import type { ScalebarConfig } from './decoration/ScalebarConfig'
-
-/**
- * Configuration for map insets (smaller additional maps, e.g. overseas territories)
- */
-export interface InsetConfig {
-    /** Geographic code (e.g., 'MT', 'PT20', 'CARIB'). */
-    geo?: string
-    /** Title. */
-    title?: string
-    /** Position of the title, relative to the inset's top-left corner. */
-    titlePosition?: [number, number]
-    /** Subtitle. */
-    subtitle?: string
-    /** Position of the subtitle, relative to the inset's top-left corner. */
-    subtitlePosition?: [number, number]
-    /** Scale. Named nuts2json scale (e.g. '01M', '03M', '10M', '20M', '60M') or a number. */
-    scale?: string | number
-    /** Width. */
-    width?: number
-    /** Height. */
-    height?: number
-    /** X position of the inset within the inset box. */
-    x?: number
-    /** Y position of the inset within the inset box. */
-    y?: number
-    /** Proj. */
-    proj?: string
-    /** Id of the `<svg>` element the inset is drawn into. Auto-generated if omitted. */
-    svgId?: string
-    /** Manual re-centering/zoom of the inset's own projection. */
-    position?: { x?: number; y?: number; z?: number }
-    /** Label rendering settings for this inset. */
-    labels?: LabelsConfig
-    /** Whether to show zoom buttons on this inset. @default false */
-    zoomButtons?: boolean
-    /** Custom base URL for this inset's nuts2json boundary data. */
-    nuts2jsonBaseURL?: string
-    /** Custom D3 projection function for this inset. */
-    projectionFunction?: Function | boolean
-
-    /** Scalebar settings for this inset. `true` uses the default scalebar config. */
-    scalebar?: ScalebarConfig | boolean
-
-    /** @deprecated Use `scalebar: { show: true }` instead. */
-    showScalebar?: boolean
-    /** @deprecated Use `scalebar: { position: [x, y] }` instead. */
-    scalebarPosition?: [number, number]
-    /** @deprecated Use `scalebar: { tickHeight }` instead. */
-    scalebarTickHeight?: number
-    /** @deprecated Use `scalebar: { segmentHeight }` instead. */
-    scalebarSegmentHeight?: number
-    /** Scalebar label font size in pixels. */
-    scalebarFontSize?: number
-    /** @deprecated Use `scalebar: { units }` instead. */
-    scalebarUnits?: string
-    /** @deprecated Use `scalebar: { textOffset }` instead. */
-    scalebarTextOffset?: [number, number]
-    /** @deprecated Use `scalebar: { maxWidth }` instead. */
-    scalebarMaxWidth?: number
-    /** Minimum width of the scalebar in pixels. */
-    scalebarMinWidth?: number
-
-    /** Nested insets belonging to this inset (e.g. bivariate choropleth per-inset legend classification). */
-    insets?: InsetConfig[]
-    /** Position of nested insets' inset box, relative to this inset. */
-    insetBoxPosition?: [number, number]
-
-    [key: string]: any
-}
+import type { LabelsConfig } from './decoration/LabelsConfig'
+import type { ScalebarConfig } from './decoration/ScalebarConfig'
+
+/**
+ * Configuration for map insets (smaller additional maps, e.g. overseas territories)
+ */
+export interface InsetConfig {
+    /** Geographic code (e.g., 'MT', 'PT20', 'CARIB'). */
+    geo?: string
+    /** Title. */
+    title?: string
+    /** Position of the title, relative to the inset's top-left corner. */
+    titlePosition?: [number, number]
+    /** Subtitle. */
+    subtitle?: string
+    /** Position of the subtitle, relative to the inset's top-left corner. */
+    subtitlePosition?: [number, number]
+    /** Scale. Named nuts2json scale (e.g. '01M', '03M', '10M', '20M', '60M') or a number. */
+    scale?: string | number
+    /** Width. */
+    width?: number
+    /** Height. */
+    height?: number
+    /** X position of the inset within the inset box. */
+    x?: number
+    /** Y position of the inset within the inset box. */
+    y?: number
+    /** Proj. */
+    proj?: string
+    /** Id of the `<svg>` element the inset is drawn into. Auto-generated if omitted. */
+    svgId?: string
+    /** Manual re-centering/zoom of the inset's own projection. */
+    position?: { x?: number; y?: number; z?: number }
+    /** Label rendering settings for this inset. */
+    labels?: LabelsConfig
+    /** Whether to show zoom buttons on this inset. @default false */
+    zoomButtons?: boolean
+    /** Custom base URL for this inset's nuts2json boundary data. */
+    nuts2jsonBaseURL?: string
+    /** Custom D3 projection function for this inset. */
+    projectionFunction?: Function | boolean
+
+    /** Scalebar settings for this inset. `true` uses the default scalebar config. */
+    scalebar?: ScalebarConfig | boolean
+
+    /** @deprecated Use `scalebar: { show: true }` instead. */
+    showScalebar?: boolean
+    /** @deprecated Use `scalebar: { position: [x, y] }` instead. */
+    scalebarPosition?: [number, number]
+    /** @deprecated Use `scalebar: { tickHeight }` instead. */
+    scalebarTickHeight?: number
+    /** @deprecated Use `scalebar: { segmentHeight }` instead. */
+    scalebarSegmentHeight?: number
+    /** Scalebar label font size in pixels. */
+    scalebarFontSize?: number
+    /** @deprecated Use `scalebar: { units }` instead. */
+    scalebarUnits?: string
+    /** @deprecated Use `scalebar: { textOffset }` instead. */
+    scalebarTextOffset?: [number, number]
+    /** @deprecated Use `scalebar: { maxWidth }` instead. */
+    scalebarMaxWidth?: number
+    /** Minimum width of the scalebar in pixels. */
+    scalebarMinWidth?: number
+
+    /** Nested insets belonging to this inset (e.g. bivariate choropleth per-inset legend classification). */
+    insets?: InsetConfig[]
+    /** Position of nested insets' inset box, relative to this inset. */
+    insetBoxPosition?: [number, number]
+
+    [key: string]: any
+}

package/build/types/core/MapConfig.d.ts

@@ -1,6 +1,7 @@
 import type { StatConfig } from './stat/StatConfig'
 import type { CompositionStatConfig } from '../layers/composition/CompositionStatConfig'
 import type { LegendConfig } from '../legend/LegendConfig'
+import type { RankedBarChartConfig } from '../legend/choropleth/RankedBarChartConfig'
 import type { TooltipConfig } from './TooltipConfig'
 import type { InsetConfig } from './InsetConfig'
 import type { MapInstance as EurostatMap } from './MapInstance'
@@ -73,6 +74,13 @@ export interface MapConfig {
     /** Legend configuration. */
     legend?: LegendConfig | false
 
+    /**
+     * Ranked bar chart configuration (choropleth-classified map types only). Independent of the
+     * legend - has its own positioning and can render into an entirely different container/SVG
+     * to the legend's, rather than being a sub-feature of it.
+     */
+    rankedBarChart?: RankedBarChartConfig | false
+
     /** Tooltip configuration. */
     tooltip?: TooltipConfig
 

package/build/types/core/MapInstance.d.ts

@@ -4,6 +4,7 @@ import type { Layer } from './layer/Layer'
 import type { LayerConfig } from './layer/LayerConfig'
 import type { CompositionStatConfig } from '../layers/composition/CompositionStatConfig'
 import type { LegendConfig } from '../legend/LegendConfig'
+import type { RankedBarChartConfig } from '../legend/choropleth/RankedBarChartConfig'
 import type { TooltipConfig } from './TooltipConfig'
 import type { InsetConfig } from './InsetConfig'
 import type { CoastalMarginSettings } from './decoration/CoastalMarginSettings'
@@ -204,6 +205,20 @@ export interface MapInstance {
     /** Force-update the legend after data or style changes. */
     updateLegend(): this
 
+    /** Ranked bar chart. */
+
+    /**
+     * Get or set ranked bar chart configuration (choropleth-classified map types only). Pass
+     * false to remove it. Independent of the legend - has its own positioning and can render
+     * into an entirely different container/SVG to the legend's.
+     * @example map.rankedBarChart({ svgId: 'my-bar-chart-container' })
+     */
+    rankedBarChart(): RankedBarChartConfig | false
+    rankedBarChart(config: RankedBarChartConfig | false): this
+
+    /** Force-update the ranked bar chart after data or style changes. */
+    updateRankedBarChart(): this
+
     /** Tooltip. */
 
     /** Get or set tooltip configuration. */

package/build/types/core/encoding/EncodingConfig.d.ts

@@ -1,31 +1,31 @@
-/**
- * Configuration for mapping a named stat dataset to a visual channel.
- */
-export interface EncodingConfig {
-    /** Name of a dataset registered with map.stat(name, config). */
-    stat?: string
-    /** Names of datasets for multi-stat encodings such as bivariate color. */
-    stats?: string[]
-    /** Whether the encoding is based on raw values or category codes. */
-    by?: 'value' | 'category'
-    /** Encoding type. */
-    type?: 'linear' | 'sqrt' | 'threshold' | 'quantile' | 'categorical' | 'bivariate' | 'trivariate'
-    /** Scale type. */
-    scale?: 'linear' | 'sqrt' | 'quantile' | 'threshold'
-    /** Numeric or color output range. */
-    range?: [number, number] | string[]
-    /** Explicit encoded values, for example category colors. */
-    values?: Record<string, string | number> | Array<string | number>
-    /** Labels keyed by category code or value. */
-    labels?: Record<string, string> | string[]
-    /** Category codes when using array-based values or labels. */
-    categoryCodes?: string[]
-    /** Number of classes for classified encodings. */
-    classes?: number
-    /** Threshold values for threshold encodings. */
-    thresholds?: number[]
-    /** Color scheme name or function. */
-    scheme?: string | Function
-    /** Optional unit override for this encoding. */
-    unitText?: string
-}
+/**
+ * Configuration for mapping a named stat dataset to a visual channel.
+ */
+export interface EncodingConfig {
+    /** Name of a dataset registered with map.stat(name, config). */
+    stat?: string
+    /** Names of datasets for multi-stat encodings such as bivariate color. */
+    stats?: string[]
+    /** Whether the encoding is based on raw values or category codes. */
+    by?: 'value' | 'category'
+    /** Encoding type. */
+    type?: 'linear' | 'sqrt' | 'threshold' | 'quantile' | 'categorical' | 'bivariate' | 'trivariate'
+    /** Scale type. */
+    scale?: 'linear' | 'sqrt' | 'quantile' | 'threshold'
+    /** Numeric or color output range. */
+    range?: [number, number] | string[]
+    /** Explicit encoded values, for example category colors. */
+    values?: Record<string, string | number> | Array<string | number>
+    /** Labels keyed by category code or value. */
+    labels?: Record<string, string> | string[]
+    /** Category codes when using array-based values or labels. */
+    categoryCodes?: string[]
+    /** Number of classes for classified encodings. */
+    classes?: number
+    /** Threshold values for threshold encodings. */
+    thresholds?: number[]
+    /** Color scheme name or function. */
+    scheme?: string | Function
+    /** Optional unit override for this encoding. */
+    unitText?: string
+}

package/build/types/core/layer/Layer.d.ts

@@ -1,31 +1,31 @@
-import type { MapInstance } from '../MapInstance'
-import type { EncodingConfig } from '../encoding/EncodingConfig'
-import type { StatData } from '../stat/StatData'
-import type { LayerRole } from './LayerRole'
-
-export interface Layer {
-    map: MapInstance
-    isLayer: true
-    id: string
-    type: string
-    role: LayerRole
-
-    encodings_: Record<string, EncodingConfig>
-
-    encoding(): Record<string, EncodingConfig>
-    encoding(channel: string): EncodingConfig | undefined
-    encoding(channel: string, config: EncodingConfig): Layer
-    encoding(map: Record<string, EncodingConfig>): Layer
-
-    getEncodingStat(channel: string, fallback?: string): string | undefined
-    getEncodingStats(channel: string, fallback?: string[]): string[] | undefined
-    getEncodingStatKey(channel: string, categoryCode?: string, fallbackStat?: string): string
-    getEncodingStatData(channel: string, categoryCode?: string, fallbackStat?: string): StatData
-    getEncodingValue(channel: string, regionId: string, categoryCode?: string, fallbackStat?: string): number | string | undefined
-    getEncodingUnitText(channel: string, categoryCode?: string, fallbackStat?: string): string
-
-    updateClassification(): Layer
-    updateStyle(): Layer
-    getLegendConstructor(): (map: MapInstance, config?: any) => any
-    group(): any // d3 selection
-}
+import type { MapInstance } from '../MapInstance'
+import type { EncodingConfig } from '../encoding/EncodingConfig'
+import type { StatData } from '../stat/StatData'
+import type { LayerRole } from './LayerRole'
+
+export interface Layer {
+    map: MapInstance
+    isLayer: true
+    id: string
+    type: string
+    role: LayerRole
+
+    encodings_: Record<string, EncodingConfig>
+
+    encoding(): Record<string, EncodingConfig>
+    encoding(channel: string): EncodingConfig | undefined
+    encoding(channel: string, config: EncodingConfig): Layer
+    encoding(map: Record<string, EncodingConfig>): Layer
+
+    getEncodingStat(channel: string, fallback?: string): string | undefined
+    getEncodingStats(channel: string, fallback?: string[]): string[] | undefined
+    getEncodingStatKey(channel: string, categoryCode?: string, fallbackStat?: string): string
+    getEncodingStatData(channel: string, categoryCode?: string, fallbackStat?: string): StatData
+    getEncodingValue(channel: string, regionId: string, categoryCode?: string, fallbackStat?: string): number | string | undefined
+    getEncodingUnitText(channel: string, categoryCode?: string, fallbackStat?: string): string
+
+    updateClassification(): Layer
+    updateStyle(): Layer
+    getLegendConstructor(): (map: MapInstance, config?: any) => any
+    group(): any // d3 selection
+}

package/build/types/core/layer/LayerConfig.d.ts

@@ -1,19 +1,19 @@
-import type { MapType } from '../../layers/MapType'
-import type { EncodingConfig } from '../encoding/EncodingConfig'
-import type { LegendConfig } from '../../legend/LegendConfig'
-import type { LayerRole } from './LayerRole'
-
-export interface LayerConfig {
-    /** Stable id; auto-generated if omitted. */
-    id?: string
-    /** Layer type (same identifiers as map types). */
-    type: MapType
-    /** Explicit role; defaults from the type. */
-    role?: LayerRole
-    /** Keyed visual encodings: fill, size, color, stroke, … */
-    encoding?: Record<string, EncodingConfig>
-    /** Per-layer legend config. */
-    legend?: LegendConfig
-    /** Type-specific settings are also accepted. */
-    [key: string]: any
-}
+import type { MapType } from '../../layers/MapType'
+import type { EncodingConfig } from '../encoding/EncodingConfig'
+import type { LegendConfig } from '../../legend/LegendConfig'
+import type { LayerRole } from './LayerRole'
+
+export interface LayerConfig {
+    /** Stable id; auto-generated if omitted. */
+    id?: string
+    /** Layer type (same identifiers as map types). */
+    type: MapType
+    /** Explicit role; defaults from the type. */
+    role?: LayerRole
+    /** Keyed visual encodings: fill, size, color, stroke, … */
+    encoding?: Record<string, EncodingConfig>
+    /** Per-layer legend config. */
+    legend?: LegendConfig
+    /** Type-specific settings are also accepted. */
+    [key: string]: any
+}

package/build/types/core/layer/LayerRole.d.ts

@@ -1 +1 @@
-export type LayerRole = 'base' | 'overlay'
+export type LayerRole = 'base' | 'overlay'

package/build/types/index.d.ts

@@ -87,6 +87,7 @@ export type { ChoroplethLegendConfig } from './legend/choropleth/ChoroplethLegen
 export type { BivariateLegendConfig } from './legend/choropleth/BivariateLegendConfig'
 export type { HistogramLegendConfig } from './legend/choropleth/HistogramLegendConfig'
 export type { TrivariateLegendConfig } from './legend/choropleth/TrivariateLegendConfig'
+export type { RankedBarChartConfig } from './legend/choropleth/RankedBarChartConfig'
 
 // Composition legend types
 export type { BarChartLegendConfig } from './legend/composition/BarChartLegendConfig'

package/build/types/layers/CategoricalMapConfig.d.ts

@@ -1,13 +1,13 @@
-import type { MapConfig } from '../core/MapConfig'
-
-/**
- * Configuration for categorical map
- */
-export interface CategoricalMapConfig extends MapConfig {
-    /** Category-to-color mapping */
-    classToFillStyle?: Record<string, string>
-    /** Category-to-label mapping, used for legend text and tooltips */
-    classToText?: Record<string, string>
-    /** Fill style for regions with no data */
-    noDataFillStyle?: string
-}
+import type { MapConfig } from '../core/MapConfig'
+
+/**
+ * Configuration for categorical map
+ */
+export interface CategoricalMapConfig extends MapConfig {
+    /** Category-to-color mapping */
+    classToFillStyle?: Record<string, string>
+    /** Category-to-label mapping, used for legend text and tooltips */
+    classToText?: Record<string, string>
+    /** Fill style for regions with no data */
+    noDataFillStyle?: string
+}

package/build/types/layers/composition/bar/BarMap.d.ts

@@ -1,97 +1,97 @@
-import type { MapInstance } from '../../../core/MapInstance'
-import type { CompositionStatConfig } from '../CompositionStatConfig'
-import type { BarChartLegendConfig } from '../../../legend/composition/BarChartLegendConfig'
-
-/**
- * Bar map type.
- */
-export interface BarMap extends MapInstance {
-    legend(): BarChartLegendConfig | false
-    legend(config: BarChartLegendConfig | false): this
-
-    barType(): 'stacked' | 'grouped'
-    barType(v: 'stacked' | 'grouped'): this
-
-    catColors(): any
-    catColors(v: any): this
-
-    catLabels(): any
-    catLabels(v: any): this
-
-    showOnlyWhenComplete(): boolean
-    showOnlyWhenComplete(v: boolean): this
-
-    noDataFillStyle(): string
-    noDataFillStyle(v: string): this
-
-    barMaxWidth(): number
-    barMaxWidth(v: number): this
-
-    barMinWidth(): number
-    barMinWidth(v: number): this
-
-    barHeight(): number
-    barHeight(v: number): this
-
-    barGroupWidth(): number
-    barGroupWidth(v: number): this
-
-    barSettings(): any
-    barSettings(v: any): this
-
-    barGroupGap(): number
-    barGroupGap(v: number): this
-
-    barGroupMinHeight(): number
-    barGroupMinHeight(v: number): this
-
-    barGroupMaxHeight(): number
-    barGroupMaxHeight(v: number): this
-
-    barStrokeFill(): string
-    barStrokeFill(v: string): this
-
-    barStrokeWidth(): number
-    barStrokeWidth(v: number): this
-
-    barCornerRadius(): number
-    barCornerRadius(v: number): this
-
-    barOtherColor(): string
-    barOtherColor(v: string): this
-
-    barOtherText(): string
-    barOtherText(v: string): this
-
-    barTooltipWidth(): number
-    barTooltipWidth(v: number): this
-
-    barTooltipHeight(): number
-    barTooltipHeight(v: number): this
-
-    dorling(): boolean
-    dorling(v: boolean): this
-
-    barTotalCode(): string | undefined
-    barTotalCode(v: string | undefined): this
-
-    statCodes(): string[] | undefined
-    statCodes(v: string[] | undefined): this
-
-    statBar(config: CompositionStatConfig): this
-    /** @deprecated Legacy positional signature. Prefer statBar({ categoryParameter, categoryCodes, ... }). */
-    statBar(
-        /** Config. */
-        config: CompositionStatConfig,
-        /** Category parameter. */
-        categoryParameter?: string,
-        /** Category codes. */
-        categoryCodes?: string[],
-        /** Category labels. */
-        categoryLabels?: string[],
-        /** Category colors. */
-        categoryColors?: string[],
-        /** Total code. */
-        totalCode?: string
-    ): this
-}
+import type { MapInstance } from '../../../core/MapInstance'
+import type { CompositionStatConfig } from '../CompositionStatConfig'
+import type { BarChartLegendConfig } from '../../../legend/composition/BarChartLegendConfig'
+
+/**
+ * Bar map type.
+ */
+export interface BarMap extends MapInstance {
+    legend(): BarChartLegendConfig | false
+    legend(config: BarChartLegendConfig | false): this
+
+    barType(): 'stacked' | 'grouped'
+    barType(v: 'stacked' | 'grouped'): this
+
+    catColors(): any
+    catColors(v: any): this
+
+    catLabels(): any
+    catLabels(v: any): this
+
+    showOnlyWhenComplete(): boolean
+    showOnlyWhenComplete(v: boolean): this
+
+    noDataFillStyle(): string
+    noDataFillStyle(v: string): this
+
+    barMaxWidth(): number
+    barMaxWidth(v: number): this
+
+    barMinWidth(): number
+    barMinWidth(v: number): this
+
+    barHeight(): number
+    barHeight(v: number): this
+
+    barGroupWidth(): number
+    barGroupWidth(v: number): this
+
+    barSettings(): any
+    barSettings(v: any): this
+
+    barGroupGap(): number
+    barGroupGap(v: number): this
+
+    barGroupMinHeight(): number
+    barGroupMinHeight(v: number): this
+
+    barGroupMaxHeight(): number
+    barGroupMaxHeight(v: number): this
+
+    barStrokeFill(): string
+    barStrokeFill(v: string): this
+
+    barStrokeWidth(): number
+    barStrokeWidth(v: number): this
+
+    barCornerRadius(): number
+    barCornerRadius(v: number): this
+
+    barOtherColor(): string
+    barOtherColor(v: string): this
+
+    barOtherText(): string
+    barOtherText(v: string): this
+
+    barTooltipWidth(): number
+    barTooltipWidth(v: number): this
+
+    barTooltipHeight(): number
+    barTooltipHeight(v: number): this
+
+    dorling(): boolean
+    dorling(v: boolean): this
+
+    barTotalCode(): string | undefined
+    barTotalCode(v: string | undefined): this
+
+    statCodes(): string[] | undefined
+    statCodes(v: string[] | undefined): this
+
+    statBar(config: CompositionStatConfig): this
+    /** @deprecated Legacy positional signature. Prefer statBar({ categoryParameter, categoryCodes, ... }). */
+    statBar(
+        /** Config. */
+        config: CompositionStatConfig,
+        /** Category parameter. */
+        categoryParameter?: string,
+        /** Category codes. */
+        categoryCodes?: string[],
+        /** Category labels. */
+        categoryLabels?: string[],
+        /** Category colors. */
+        categoryColors?: string[],
+        /** Total code. */
+        totalCode?: string
+    ): this
+}