eurostat-map 4.4.0 → 4.4.2

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

@@ -4,21 +4,14 @@ 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
-    sizeMin?: number
-    sizeMax?: number
-    symbolFillStyle?: string
-    symbolStrokeStyle?: string
-    symbolStrokeWidth?: number
 
-    // Dorling cartogram
+    /** Dorling cartogram. */
     dorling?: boolean
-    dorlingIterations?: number
 
-    // Size function
+    /** Size function. */
     psCustomSize?: (value: number) => number
-
-    // Scaling
-    psScale?: 'sqrt' | 'linear' | 'radial'
 }

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

@@ -79,15 +79,6 @@ export interface ProportionalSymbolMap extends MapInstance {
     dorling(): boolean
     dorling(v: boolean): this
 
-    dorlingStrength(): any
-    dorlingStrength(v: any): this
-
-    dorlingIterations(): number
-    dorlingIterations(v: number): this
-
-    animateDorling(): boolean
-    animateDorling(v: boolean): this
-
     psSpikeWidth(): number
     psSpikeWidth(v: number): this
 

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

@@ -4,10 +4,15 @@ 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

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

@@ -1,10 +1,14 @@
 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
 
@@ -41,8 +45,8 @@ export interface SparkMap extends MapInstance {
     sparkLineOffsets(): { x: number; y: number }
     sparkLineOffsets(v: { x: number; y: number }): this
 
-    //manually set the data for the sparkline, instead of fetching it from Eurostat
+    /** Manually set sparkline data instead of fetching it from Eurostat. */
     sparklineData(dataObject: Record<string, Record<string, number>>): this
-    //configuration for fetching the data from Eurostat and generating the sparkline
+    /** Configure fetching data from Eurostat and generating spark lines. */
     statSpark(config: SparkStatConfig): this
 }

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

@@ -1,25 +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

@@ -2,9 +2,15 @@
  * 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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "eurostat-map",
-    "version": "4.4.0",
+    "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,7 +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",
+        "generate-previews": "node examples/scripts/generate-previews.js"
     },
     "dependencies": {
         "d3-array": "^3.2.4",
@@ -73,9 +77,12 @@
         "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",
+        "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",