eurostat-map 4.4.1 → 4.4.2

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

@@ -6,6 +6,7 @@ import type { MapInstance as EurostatMap } from './MapInstance'
 import type { CoastalMarginSettings } from './decoration/CoastalMarginSettings'
 import type { GridCartogramSettings } from './GridCartogramSettings'
 import type { DorlingSettings } from './DorlingSettings'
+import type { ScalebarConfig } from './decoration/ScalebarConfig'
 
 /**
  * Base configuration for all map types. Each specific map type will extend this with its own properties, but these are the common ones that apply to all maps.
@@ -59,7 +60,7 @@ export interface MapConfig {
     stat?: StatConfig
 
     /** Legend configuration. */
-    legend?: LegendConfig
+    legend?: LegendConfig | false
 
     /** Tooltip configuration. */
     tooltip?: TooltipConfig
@@ -90,6 +91,78 @@ export interface MapConfig {
     /** Fires once the map is built. */
     onBuild?: (map: EurostatMap) => void
 
+    /** Scalebar configuration. Can be boolean or configuration object. */
+    scalebar?: ScalebarConfig | boolean
+
+    /** Grid cartogram enabled or disabled. */
+    gridCartogram?: boolean
+
+    /** Custom geometry filtering function. */
+    filterGeometriesFunction?: (geometry: any) => boolean
+
+    /** Toggle background map rendering (sea, country boundaries, etc.). */
+    backgroundMap?: boolean
+
+    /** Minimap configuration. */
+    minimap?: any
+
+    /** Show/hide zoom +/- buttons. */
+    zoomButtons?: boolean
+
+    /** Show/hide inset map toggle button. */
+    insetsButton?: boolean
+
+    /** Show/hide placename labels. */
+    placenames?: boolean
+
+    /** Filter function for placename labels. */
+    placenamesFilter?: (name: any) => boolean
+
+    /** Use a separate header section for titles. */
+    header?: boolean
+
+    /** Use a separate footer section for footnotes. */
+    footer?: boolean
+
+    /** Padding between the map and footer in pixels. */
+    footerPadding?: number
+
+    /** Padding between the header and map in pixels. */
+    headerPadding?: number
+
+    /** Position adjustment for map title: [x, y] */
+    titlePosition?: [number, number]
+
+    /** Position adjustment for map subtitle: [x, y] */
+    subtitlePosition?: [number, number]
+
+    /** Position adjustment for footnote text: [x, y] */
+    footnotePosition?: [number, number]
+
+    /** Position adjustment for Eurostat logo: [x, y] */
+    logoPosition?: [number, number]
+
+    /** Position adjustment for ribbon banner: [x, y] */
+    ribbonPosition?: [number, number]
+
+    /** Position adjustment for zoom buttons: [x, y] */
+    zoomButtonsPosition?: [number, number]
+
+    /** Position adjustment for insets button: [x, y] */
+    insetsButtonPosition?: [number, number]
+
+    /** Pointer hover color for NUTS regions. */
+    hoverColor?: string
+
+    /** Base fill color for regions with no statistical data. */
+    noDataFillStyle?: string
+
+    /** Show the link to the remote Eurostat statistical dataset. */
+    showSourceLink?: boolean
+
+    /** Pattern fill configurations. */
+    patternFill?: any
+
     /** Allow additional properties for extensibility. */
     [key: string]: any
 }

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

@@ -6,6 +6,7 @@ import type { InsetConfig } from './InsetConfig'
 import type { CoastalMarginSettings } from './decoration/CoastalMarginSettings'
 import type { GridCartogramSettings } from './GridCartogramSettings'
 import type { DorlingSettings } from './DorlingSettings'
+import type { ScalebarConfig } from './decoration/ScalebarConfig'
 
 /**
  * A eurostat-map instance. Created by eurostatmap.map() and extended
@@ -221,6 +222,10 @@ export interface MapInstance {
     stamp(): object | undefined
     stamp(config: { x: number; y: number; text: string; size?: number }): this
 
+    /** Scalebar configuration. */
+    scalebar(): ScalebarConfig | null
+    scalebar(config: ScalebarConfig | boolean): this
+
     /** Scalebar visibility. */
     showScalebar(): boolean
     showScalebar(show: boolean): this
