eurostat-map 4.3.58 → 4.4.1

package/build/types/map-types/flow/FlowMapConfig.d.ts

@@ -0,0 +1,158 @@
+import type { MapConfig } from '../../core/MapConfig'
+
+/**
+ * A flow node in the flow graph.
+ */
+export interface FlowNode {
+    /** Id. */
+    id: string
+    /** Name. */
+    name?: string
+    /** X. */
+    x?: number
+    /** Y. */
+    y?: number
+    /** Value. */
+    value?: number
+    [key: string]: any
+}
+
+/**
+ * A flow link between two nodes.
+ */
+export interface FlowLink {
+    /** Source. */
+    source: string | FlowNode
+    /** Target. */
+    target: string | FlowNode
+    /** Value. */
+    value: number
+    /** Origin id. */
+    originId?: string
+    /** Dest id. */
+    destId?: string
+    [key: string]: any
+}
+
+/**
+ * Graph input used by flow maps.
+ */
+export interface FlowGraph {
+    /** Nodes. */
+    nodes: FlowNode[]
+    /** Links. */
+    links: FlowLink[]
+}
+
+/**
+ * Curvature settings used for curved/sankey flow rendering.
+ */
+export interface FlowCurvatureSettings {
+    /** Gap x. */
+    gapX?: number
+    /** Pad x. */
+    padX?: number
+    /** Pad y. */
+    padY?: number
+    /** Bump y. */
+    bumpY?: number
+    /** Curvature. */
+    curvature?: number
+}
+
+/**
+ * Width gradient settings for tapered flows.
+ */
+export interface FlowWidthGradientSettings {
+    /** Start ratio. */
+    startRatio?: number
+    /** Samples. */
+    samples?: number
+    /** Min start width. */
+    minStartWidth?: number
+    /** Cap end. */
+    capEnd?: boolean
+    /** Curvature follow. */
+    curvatureFollow?: boolean
+}
+
+/**
+ * Force settings for optional edge bundling.
+ */
+export interface FlowBundleSettings {
+    /** Alpha decay. */
+    alphaDecay?: number
+    /** Charge strength. */
+    chargeStrength?: number
+    /** Distance max. */
+    distanceMax?: number | null
+    /** Link strength. */
+    linkStrength?: number
+    /** Link iterations. */
+    linkIterations?: number
+}
+
+/**
+ * Configuration for flow maps.
+ */
+export interface FlowMapConfig extends MapConfig {
+    /** Flow graph. */
+    flowGraph?: FlowGraph
+
+    /** Flow color. */
+    flowColor?: string
+    /** Flow region colors. */
+    flowRegionColors?: string[]
+    /** Flow region labels. */
+    flowRegionLabels?: string[]
+    /** Flow arrows. */
+    flowArrows?: boolean
+    /** Flow arrow scale. */
+    flowArrowScale?: number
+    /** Flow max width. */
+    flowMaxWidth?: number
+    /** Flow min width. */
+    flowMinWidth?: number
+    /** Flow outlines. */
+    flowOutlines?: boolean
+    /** Flow outline width. */
+    flowOutlineWidth?: number
+    /** Flow outline color. */
+    flowOutlineColor?: string
+    /** Flow color gradient. */
+    flowColorGradient?: boolean
+    /** Flow stack. */
+    flowStack?: boolean
+    /** Flow nodes. */
+    flowNodes?: boolean
+    /** Flow node type. */
+    flowNodeType?: 'circle' | 'donut'
+    /** Flow label offsets. */
+    flowLabelOffsets?: { x?: number; y?: number }
+    /** Flow line type. */
+    flowLineType?: 'curved' | 'straight' | 'sankey'
+    flowNodeSizeScale?: (value: number) => number
+    /** Flow opacity. */
+    flowOpacity?: number
+    /** Flow internal. */
+    flowInternal?: boolean
+    /** Flow top locations. */
+    flowTopLocations?: number
+    /** Flow top locations type. */
+    flowTopLocationsType?: 'sum' | 'origin' | 'destination'
+    /** Flow curvature settings. */
+    flowCurvatureSettings?: FlowCurvatureSettings
+    flowOrder?: (a: any, b: any) => number
+    /** Flow width gradient. */
+    flowWidthGradient?: boolean
+    /** Flow opacity gradient. */
+    flowOpacityGradient?: boolean
+    /** Flow width gradient settings. */
+    flowWidthGradientSettings?: FlowWidthGradientSettings
+    /** Flow bidirectional. */
+    flowBidirectional?: boolean
+    /** Flow edge bundling. */
+    flowEdgeBundling?: boolean
+    /** Flow bundle settings. */
+    flowBundleSettings?: FlowBundleSettings
+}

