eurostat-map 4.4.0 → 4.4.1

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

@@ -0,0 +1,29 @@
+/**
+ * Strength settings for Dorling force simulation.
+ */
+export interface DorlingStrength {
+    /** X-axis attraction strength. */
+    x: number
+    /** Y-axis attraction strength. */
+    y: number
+}
+
+/**
+ * Settings for Dorling cartogram simulation behavior.
+ */
+export interface DorlingSettings {
+    /** Animate simulation ticks in real time. */
+    animate: boolean
+    /** Gravity strength toward original centroids. */
+    strength: DorlingStrength
+    /** Collision force iterations per tick. */
+    iterations: number
+    /** Extra collision padding between symbols. */
+    padding: number
+    /** Progress callback used by worker-based simulation. */
+    onProgress?: (progress: number, map: any) => void
+    /** Run non-animated simulation in a Web Worker. */
+    worker: boolean
+    /** URL of the D3 bundle used by Dorling worker mode. */
+    workerD3URL?: string
+}

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

@@ -0,0 +1,30 @@
+/**
+ * Margins used to place and center grid cartograms.
+ */
+export interface GridCartogramMargins {
+    /** Top margin in pixels. */
+    top: number
+    /** Right margin in pixels. */
+    right: number
+    /** Bottom margin in pixels. */
+    bottom: number
+    /** Left margin in pixels. */
+    left: number
+}
+
+/**
+ * Settings for grid cartogram layout and geometry.
+ */
+export interface GridCartogramSettings {
+    /** Grid cell shape. */
+    shape: 'square' | 'hexagon'
+    /** Margins around the grid drawing area. */
+    margins: GridCartogramMargins
+    /** Extra spacing between grid cells in pixels. */
+    cellPadding: number
+    /**
+     * Custom grid layout CSV string.
+     * If undefined, the built-in layout for the selected shape is used.
+     */
+    positions?: string
+}

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