@@ -237,6 +242,94 @@ export interface MapInstance {
     showEstatRibbon(): boolean
     showEstatRibbon(show: boolean): this
 
+    /** Returns the D3 selection of the SVG element. */
+    svg(): any
+    svg(s: any): this
+
+    /** Custom geometry filtering function. */
+    filterGeometriesFunction(): ((geometry: any) => boolean) | undefined
+    filterGeometriesFunction(fn: (geometry: any) => boolean): this
+
+    /** Grid cartogram enabled or disabled. */
+    gridCartogram(): boolean
+    gridCartogram(enable: boolean): this
+
+    /** Toggle background map rendering (sea, country boundaries, etc.). */
+    backgroundMap(): boolean
+    backgroundMap(show: boolean): this
+
+    /** Minimap configuration. */
+    minimap(): any
+    minimap(config: any): this
+
+    /** Show/hide inset map toggle button. */
+    insetsButton(): boolean
+    insetsButton(show: boolean): this
+
+    /** Filter function for placename labels. */
+    placenamesFilter(): ((name: any) => boolean) | undefined
+    placenamesFilter(fn: (name: any) => boolean): this
+
+    /** Use a separate header section for titles. */
+    header(): boolean
+    header(show: boolean): this
+
+    /** Use a separate footer section for footnotes. */
+    footer(): boolean
+    footer(show: boolean): this
+
+    /** Padding between the map and footer in pixels. */
+    footerPadding(): number | undefined
+    footerPadding(padding: number): this
+
+    /** Padding between the header and map in pixels. */
+    headerPadding(): number | undefined
+    headerPadding(padding: number): this
+
+    /** Position adjustment for map title: [x, y] */
+    titlePosition(): [number, number] | undefined
+    titlePosition(pos: [number, number]): this
+
+    /** Position adjustment for map subtitle: [x, y] */
+    subtitlePosition(): [number, number] | undefined
+    subtitlePosition(pos: [number, number]): this
+
+    /** Position adjustment for footnote text: [x, y] */
+    footnotePosition(): [number, number] | undefined
+    footnotePosition(pos: [number, number]): this
+
+    /** Position adjustment for Eurostat logo: [x, y] */
+    logoPosition(): [number, number] | undefined
+    logoPosition(pos: [number, number]): this
+
+    /** Position adjustment for ribbon banner: [x, y] */
+    ribbonPosition(): [number, number] | undefined
+    ribbonPosition(pos: [number, number]): this
+
+    /** Position adjustment for zoom buttons: [x, y] */
+    zoomButtonsPosition(): [number, number] | undefined
+    zoomButtonsPosition(pos: [number, number]): this
+
+    /** Position adjustment for insets button: [x, y] */
+    insetsButtonPosition(): [number, number] | undefined
+    insetsButtonPosition(pos: [number, number]): this
+
+    /** Pointer hover color for NUTS regions. */
+    hoverColor(): string
+    hoverColor(color: string): this
+
+    /** Base fill color for regions with no statistical data. */
+    noDataFillStyle(): string
+    noDataFillStyle(style: string): this
+
+    /** Show the link to the remote Eurostat statistical dataset. */
+    showSourceLink(): boolean
+    showSourceLink(show: boolean): this
+
+    /** Pattern fill configurations. */
+    patternFill(): any
+    patternFill(config: any): this
+
     /** Dorling. */
 
     /** Enable Dorling cartogram layout for proportional symbol maps. */

package/build/types/index.d.ts

@@ -71,8 +71,10 @@ export type { MushroomLegendConfig } from './legend/MushroomLegendConfig'
 export type { PatternFillLegendConfig } from './legend/PatternFillLegendConfig'
 
 // Choropleth legend types
+export type { ChoroplethLegendConfig } from './legend/choropleth/ChoroplethLegendConfig'
 export type { BivariateLegendConfig } from './legend/choropleth/BivariateLegendConfig'
 export type { HistogramLegendConfig } from './legend/choropleth/HistogramLegendConfig'
+export type { TrivariateLegendConfig } from './legend/choropleth/TrivariateLegendConfig'
 
 // Composition legend types
 export type { BarChartLegendConfig } from './legend/composition/BarChartLegendConfig'
@@ -204,7 +206,7 @@ export function getFillPatternDefinitionFunction(opts?: FillPatternOptions): (sv
 /**
  * Get default labels for the map
  */
-export function getDefaultLabels(): { [key: string]: string }
+export function getDefaultLabels(): { [key: string]: any }
 
 /**
  * Project coordinates from map pixel space to geographic coordinates
@@ -238,8 +240,6 @@ declare const eurostatmap: {
     map: typeof map
     /** Get fill pattern definition function. */
     getFillPatternDefinitionFunction: typeof getFillPatternDefinitionFunction
-    /** Get fill pattern definition fun. */
-    getFillPatternDefinitionFun: typeof getFillPatternDefinitionFun
     /** Get default labels. */
     getDefaultLabels: typeof getDefaultLabels
     /** Project from map. */

package/build/types/legend/LegendConfig.d.ts

@@ -13,12 +13,18 @@ export interface LegendConfig {
 
     /** 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
+    /** Padding between the title block and legend body. */
+    titlePadding?: number
 
     /** Shape styling (for proportional symbol legends). */
     /** Symbol swatch width in pixels. */
@@ -27,25 +33,36 @@ export interface LegendConfig {
     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 offset applied to labels. */
-    labelOffset?: 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
-
-    /** Manual legend cell definitions. */
-    cells?: any[]
-
     /** 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
 
-    [key: string]: any
+    /** Whether to show dataset min/max labels when supported. */
+    maxMin?: boolean
+    /** Text affixes for min/max labels as [minSuffix, maxSuffix]. */
+    maxMinLabels?: [string, string]
 }

package/build/types/legend/choropleth/ChoroplethLegendConfig.d.ts

@@ -0,0 +1,80 @@
+import type { LegendConfig } from '../LegendConfig'
+import type { HistogramLegendConfig } from './HistogramLegendConfig'
+
+/**
+ * Configuration for choropleth map legends.
+ * Supports discrete, continuous, diverging, and histogram legend variants.
+ */
+export interface ChoroplethLegendConfig extends LegendConfig {
+    /** Padding between the legend title and the legend body in pixels. @default 5 */
+    titlePadding?: number
+
+    /** Label style for discrete legends. @default 'thresholds' */
+    labelType?: 'thresholds' | 'ranges'
+
+    /** Length of the separator line in pixels for discrete legends. @default shapeWidth */
+    sepLineLength?: number
+
+    /** Length of threshold tick marks in pixels. @default 4 */
+    tickLength?: number
+
+    /** Number of decimal places for auto-formatted labels. Auto-detected when undefined. */
+    decimals?: number
+
+    /** Offset adjustments for labels. @default { x: 3, y: 0 } */
+    labelOffsets?: { x: number; y: number }
+
+    /** Custom formatter for legend labels. */
+    labelFormatter?: ((value: number, classIndex?: number) => string) | null
+
+    /** User-defined labels for classes in discrete legends. */
+    labels?: string[] | null
+
+    /** Histogram legend configuration. Set to null/undefined to disable histogram mode. */
+    histogram?: Partial<HistogramLegendConfig> | null
+
+    /** Label shown at the divergence point for diverging legends. */
+    pointOfDivergenceLabel?: string
+
+    /** Class index/value position used for diverging legends. */
+    pointOfDivergence?: number
+
+    /** Extra padding around the divergence marker in pixels. @default 7 */
+    pointOfDivergencePadding?: number
+
+    /** Explicit diverging guide line length in pixels. */
+    divergingLineLength?: number
+
+    /** Explicit diverging arrow length in pixels. */
+    divergingArrowLength?: number
+
+    /** Label shown at the low end of continuous legends. @default 'Low' */
+    lowLabel?: string
+
+    /** Label shown at the high end of continuous legends. @default 'High' */
+    highLabel?: string
+
+    /** Number of ticks to show on continuous legends. Use 0 to disable. @default 0 */
+    ticks?: number
+
+    /** Explicit tick values for continuous legends. */
+    tickValues?: number[]
+
+    /** Explicit tick labels for continuous legends. */
+    tickLabels?: Array<string | number>
+
+    /** Pixel tolerance used when hovering continuous legends to highlight nearby regions. @default 10 */
+    highlightTolerance?: number
+
+    /** Whether to show dataset min/max labels where supported. @default true */
+    maxMin?: boolean
+
+    /** Text affixes for min/max labels as [minSuffix, maxSuffix]. @default ['', ''] */
+    maxMinLabels?: [string, string]
+
+    /** Length of min/max tick marks in pixels. Defaults to tickLength when omitted. */
+    maxMinTickLength?: number
+
+    /** Whether to append region names to min/max labels. */
+    maxMinRegionLabels?: boolean
+}

package/build/types/map-types/choropleth/BivariateChoroplethConfig.d.ts

@@ -1,9 +1,13 @@
 import type { MapConfig } from '../../core/MapConfig'
+import type { BivariateLegendConfig } from '../../legend/choropleth/BivariateLegendConfig'
 
 /**
  * Configuration for bivariate choropleth maps.
  */
 export interface BivariateChoroplethConfig extends MapConfig {
+    /** Bivariate choropleth legend configuration. */
+    legend?: BivariateLegendConfig | false
+
     /** Number of classes. */
     numberOfClasses?: number
     /** Breaks1. */

package/build/types/map-types/choropleth/ChoroplethConfig.d.ts

@@ -1,9 +1,13 @@
 import { MapConfig } from '../../core/MapConfig'
+import type { ChoroplethLegendConfig } from '../../legend/choropleth/ChoroplethLegendConfig'
 
 /**
  * Configuration specific to choropleth maps
  */
 export interface ChoroplethConfig extends MapConfig {
+    /** Choropleth legend configuration. */
+    legend?: ChoroplethLegendConfig | false
+
     /** Classification. */
     numberOfClasses?: number
     /** Classification method. */

package/build/types/map-types/choropleth/TrivariateChoroplethConfig.d.ts

@@ -1,9 +1,13 @@
 import type { MapConfig } from '../../core/MapConfig'
+import type { TrivariateLegendConfig } from '../../legend/choropleth/TrivariateLegendConfig'
 
 /**
  * Configuration for trivariate choropleth maps.
  */
 export interface TrivariateChoroplethConfig extends MapConfig {
+    /** Trivariate choropleth legend configuration. */
+    legend?: TrivariateLegendConfig | false
+
     /** Ternary codes. */
     ternaryCodes?: [string, string, string]
     /** No data fill style. */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "eurostat-map",
-    "version": "4.4.1",
+    "version": "4.4.2",
     "description": "Reusable library to quickly create and customise web maps showing Eurostat data directly retrieved from Eurostat database.",
     "keywords": [
         "eurostat",
@@ -39,9 +39,11 @@
         "build-prod-debug": "webpack --config webpack/webpack.config.debug-size.js",
         "format": "prettier --write .",
         "copy-types": "copyfiles -u 2 \"src/types/**/*.d.ts\" build/types",
-        "type-check": "tsc --noEmit && tsc --noEmit test/typescript-test.ts",
+        "check:types:legend-config-sync": "node test/scripts/check-legend-config-sync.js",
+        "type-check": "npm run check:types:legend-config-sync && tsc --noEmit && tsc --noEmit test/typescript-test.ts",
         "docs:api": "typedoc --options typedoc.json",
-        "docs": "npm run docs:api"
+        "docs": "npm run docs:api",
+        "generate-previews": "node examples/scripts/generate-previews.js"
     },
     "dependencies": {
         "d3-array": "^3.2.4",
@@ -75,6 +77,7 @@
         "babel-loader": "^9.1.2",
         "copyfiles": "^2.4.1",
         "css-loader": "^7.1.2",
+        "playwright": "^1.60.0",
         "prettier": "^3.4.1",
         "style-loader": "^4.0.0",
         "ts-loader": "^9.5.4",