package/build/types/map-types/flow/map-flow.d.ts

@@ -0,0 +1,5 @@
+import type { MapInstance } from '../../core/MapInstance'
+import type { FlowMapConfig } from './FlowMapConfig'
+
+/** Creates a flow map instance */
+export function map(config?: FlowMapConfig): MapInstance

package/build/types/map-types/map-categorical.d.ts

@@ -0,0 +1,19 @@
+import type { MapInstance } from '../core/MapInstance'
+
+/**
+ * Configuration for categorical map
+ */
+export interface CategoricalMapConfig {
+    /** Category-to-color mapping */
+    classToFillStyle?: Record<string, string>
+    /** Fill style for regions with no data */
+    noDataFillStyle?: string
+}
+
+/**
+ * Creates a categorical (qualitative) map instance.
+ * Used for displaying qualitative data with distinct categories.
+ * @param config - Map configuration
+ * @returns Map instance with categorical-specific methods
+ */
+export function map(config?: CategoricalMapConfig): MapInstance

package/build/types/map-types/proportional-symbol/ProportionalSymbolConfig.d.ts

@@ -0,0 +1,17 @@
+import type { MapConfig } from '../../core/MapConfig'
+
+/**
+ * Configuration for proportional symbol maps
+ */
+export interface ProportionalSymbolConfig extends MapConfig {
+    /** Symbol shape used for markers. */
+    symbol?: 'circle' | 'square'
+    /** Base symbol size factor. */
+    size?: number
+
+    /** Dorling cartogram. */
+    dorling?: boolean
+
+    /** Size function. */
+    psCustomSize?: (value: number) => number
+}

package/build/types/map-types/proportional-symbol/ProportionalSymbolMap.d.ts

@@ -0,0 +1,90 @@
+import { MapInstance } from '../../core/MapInstance'
+
+/**
+ * Proportional symbol map object
+ */
+export interface ProportionalSymbolMap extends MapInstance {
+    psMaxSize(): number
+    psMaxSize(v: number): this
+
+    psMinSize(): number
+    psMinSize(v: number): this
+
+    psMaxValue(): number | undefined
+    psMaxValue(v: number | undefined): this
+
+    psMinValue(): number | undefined
+    psMinValue(v: number | undefined): this
+
+    psFill(): string
+    psFill(v: string): this
+
+    psFillOpacity(): number
+    psFillOpacity(v: number): this
+
+    psStrokeOpacity(): number
+    psStrokeOpacity(v: number): this
+
+    psStroke(): string
+    psStroke(v: string): this
+
+    psStrokeWidth(): number
+    psStrokeWidth(v: number): this
+
+    classifierSize(): any
+    classifierSize(v: any): this
+
+    classifierColor(): any
+    classifierColor(v: any): this
+
+    psShape(): string
+    psShape(v: string): this
+
+    psCustomShape(): any
+    psCustomShape(v: any): this
+
+    psBarWidth(): number
+    psBarWidth(v: number): this
+
+    psClassToFillStyle(): any
+    psClassToFillStyle(v: any): this
+
+    psColorFun(): any
+    psColorFun(v: any): this
+
+    psSizeScale(): any
+    psSizeScale(v: any): this
+
+    noDataFillStyle(): string
+    noDataFillStyle(v: string): this
+
+    psThresholds(): number[]
+    psThresholds(v: number[]): this
+
+    psColors(): string[] | null
+    psColors(v: string[] | null): this
+
+    psCustomSVG(): any
+    psCustomSVG(v: any): this
+
+    psOffset(): { x: number; y: number }
+    psOffset(v: { x: number; y: number }): this
+
+    psClassificationMethod(): string
+    psClassificationMethod(v: string): this
+
+    psClasses(): number
+    psClasses(v: number): this
+
+    dorling(): boolean
+    dorling(v: boolean): this
+
+    psSpikeWidth(): number
+    psSpikeWidth(v: number): this
+
+    psCodeLabels(): boolean
+    psCodeLabels(v: boolean): this
+
+    psBrightenFactor(): number
+    psBrightenFactor(v: number): this
+}

package/build/types/map-types/proportional-symbol/map-proportional-symbols.d.ts

