eurostat-map 4.8.2 → 4.8.5

package/build/package.json

@@ -1,87 +1,87 @@
-{
-  "name": "eurostat-map",
-  "version": "4.8.2",
-  "description": "Reusable library to quickly create and customise web maps showing Eurostat data directly retrieved from Eurostat database.",
-  "keywords": [
-    "eurostat",
-    "statistics",
-    "europe",
-    "SVG",
-    "NUTS",
-    "map",
-    "D3",
-    "cartography",
-    "thematic",
-    "mapping",
-    "eurostat-map",
-    "dataviz",
-    "data visualization"
-  ],
-  "homepage": "https://github.com/eurostat/eurostat-map",
-  "author": "",
-  "license": "EUPL-1.2",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/eurostat/eurostat-map.git"
-  },
-  "main": "build/eurostatmap.min.js",
-  "unpkg": "build/eurostatmap.min.js",
-  "module": "build/eurostatmap.js",
-  "types": "build/types/index.d.ts",
-  "typings": "build/types/index.d.ts",
-  "files": [
-    "build"
-  ],
-  "scripts": {
-    "start": "webpack --config webpack/webpack.config.dev.js",
-    "server": "webpack-dev-server --open --watch",
-    "build-types": "tsc --project tsconfig.json",
-    "build-prod": "npm run build-types && webpack --config webpack/webpack.config.prod.js",
-    "build-prod-debug": "webpack --config webpack/webpack.config.debug-size.js",
-    "format": "prettier --write .",
-    "test": "jest",
-    "type-check": "tsc --noEmit"
-  },
-  "dependencies": {
-    "d3-array": "^3.2.4",
-    "d3-axis": "^3.0.0",
-    "d3-ease": "^3.0.1",
-    "d3-fetch": "^3.0.1",
-    "d3-force": "^3.0.0",
-    "d3-format": "^3.1.0",
-    "d3-geo": "^3.1.1",
-    "d3-geo-projection": "^3.0.0",
-    "d3-interpolate": "^3.0.1",
-    "d3-scale": "^4.0.2",
-    "d3-scale-chromatic": "^3.1.0",
-    "d3-selection": "^3.0.0",
-    "d3-shape": "^3.2.0",
-    "d3-svg-annotation": "^2.5.1",
-    "d3-zoom": "^3.0.0",
-    "idb-keyval": "^6.2.2",
-    "jsonstat-toolkit": "^1.0.8",
-    "proj4": "^2.17.0",
-    "simple-statistics": "^7.8.8",
-    "topojson-client": "^3.1.0"
-  },
-  "overrides": {
-    "d3-color": "3.1.0"
-  },
-  "devDependencies": {
-    "@babel/core": "^7.22.6",
-    "@babel/plugin-transform-runtime": "^7.22.6",
-    "@babel/preset-env": "^7.22.6",
-    "@babel/runtime": "^7.12.1",
-    "babel-loader": "^9.1.2",
-    "css-loader": "^7.1.2",
-    "prettier": "^3.4.1",
-    "style-loader": "^4.0.0",
-    "ts-loader": "^9.5.4",
-    "typescript": "^5.9.3",
-    "webpack": "^5.88.1",
-    "webpack-bundle-analyzer": "^4.10.2",
-    "webpack-cli": "^5.0.0",
-    "webpack-dev-server": "^5.2.2",
-    "webpack-livereload-plugin": "^3.0.2"
-  }
-}
+{
+  "name": "eurostat-map",
+  "version": "4.8.5",
+  "description": "Reusable library to quickly create and customise web maps showing Eurostat data directly retrieved from Eurostat database.",
+  "keywords": [
+    "eurostat",
+    "statistics",
+    "europe",
+    "SVG",
+    "NUTS",
+    "map",
+    "D3",
+    "cartography",
+    "thematic",
+    "mapping",
+    "eurostat-map",
+    "dataviz",
+    "data visualization"
+  ],
+  "homepage": "https://github.com/eurostat/eurostat-map",
+  "author": "",
+  "license": "EUPL-1.2",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/eurostat/eurostat-map.git"
+  },
+  "main": "build/eurostatmap.min.js",
+  "unpkg": "build/eurostatmap.min.js",
+  "module": "build/eurostatmap.js",
+  "types": "build/types/index.d.ts",
+  "typings": "build/types/index.d.ts",
+  "files": [
+    "build"
+  ],
+  "scripts": {
+    "start": "webpack --config webpack/webpack.config.dev.js",
+    "server": "webpack-dev-server --open --watch",
+    "build-types": "tsc --project tsconfig.json",
+    "build-prod": "npm run build-types && webpack --config webpack/webpack.config.prod.js",
+    "build-prod-debug": "webpack --config webpack/webpack.config.debug-size.js",
+    "format": "prettier --write .",
+    "test": "jest",
+    "type-check": "tsc --noEmit"
+  },
+  "dependencies": {
+    "d3-array": "^3.2.4",
+    "d3-axis": "^3.0.0",
+    "d3-ease": "^3.0.1",
+    "d3-fetch": "^3.0.1",
+    "d3-force": "^3.0.0",
+    "d3-format": "^3.1.0",
+    "d3-geo": "^3.1.1",
+    "d3-geo-projection": "^3.0.0",
+    "d3-interpolate": "^3.0.1",
+    "d3-scale": "^4.0.2",
+    "d3-scale-chromatic": "^3.1.0",
+    "d3-selection": "^3.0.0",
+    "d3-shape": "^3.2.0",
+    "d3-svg-annotation": "^2.5.1",
+    "d3-zoom": "^3.0.0",
+    "idb-keyval": "^6.2.2",
+    "jsonstat-toolkit": "^1.0.8",
+    "proj4": "^2.17.0",
+    "simple-statistics": "^7.8.8",
+    "topojson-client": "^3.1.0"
+  },
+  "overrides": {
+    "d3-color": "3.1.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.22.6",
+    "@babel/plugin-transform-runtime": "^7.22.6",
+    "@babel/preset-env": "^7.22.6",
+    "@babel/runtime": "^7.12.1",
+    "babel-loader": "^9.1.2",
+    "css-loader": "^7.1.2",
+    "prettier": "^3.4.1",
+    "style-loader": "^4.0.0",
+    "ts-loader": "^9.5.4",
+    "typescript": "^5.9.3",
+    "webpack": "^5.88.1",
+    "webpack-bundle-analyzer": "^4.10.2",
+    "webpack-cli": "^5.0.0",
+    "webpack-dev-server": "^5.2.2",
+    "webpack-livereload-plugin": "^3.0.2"
+  }
+}

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