@@ -2,13 +2,21 @@
  * Configuration for map insets (smaller additional maps)
  */
 export interface InsetConfig {
-    geo?: string // Geographic code (e.g., 'MT', 'PT20', 'CARIB')
+    /** 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

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

@@ -3,83 +3,93 @@ import type { LegendConfig } from '../legend/LegendConfig'
 import type { TooltipConfig } from './TooltipConfig'
 import type { InsetConfig } from './InsetConfig'
 import type { MapInstance as EurostatMap } from './MapInstance'
+import type { CoastalMarginSettings } from './decoration/CoastalMarginSettings'
+import type { GridCartogramSettings } from './GridCartogramSettings'
+import type { DorlingSettings } from './DorlingSettings'
 
 /**
  * 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.
  */
 export interface MapConfig {
-    // Container settings
+    /** Container settings. */
     svgId?: string
+    /** ID of the container element used to host the map. */
     containerId?: string
 
-    // Geographic settings
-    proj?: string // NUTS2json geometries projection: '3035', '3857', '4326'. For custom projections use 4326, then set the desired projection with projectionFunction()
-    projectionFunction?: () => any // Function to set a custom projection. See d3-geo projections for examples.
-    scale?: '60M' | '20M' | '10M' | '03M' | '01M' // Scale of the map, for NUTSjson geometries
-    nutsLevel?: number // 0, 1, 2, 3
+    /** Geographic settings. */
+    /**
+     * NUTS2json geometries projection: '3035', '3857', '4326'.
+     * For custom projections, use 4326 and then set projectionFunction().
+     */
+    proj?: string
+    /** Function to set a custom projection. See d3-geo projections for examples. */
+    projectionFunction?: () => any
+    /** Scale of the map, for NUTSjson geometries. */
+    scale?: '60M' | '20M' | '10M' | '03M' | '01M'
+    /** NUTS level (0, 1, 2, 3). */
+    nutsLevel?: number
+    /** NUTS boundary year. */
     nutsYear?: number | string
+    /** Geographic center as [longitude, latitude]. */
     geoCenter?: [number, number]
-    pixSize?: number
 
-    // Geometry settings
-    geo?: string // NUTS2JSON Geographic focus (e.g., 'EUR', 'WORLD', 'IC', 'GF') see https://github.com/eurostat/Nuts2json#overseas-territories---map-insets
+    /** Geometry settings. */
+    /**
+     * NUTS2JSON geographic focus (e.g., 'EUR', 'WORLD', 'IC', 'GF').
+     * See https://github.com/eurostat/Nuts2json#overseas-territories---map-insets
+     */
+    geo?: string
 
-    // Map dimensions
+    /** Map dimensions. */
     width?: number
+    /** Map height in pixels. */
     height?: number
 
-    // map texts
+    /** Map texts. */
+    /** Map title. */
     title?: string
+    /** Map subtitle. */
     subtitle?: string
-    bottomText?: string
-    botTxtFontSize?: number
-    botTxtPadding?: number
-    botTxtTooltipMessage?: string
+    /** Footnote text shown below the map. */
     footnote?: string
+    /** Data source text. */
     source?: string
 
-    // Statistical data configuration
+    /** Statistical data configuration. */
     stat?: StatConfig
 
-    // Legend configuration
+    /** Legend configuration. */
     legend?: LegendConfig
 
-    // Tooltip configuration
+    /** Tooltip configuration. */
     tooltip?: TooltipConfig
 
-    // Insets (small additional maps)
+    /** Insets (small additional maps). */
     insets?: InsetConfig[]
 
-    // Zoom and pan settings
+    /** Zoom and pan settings. */
     zoomExtent?: [number, number]
 
-    // UI Controls
-    showBtns?: boolean // Show zoom buttons
+    /** Grid cartogram layout settings. */
+    gridCartogramSettings?: Partial<GridCartogramSettings>
 
-    // Coastal margin
-    coastal?: boolean
-    coastalMarginWidth?: number
-    coastalMarginColor?: string
+    /** Dorling simulation settings. */
+    dorlingSettings?: Partial<DorlingSettings>
 
-    // Graticule
-    drawGraticule?: boolean
-    graticuleStyle?: any
+    /** Show or hide the coastal margin effect. */
+    drawCoastalMargin?: boolean
+    /** Coastal margin settings to override defaults. */
+    coastalMarginSettings?: Partial<CoastalMarginSettings>
 
-    // Borders
-    borderWidth?: number
-    borderColor?: string
+    /** Graticule. */
+    drawGraticule?: boolean
 
-    // Labels
+    /** Labels. */
     labelling?: boolean
-    labelSizeThreshold?: number
-    labelOpacity?: number
-
-    // Logo
-    logoURL?: string
 
-    // Callbacks
+    /** Fires once the map is built. */
     onBuild?: (map: EurostatMap) => void
 
-    // Allow additional properties for extensibility
+    /** Allow additional properties for extensibility. */
     [key: string]: any
 }

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

@@ -3,6 +3,9 @@ import type { StatData } from './stat/StatData'
 import type { LegendConfig } from '../legend/LegendConfig'
 import type { TooltipConfig } from './TooltipConfig'
 import type { InsetConfig } from './InsetConfig'
+import type { CoastalMarginSettings } from './decoration/CoastalMarginSettings'
+import type { GridCartogramSettings } from './GridCartogramSettings'
+import type { DorlingSettings } from './DorlingSettings'
 
 /**
  * A eurostat-map instance. Created by eurostatmap.map() and extended
@@ -11,7 +14,7 @@ import type { InsetConfig } from './InsetConfig'
  * return the instance for chaining.
  */
 export interface MapInstance {
-    // ==================== Container ====================
+    /** Container. */
 
     /** ID of the target SVG element. @default 'map' */
     svgId(): string
@@ -21,7 +24,7 @@ export interface MapInstance {
     containerId(): string
     containerId(id: string): this
 
-    // ==================== Dimensions ====================
+    /** Dimensions. */
 
     /** Map width in pixels. @default min(795, window.innerWidth) */
     width(): number
@@ -31,7 +34,7 @@ export interface MapInstance {
     height(): number
     height(h: number): this
 
-    // ==================== Geography ====================
+    /** Geography. */
 
     /**
      * NUTS2JSON geographic focus area.
@@ -78,7 +81,7 @@ export interface MapInstance {
     projectionFunction(): any
     projectionFunction(fn: any): this
 
-    // ==================== Text & Labels ====================
+    /** Text and labels. */
 
     /** Map title. */
     title(): string
@@ -103,7 +106,7 @@ export interface MapInstance {
     footnoteWrap(): number | false
     footnoteWrap(chars: number | false): this
 
-    // ==================== Statistical Data ====================
+    /** Statistical data. */
 
     /**
      * Get or set statistical data configuration.
@@ -142,7 +145,7 @@ export interface MapInstance {
     language(): string
     language(lang: string): this
 
-    // ==================== Legend ====================
+    /** Legend. */
 
     /**
      * Get or set legend configuration. Pass false to remove the legend.
@@ -154,13 +157,13 @@ export interface MapInstance {
     /** Force-update the legend after data or style changes. */
     updateLegend(): this
 
-    // ==================== Tooltip ====================
+    /** Tooltip. */
 
     /** Get or set tooltip configuration. */
     tooltip(): TooltipConfig
     tooltip(config: TooltipConfig): this
 
-    // ==================== Zoom & Pan ====================
+    /** Zoom and pan. */
 
     /**
      * D3 zoom scale extent [min, max].
@@ -173,7 +176,11 @@ export interface MapInstance {
     zoomButtons(): boolean
     zoomButtons(show: boolean): this
 
-    // ==================== Insets ====================
+    /** Grid cartogram settings (shape, margins, cell padding, layout positions). */
+    gridCartogramSettings(): GridCartogramSettings
+    gridCartogramSettings(settings: Partial<GridCartogramSettings>): this
+
+    /** Insets. */
 
     /**
      * Inset map configurations. Pass 'default' for the standard
@@ -184,7 +191,7 @@ export interface MapInstance {
     insets(): InsetConfig[] | 'default' | false
     insets(config: InsetConfig[] | 'default' | false): this
 
-    // ==================== Decoration ====================
+    /** Decoration. */
 
     /** Show/hide the graticule (coordinate grid lines). */
     drawGraticule(): boolean
@@ -195,8 +202,8 @@ export interface MapInstance {
     drawCoastalMargin(show: boolean): this
 
     /** Coastal margin appearance settings. */
-    coastalMarginSettings(): object
-    coastalMarginSettings(settings: object): this
+    coastalMarginSettings(): CoastalMarginSettings
+    coastalMarginSettings(settings: Partial<CoastalMarginSettings>): this
 
     /** Show/hide placename labels loaded from the placenames layer. */
     placenames(): boolean
@@ -230,29 +237,17 @@ export interface MapInstance {
     showEstatRibbon(): boolean
     showEstatRibbon(show: boolean): this
 
-    // ==================== Dorling ====================
+    /** Dorling. */
 
     /** Enable Dorling cartogram layout for proportional symbol maps. */
     dorling(): boolean
     dorling(enable: boolean): this
 
-    /** Animate the Dorling simulation. @default true */
-    animateDorling(): boolean
-    animateDorling(animate: boolean): this
-
-    /** Dorling simulation gravity strength. @default { x: 1, y: 1 } */
-    dorlingStrength(): { x: number; y: number }
-    dorlingStrength(strength: { x: number; y: number }): this
-
-    /** Number of Dorling collision detection iterations. @default 1 */
-    dorlingIterations(): number
-    dorlingIterations(n: number): this
-
-    /** Minimum distance between Dorling circles. Negative allows overlap. @default 0 */
-    dorlingPadding(): number
-    dorlingPadding(padding: number): this
+    /** Dorling simulation settings. */
+    dorlingSettings(): DorlingSettings
+    dorlingSettings(settings: Partial<DorlingSettings>): this
 
-    // ==================== Events ====================
+    /** Events. */
 
     /** Called when the user finishes a zoom gesture. */
     onZoomEnd(): ((event: any) => void) | undefined
@@ -286,7 +281,7 @@ export interface MapInstance {
     onBuild(): ((map: MapInstance) => void) | undefined
     onBuild(callback: (map: MapInstance) => void): this
 
-    // ==================== Build & Update ====================
+    /** Build and update. */
 
     /**
      * Builds the map from scratch. Call once after initial configuration.
@@ -315,7 +310,7 @@ export interface MapInstance {
     /** Recalculates header/footer layout and resizes the SVG. */
     recalculateLayout(): void
 
-    // ==================== Export ====================
+    /** Export. */
 
     /**
      * Exports the map as an SVG file and triggers a browser download.
@@ -330,7 +325,7 @@ export interface MapInstance {
      */
     exportMapToPNG(width?: number, height?: number): Promise<this>
 
-    // ==================== Misc ====================
+    /** Misc. */
 
     /**
      * Sets map attributes from URL parameters.

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

@@ -5,8 +5,11 @@ import type { MapInstance as EurostatMap } from './MapInstance'
  */
 export interface TooltipConfig {
     textFunction?: (region: any, map: EurostatMap) => string
+    /** Omit regions. */
     omitRegions?: string[]
+    /** Max width. */
     maxWidth?: number
+    /** Font size. */
     fontSize?: number
 
     [key: string]: any

package/build/types/core/decoration/CoastalMarginSettings.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Visual settings for the coastal margin effect.
+ */
+export interface CoastalMarginSettings {
+    /** Gaussian blur standard deviation. */
+    standardDeviation: number
+    /** Filter x bound (SVG filter coordinate space). */
+    x: string
+    /** Filter y bound (SVG filter coordinate space). */
+    y: string
+    /** Filter width (SVG filter coordinate space). */
+    width: string
+    /** Filter height (SVG filter coordinate space). */
+    height: string
+    /** Coastal stroke width. */
+    strokeWidth: number
+    /** Coastal stroke color. */
+    color: string
+    /** Coastal stroke opacity. */
+    opacity: number
+}

package/build/types/core/geo/geometries.d.ts

@@ -13,12 +13,19 @@ export interface GeometriesClass {
     centroidsData: any
     /** Processed GeoJSON features organized by type */
     geoJSONs: {
+        /** Nutsrg. */
         nutsrg?: any[]
+        /** Nutsbn. */
         nutsbn?: any[]
+        /** Cntrg. */
         cntrg?: any[]
+        /** Cntbn. */
         cntbn?: any[]
+        /** Worldrg. */
         worldrg?: any[]
+        /** Graticule. */
         graticule?: any[]
+        /** Mixed. */
         mixed?: any
     }
     /** User-provided custom geometries */
@@ -34,13 +41,21 @@ export interface GeometriesClass {
     setUserGeometries(geometries: any[]): void
     /** Adds default NUTS geometries to the map */
     addDefaultGeometriesToMap(
+        /** Zoom group. */
         zoomGroup: any,
+        /** Draw graticule. */
         drawGraticule: boolean,
+        /** Path function. */
         pathFunction: any,
+        /** Nuts level. */
         nutsLevel: number | string,
+        /** Nuts year. */
         nutsYear: number,
+        /** Geo. */
         geo: string,
+        /** Proj. */
         proj: string,
+        /** Scale. */
         scale: string
     ): void
     /** Adds user-defined geometries to the map */

package/build/types/core/geo/kosovo.d.ts

@@ -4,7 +4,9 @@
  */
 export const kosovoBnFeatures: {
     [year: number]: {
+        /** Type. */
         type: 'FeatureCollection'
+        /** Features. */
         features: any[]
     }
 }

package/build/types/core/stat/StatData.d.ts

@@ -83,11 +83,17 @@ export interface StatData {
 
     /** Metadata from the Eurostat API response or CSV source. */
     metadata?: {
+        /** Label. */
         label?: string
+        /** Href. */
         href?: string
+        /** Source. */
         source?: string
+        /** Updated. */
         updated?: string
+        /** Time. */
         time?: string
+        /** Extension. */
         extension?: any
     }
 

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

@@ -101,10 +101,14 @@ export const flags: Record<string, string>
  * Executes a function for all insets recursively.
  */
 export function executeForAllInsets(
+    /** Insets. */
     insets: any,
+    /** Main svg id. */
     mainSvgId: string,
     functionToExecute: (inset: MapInstance, ...args: any[]) => void,
+    /** Parameter. */
     parameter?: any,
+    /** Parameter2. */
     parameter2?: any
 ): void
 

package/build/types/index.d.ts

@@ -59,17 +59,15 @@ export type { TooltipConfig } from './core/TooltipConfig'
 export type { LegendConfig } from './legend/LegendConfig'
 export type { StatConfig } from './core/stat/StatConfig'
 export type { InsetConfig } from './core/InsetConfig'
+export type { CoastalMarginSettings } from './core/decoration/CoastalMarginSettings'
+export type { GridCartogramSettings, GridCartogramMargins } from './core/GridCartogramSettings'
+export type { DorlingSettings, DorlingStrength } from './core/DorlingSettings'
 
 // ==================== Legend Configuration Type Exports ====================
 
 // Main legend types
 export type { CategoricalLegendConfig } from './legend/CategoricalLegendConfig'
-export type { CoxcombLegendConfig } from './legend/CoxcombLegendConfig'
 export type { MushroomLegendConfig } from './legend/MushroomLegendConfig'
-export type { PieChartLegendConfig } from './legend/PieChartLegendConfig'
-export type { SparklineLegendConfig } from './legend/SparklineLegendConfig'
-export type { WaffleLegendConfig } from './legend/WaffleLegendConfig'
-export type { StripeCompositionLegendConfig } from './legend/StripeCompositionLegendConfig'
 export type { PatternFillLegendConfig } from './legend/PatternFillLegendConfig'
 
 // Choropleth legend types
@@ -78,6 +76,16 @@ export type { HistogramLegendConfig } from './legend/choropleth/HistogramLegendC
 
 // Composition legend types
 export type { BarChartLegendConfig } from './legend/composition/BarChartLegendConfig'
+export type { CoxcombLegendConfig } from './legend/composition/CoxcombLegendConfig'
+export type { PieChartLegendConfig } from './legend/composition/PieChartLegendConfig'
+export type { WaffleLegendConfig } from './legend/composition/WaffleLegendConfig'
+export type { StripeCompositionLegendConfig } from './legend/composition/StripeCompositionLegendConfig'
+export type {
+    SparklineLegendConfig,
+    SparklineScaleLegendConfig,
+    SparklineColorLegendConfig,
+    SparklineNoDataLegendConfig,
+} from './legend/composition/SparklineLegendConfig'
 
 // Flow legend types
 export type { FlowMapLegendConfig } from './legend/flow/FlowMapLegendConfig'
@@ -133,11 +141,17 @@ export type { FlowMapConfig, FlowMap }
  * Options for fill pattern definitions
  */
 export interface FillPatternOptions {
+    /** Shape. */
     shape?: 'circle' | 'square'
+    /** Pattern size. */
     patternSize?: number
+    /** Min size. */
     minSize?: number
+    /** Max size. */
     maxSize?: number
+    /** Bck color. */
     bckColor?: string
+    /** Symb color. */
     symbColor?: string
 }
 
@@ -187,11 +201,6 @@ export function map(type: MapType, config?: MapConfig): MapInstance
  */
 export function getFillPatternDefinitionFunction(opts?: FillPatternOptions): (svg: any, numberOfClasses: number) => void
 
-/**
- * @deprecated Use getFillPatternDefinitionFunction instead
- */
-export function getFillPatternDefinitionFun(opts?: FillPatternOptions): (svg: any, numberOfClasses: number) => void
-
 /**
  * Get default labels for the map
  */
@@ -225,12 +234,19 @@ export const version: string
 // ==================== Default Export ====================
 
 declare const eurostatmap: {
+    /** Map. */
     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. */
     projectFromMap: typeof projectFromMap
+    /** Project to map. */
     projectToMap: typeof projectToMap
+    /** Version. */
     version: typeof version
 }
 

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

@@ -2,41 +2,49 @@
  * 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
+    /** Legend width in pixels. */
     width?: number
+    /** Legend height in pixels. */
     height?: number
 
+    /** Legend title text. */
     title?: string
-    titleWidth?: number
+    /** Legend title font size in pixels. */
     titleFontSize?: number
 
-    // Box styling
-    boxWidth?: number
-    boxHeight?: number
+    /** Box styling. */
+    /** Inner spacing around legend content. */
     boxPadding?: number
-    boxCornerRadius?: number
 
-    // Shape styling (for proportional symbol legends)
+    /** 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
 
-    // Label styling
+    /** Label styling. */
+    /** Label font size in pixels. */
     labelFontSize?: number
+    /** Pixel offset applied to labels. */
     labelOffset?: number
-    labelWrap?: number
-    labelDecimalPlaces?: number
 
-    // Orientation
+    /** Legend layout direction. */
     orientation?: 'vertical' | 'horizontal'
+    /** Sort legend entries in ascending order when true. */
     ascending?: boolean
 
-    // Cells (for manual legend specification)
+    /** Manual legend cell definitions. */
     cells?: any[]
 
-    // No data label
+    /** Whether to display the no-data legend item. */
     noData?: boolean
+    /** Label used for no-data legend item. */
     noDataText?: string
 
     [key: string]: any