@@ -0,0 +1,35 @@
+import type { MapInstance } from '../../core/MapInstance'
+
+/**
+ * Configuration for proportional symbol map
+ */
+export interface ProportionalSymbolMapConfig {
+    /** Proportional symbol type: 'circle', 'square', 'spike', etc. */
+    symbolType?: string
+    /** Size attribute: 'radius', 'area', etc. */
+    sizeAttribute?: string
+    /** Maximum symbol size in pixels */
+    symbolMaxSize?: number
+    /** Minimum symbol size in pixels */
+    symbolMinSize?: number
+    /** Size dataset code */
+    sizeDatasetCode?: string
+    /** Symbol fill color */
+    symbolFillStyle?: string
+    /** Symbol fill opacity */
+    symbolFillOpacity?: number
+    /** Symbol stroke color */
+    symbolStrokeStyle?: string
+    /** Symbol stroke width */
+    symbolStrokeWidth?: number
+    /** Center symbol on region centroid */
+    centerOnCentroid?: boolean
+}
+
+/**
+ * Creates a proportional symbol map instance.
+ * Displays symbols (circles, squares, etc.) sized by statistical values.
+ * @param config - Map configuration
+ * @returns Map instance with proportional symbol methods
+ */
+export function map(config?: ProportionalSymbolMapConfig): MapInstance

package/build/types/map-types/proportional-symbol/mushroom/MushroomMap.d.ts

@@ -0,0 +1,30 @@
+import type { MapInstance } from '../../../core/MapInstance'
+
+/**
+ * Mushroom map type.
+ */
+export interface MushroomMap extends MapInstance {
+    mushroomCodes(): [string, string]
+    mushroomCodes(v: [string, string]): this
+
+    mushroomMinSize(): number
+    mushroomMinSize(v: number): this
+
+    mushroomMaxSize(): number
+    mushroomMaxSize(v: number): this
+
+    mushroomColors(): [string, string]
+    mushroomColors(v: [string, string]): this
+
+    mushroomOrientation(): 'horizontal' | 'vertical'
+    mushroomOrientation(v: 'horizontal' | 'vertical'): this
+
+    mushroomSizeScaleFunction(): any
+    mushroomSizeScaleFunction(v: any): this
+
+    mushroomSizeScaleFunctionV1(): any
+    mushroomSizeScaleFunctionV1(v: any): this
+
+    mushroomSizeScaleFunctionV2(): any
+    mushroomSizeScaleFunctionV2(v: any): this
+}

package/build/types/map-types/proportional-symbol/mushroom/MushroomMapConfig.d.ts

@@ -0,0 +1,20 @@
+import type { MapConfig } from '../../../core/MapConfig'
+
+/**
+ * Configuration for mushroom maps.
+ */
+export interface MushroomMapConfig extends MapConfig {
+    /** Mushroom codes. */
+    mushroomCodes?: [string, string]
+    /** Mushroom min size. */
+    mushroomMinSize?: number
+    /** Mushroom max size. */
+    mushroomMaxSize?: number
+    /** Mushroom colors. */
+    mushroomColors?: [string, string]
+    /** Mushroom orientation. */
+    mushroomOrientation?: 'horizontal' | 'vertical'
+    mushroomSizeScaleFunction?: (value: number) => number
+    mushroomSizeScaleFunctionV1?: (value: number) => number
+    mushroomSizeScaleFunctionV2?: (value: number) => number
+}

package/build/types/map-types/spark/SparkMap.d.ts

@@ -0,0 +1,52 @@
+import type { MapInstance } from '../../core/MapInstance'
+import type { SparkStatConfig } from './SparkStatConfig'
+import type { SparklineLegendConfig } from '../../legend/composition/SparklineLegendConfig'
+
+/**
+ * Spark map type.
+ */
+export interface SparkMap extends MapInstance {
+    legend(): SparklineLegendConfig
+    legend(config: SparklineLegendConfig | false): this
+
+    sparkLineColor(): any
+    sparkLineColor(v: any): this
+
+    showOnlyWhenComplete(): boolean
+    showOnlyWhenComplete(v: boolean): this
+
+    sparkType(): 'line' | 'area' | 'bar'
+    sparkType(v: 'line' | 'area' | 'bar'): this
+
+    sparkLineWidth(): number
+    sparkLineWidth(v: number): this
+
+    sparkLineHeight(): number
+    sparkLineHeight(v: number): this
+
+    sparkLineStrokeWidth(): number
+    sparkLineStrokeWidth(v: number): this
+
+    sparkLineOpacity(): number
+    sparkLineOpacity(v: number): this
+
+    sparkLineCircleRadius(): number
+    sparkLineCircleRadius(v: number): this
+
+    sparkLineAreaColor(): any
+    sparkLineAreaColor(v: any): this
+
+    sparkTooltipChart(): any
+    sparkTooltipChart(v: any): this
+
+    sparkLineChartFunction(): any
+    sparkLineChartFunction(v: any): this
+
+    sparkLineOffsets(): { x: number; y: number }
+    sparkLineOffsets(v: { x: number; y: number }): this
+
+    /** Manually set sparkline data instead of fetching it from Eurostat. */
+    sparklineData(dataObject: Record<string, Record<string, number>>): this
+    /** Configure fetching data from Eurostat and generating spark lines. */
+    statSpark(config: SparkStatConfig): this
+}