@@ -1,23 +1,71 @@
-/**
- * Configuration for map insets (smaller additional maps)
- */
-export interface InsetConfig {
-    /** Geographic code (e.g., 'MT', 'PT20', 'CARIB'). */
-    geo?: string
-    /** Title. */
-    title?: string
-    /** Scale. */
-    scale?: string | number
-    /** Width. */
-    width?: number
-    /** Height. */
-    height?: number
-    /** X. */
-    x?: number
-    /** Y. */
-    y?: number
-    /** Proj. */
-    proj?: string
-
-    [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/decoration/LabelsConfig.d.ts

@@ -1,3 +1,19 @@
+/**
+ * A single map label (country name, statistical value label, etc.)
+ */
+export interface Label {
+    text: string
+    x: number
+    y: number
+    class?: string
+    /** Font size in pixels. @deprecated Use CSS classes instead. */
+    size?: number
+    rotate?: number | null
+    letterSpacing?: number
+    /** Country code, when this label represents a country. */
+    cc?: string
+}
+
 /**
  * Configuration for map labels (country names, statistical values, etc.)
  */
@@ -6,16 +22,7 @@ export interface LabelsConfig {
      * Array of label objects with text and coordinates.
      * Use eurostatmap.getDefaultLabels() to get predefined geographic labels.
      */
-    labels?: Array<{
-        text: string
-        x: number
-        y: number
-        class?: string
-        size?: number
-        rotate?: number
-        letterSpacing?: number
-        cc?: string
-    }>
+    labels?: Label[]
 
     /**
      * Show statistical values as labels on regions.

package/build/types/index.d.ts

@@ -64,10 +64,11 @@ export type { InsetConfig } from './core/InsetConfig'
 export type { CoastalMarginSettings } from './core/decoration/CoastalMarginSettings'
 export type { ScalebarConfig } from './core/decoration/ScalebarConfig'
 export type { StampConfig } from './core/decoration/StampConfig'
+export type { LabelsConfig, Label } from './core/decoration/LabelsConfig'
 export type { GridCartogramSettings, GridCartogramMargins } from './core/GridCartogramSettings'
 export type { DorlingSettings, DorlingStrength } from './core/DorlingSettings'
 export type { MinimapConfig } from './core/minimaps'
-export type { LocationConfig } from './core/locations'
+export type { LocationConfig, LocationLabelStyle, LocationShape } from './core/locations'
 export type { GeometriesClass } from './core/geo/geometries'
 export type { Layer } from './core/layer/Layer'
 export type { LayerConfig } from './core/layer/LayerConfig'

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

@@ -6,6 +6,8 @@ import type { MapConfig } from '../core/MapConfig'
 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/legend/LegendConfig.d.ts

@@ -1,73 +1,73 @@
-/**
- * Parent configuration for map legends. Each map type will extend this with its own specific properties, but these are the common ones that apply to all legend types.
- */
-export interface LegendConfig {
-    /** Legend origin x-coordinate in pixels. */
-    x?: number
-    /** Legend origin y-coordinate in pixels. */
-    y?: number
-    /** Automatically position the legend in a map corner. Manual x/y coordinates take precedence. */
-    position?: 'top right' | 'bottom right' | 'top left' | 'bottom left'
-    /** Legend width in pixels. */
-    width?: number
-    /** Legend height in pixels. */
-    height?: number
-
-    /** Legend title text. */
-    title?: string
-    /** Legend subtitle text. */
-    subtitle?: string
-    /** Legend title font size in pixels. */
-    titleFontSize?: number
-
-    /** Box styling. */
-    /** Inner spacing around legend content. */
-    boxPadding?: number
-    /** Background opacity of the legend box. */
-    boxOpacity?: number
-    /** Apply legend hover opacity/highlighting only while the map is currently zoomed in (scale != 1); disabled again once zoomed back out to the initial view. */
-    onlyApplyOpacityWhileZoomed?: boolean
-    /** Padding between the title block and legend body. */
-    titlePadding?: number
-
-    /** Shape styling (for proportional symbol legends). */
-    /** Symbol swatch width in pixels. */
-    shapeWidth?: number
-    /** Symbol swatch height in pixels. */
-    shapeHeight?: number
-    /** Horizontal gap between shape and label. */
-    shapePadding?: number
-    /** Length of separator lines in discrete legends. */
-    sepLineLength?: number
-
-    /** Label styling. */
-    /** Label font size in pixels. */
-    labelFontSize?: number
-    /** Pixel offsets applied to labels. */
-    labelOffsets?: { x: number; y: number }
-    /** Custom formatter for legend labels. */
-    labelFormatter?: ((value: number, index?: number) => string) | null
-    /** Number of decimal places for auto-formatted labels. */
-    decimals?: number
-
-    /** Legend layout direction. */
-    orientation?: 'vertical' | 'horizontal'
-    /** Sort legend entries in ascending order when true. */
-    ascending?: boolean
-    /** Whether to display the no-data legend item. */
-    noData?: boolean
-    /** Label used for no-data legend item. */
-    noDataText?: string
-    /** Vertical gap before the no-data swatch in pixels. */
-    noDataPadding?: number
-    /** Width of the no-data swatch in pixels. */
-    noDataShapeWidth?: number
-    /** Height of the no-data swatch in pixels. */
-    noDataShapeHeight?: number
-
-    /** Whether to show dataset min/max labels when supported. */
-    maxMin?: boolean
-    /** Text affixes for min/max labels as [minSuffix, maxSuffix]. */
-    maxMinLabels?: [string, string]
-    layer?: any
-}
+/**
+ * Parent configuration for map legends. Each map type will extend this with its own specific properties, but these are the common ones that apply to all legend types.
+ */
+export interface LegendConfig {
+    /** Legend origin x-coordinate in pixels. */
+    x?: number
+    /** Legend origin y-coordinate in pixels. */
+    y?: number
+    /** Automatically position the legend in a map corner. Manual x/y coordinates take precedence. */
+    position?: 'top right' | 'bottom right' | 'top left' | 'bottom left'
+    /** Legend width in pixels. */
+    width?: number
+    /** Legend height in pixels. */
+    height?: number
+
+    /** Legend title text. */
+    title?: string
+    /** Legend subtitle text. */
+    subtitle?: string
+    /** Legend title font size in pixels. */
+    titleFontSize?: number
+
+    /** Box styling. */
+    /** Inner spacing around legend content. */
+    boxPadding?: number
+    /** Background opacity of the legend box. */
+    boxOpacity?: number
+    /** Apply legend hover opacity/highlighting only while the map is currently zoomed in (scale != 1). The legend box is transparent at the initial view and returns to its configured opacity while zoomed. */
+    onlyApplyOpacityWhileZoomed?: boolean
+    /** Padding between the title block and legend body. */
+    titlePadding?: number
+
+    /** Shape styling (for proportional symbol legends). */
+    /** Symbol swatch width in pixels. */
+    shapeWidth?: number
+    /** Symbol swatch height in pixels. */
+    shapeHeight?: number
+    /** Horizontal gap between shape and label. */
+    shapePadding?: number
+    /** Length of separator lines in discrete legends. */
+    sepLineLength?: number
+
+    /** Label styling. */
+    /** Label font size in pixels. */
+    labelFontSize?: number
+    /** Pixel offsets applied to labels. */
+    labelOffsets?: { x: number; y: number }
+    /** Custom formatter for legend labels. */
+    labelFormatter?: ((value: number, index?: number) => string) | null
+    /** Number of decimal places for auto-formatted labels. */
+    decimals?: number
+
+    /** Legend layout direction. */
+    orientation?: 'vertical' | 'horizontal'
+    /** Sort legend entries in ascending order when true. */
+    ascending?: boolean
+    /** Whether to display the no-data legend item. */
+    noData?: boolean
+    /** Label used for no-data legend item. */
+    noDataText?: string
+    /** Vertical gap before the no-data swatch in pixels. */
+    noDataPadding?: number
+    /** Width of the no-data swatch in pixels. */
+    noDataShapeWidth?: number
+    /** Height of the no-data swatch in pixels. */
+    noDataShapeHeight?: number
+
+    /** Whether to show dataset min/max labels when supported. */
+    maxMin?: boolean
+    /** Text affixes for min/max labels as [minSuffix, maxSuffix]. */
+    maxMinLabels?: [string, string]
+    layer?: any
+}