package/build/types/map-types/spark/SparkMapConfig.d.ts

@@ -0,0 +1,42 @@
+import type { MapConfig } from '../../core/MapConfig'
+import type { SparklineLegendConfig } from '../../legend/composition/SparklineLegendConfig'
+
+/**
+ * Configuration for sparkline maps.
+ */
+export interface SparkMapConfig extends MapConfig {
+    /** Spark type. */
+    sparkType?: 'line' | 'area' | 'bar'
+    sparkLineColor?: string | ((value: number, index: number, data: any[]) => string)
+    sparkAreaColor?: string | ((value: number, index: number, data: any[]) => string)
+    /** Spark line width. */
+    sparkLineWidth?: number
+    /** Spark line height. */
+    sparkLineHeight?: number
+    /** Spark line stroke width. */
+    sparkLineStrokeWidth?: number
+    /** Spark line opacity. */
+    sparkLineOpacity?: number
+    /** Spark line circle radius. */
+    sparkLineCircleRadius?: number
+    /** Spark tooltip chart. */
+    sparkTooltipChart?: {
+        /** Width. */
+        width: number
+        /** Height. */
+        height: number
+        /** Margin. */
+        margin: { left: number; right: number; top: number; bottom: number }
+        /** Circle radius. */
+        circleRadius: number
+    }
+    /** Spark line offsets. */
+    sparkLineOffsets?: { x: number; y: number }
+    /** Show only when complete. */
+    showOnlyWhenComplete?: boolean
+    sparkLineChartFunction?: (node: any, data: any[], width: number, height: number, isForTooltip?: boolean) => void
+    /** Spark yscale. */
+    sparkYScale?: any
+    /** Legend. */
+    legend?: SparklineLegendConfig | false
+}

package/build/types/map-types/spark/SparkStatConfig.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Statistical configuration for sparkline maps.
+ */
+export interface SparkStatConfig {
+    /** Eurostat dataset code. */
+    eurostatDatasetCode: string
+    /** Filters. */
+    filters?: Record<string, any>
+    /** Unit text. */
+    unitText?: string
+    transform?: (value: number) => number
+    /** Dates. */
+    dates: string[]
+    /** Labels. */
+    labels?: string[]
+}

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

@@ -0,0 +1,17 @@
+/**
+ * Options for SVG fill pattern definitions used in map legends.
+ */
+export interface FillPatternOptions {
+    /** Shape of the pattern symbol. @default 'circle' */
+    shape?: 'circle' | 'square'
+    /** Size of the repeating pattern tile in pixels. @default 5 */
+    patternSize?: number
+    /** Minimum symbol size in pixels (used for the lowest class). @default 1 */
+    minSize?: number
+    /** Maximum symbol size in pixels (used for the highest class). @default 5.5 */
+    maxSize?: number
+    /** Background fill colour of the pattern tile. @default 'white' */
+    bckColor?: string
+    /** Fill colour of the pattern symbol. @default 'black' */
+    symbColor?: string
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "eurostat-map",
-    "version": "4.3.58",
+    "version": "4.4.1",
     "description": "Reusable library to quickly create and customise web maps showing Eurostat data directly retrieved from Eurostat database.",
     "keywords": [
         "eurostat",
@@ -27,16 +27,21 @@
     "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-prod": "webpack --config webpack/webpack.config.prod.js",
+        "build-prod": "npm run copy-types && webpack --config webpack/webpack.config.prod.js",
         "build-prod-debug": "webpack --config webpack/webpack.config.debug-size.js",
         "format": "prettier --write .",
-        "test": "jest"
+        "copy-types": "copyfiles -u 2 \"src/types/**/*.d.ts\" build/types",
+        "type-check": "tsc --noEmit && tsc --noEmit test/typescript-test.ts",
+        "docs:api": "typedoc --options typedoc.json",
+        "docs": "npm run docs:api"
     },
     "dependencies": {
         "d3-array": "^3.2.4",
@@ -65,19 +70,21 @@
     },
     "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",
+        "copyfiles": "^2.4.1",
         "css-loader": "^7.1.2",
         "prettier": "^3.4.1",
         "style-loader": "^4.0.0",
         "ts-loader": "^9.5.4",
+        "typedoc": "^0.28.12",
+        "typedoc-plugin-missing-exports": "^4.0.0",
         "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-dev-server": "^5.2.3",
         "webpack-livereload-plugin": "^3.0.2"
     }
 }