eurostat-map 4.4.0 → 4.4.1

package/build/types/map-types/composition/pie/PieMap.d.ts

@@ -1,10 +1,14 @@
 import type { MapInstance } from '../../../core/MapInstance'
 import type { CompositionStatConfig } from '../CompositionStatConfig'
+import type { PieChartLegendConfig } from '../../../legend/composition/PieChartLegendConfig'
 
 /**
  * Pie map type.
  */
 export interface PieMap extends MapInstance {
+    legend(): PieChartLegendConfig
+    legend(config: PieChartLegendConfig | false): this
+
     catColors(): any
     catColors(v: any): this
 
@@ -41,9 +45,6 @@ export interface PieMap extends MapInstance {
     dorling(): boolean
     dorling(v: boolean): this
 
-    animateDorling(): boolean
-    animateDorling(v: boolean): this
-
     pieTotalCode(): string | undefined
     pieTotalCode(v: string | undefined): this
 
@@ -52,11 +53,17 @@ export interface PieMap extends MapInstance {
 
     statPie(config: CompositionStatConfig): this
     statPie(
+        /** Config. */
         config: CompositionStatConfig,
+        /** Category parameter. */
         categoryParameter?: string,
+        /** Category codes. */
         categoryCodes?: string[],
+        /** Category labels. */
         categoryLabels?: string[],
+        /** Category colors. */
         categoryColors?: string[],
+        /** Total code. */
         totalCode?: string
     ): this
 }

package/build/types/map-types/composition/pie/PieMapConfig.d.ts

@@ -1,24 +1,42 @@
 import type { MapConfig } from '../../../core/MapConfig'
+import type { PieChartLegendConfig } from '../../../legend/composition/PieChartLegendConfig'
 
 /**
  * Configuration for pie chart composition maps.
  */
 export interface PieMapConfig extends MapConfig {
+    /** Pie min radius. */
     pieMinRadius?: number
+    /** Pie max radius. */
     pieMaxRadius?: number
+    /** Pie chart inner radius. */
     pieChartInnerRadius?: number
+    /** Pie stroke fill. */
     pieStrokeFill?: string
+    /** Pie stroke width. */
     pieStrokeWidth?: number
+    /** Tooltip pie radius. */
     tooltipPieRadius?: number
+    /** Tooltip pie inner radius. */
     tooltipPieInnerRadius?: number
+    /** Cat colors. */
     catColors?: Record<string, string>
+    /** Cat labels. */
     catLabels?: Record<string, string>
+    /** Pie other color. */
     pieOtherColor?: string
+    /** Pie other text. */
     pieOtherText?: string
+    /** Show only when complete. */
     showOnlyWhenComplete?: boolean
+    /** No data fill style. */
     noDataFillStyle?: string
+    /** Dorling. */
     dorling?: boolean
-    animateDorling?: boolean
+    /** Pie total code. */
     pieTotalCode?: string
+    /** Stat codes. */
     statCodes?: string[]
+    /** Legend. */
+    legend?: PieChartLegendConfig | false
 }

package/build/types/map-types/composition/stripe/StripeMap.d.ts

@@ -1,10 +1,14 @@
 import type { MapInstance } from '../../../core/MapInstance'
 import type { CompositionStatConfig } from '../CompositionStatConfig'
+import type { StripeCompositionLegendConfig } from '../../../legend/composition/StripeCompositionLegendConfig'
 
 /**
  * Stripe map type.
  */
 export interface StripeMap extends MapInstance {
+    legend(): StripeCompositionLegendConfig
+    legend(config: StripeCompositionLegendConfig | false): this
+
     stripeWidth(): number
     stripeWidth(v: number): this
 
@@ -34,10 +38,15 @@ export interface StripeMap extends MapInstance {
 
     statComp(config: CompositionStatConfig): this
     statComp(
+        /** Config. */
         config: CompositionStatConfig,
+        /** Category parameter. */
         categoryParameter?: string,
+        /** Category codes. */
         categoryCodes?: string[],
+        /** Category labels. */
         categoryLabels?: string[],
+        /** Category colors. */
         categoryColors?: string[]
     ): this
 }

package/build/types/map-types/composition/stripe/StripeMapConfig.d.ts

@@ -1,16 +1,28 @@
 import type { MapConfig } from '../../../core/MapConfig'
+import type { StripeCompositionLegendConfig } from '../../../legend/composition/StripeCompositionLegendConfig'
 
 /**
  * Configuration for stripe composition maps.
  */
 export interface StripeMapConfig extends MapConfig {
+    /** Stripe width. */
     stripeWidth?: number
+    /** Stripe orientation. */
     stripeOrientation?: number
+    /** Cat colors. */
     catColors?: Record<string, string>
+    /** Cat labels. */
     catLabels?: Record<string, string>
+    /** Show only when complete. */
     showOnlyWhenComplete?: boolean
+    /** No data fill style. */
     noDataFillStyle?: string
+    /** Pie chart radius. */
     pieChartRadius?: number
+    /** Pie chart inner radius. */
     pieChartInnerRadius?: number
+    /** Stat codes. */
     statCodes?: string[]
+    /** Legend. */
+    legend?: StripeCompositionLegendConfig | false
 }

package/build/types/map-types/composition/waffle/WaffleMap.d.ts

@@ -1,10 +1,14 @@
 import type { MapInstance } from '../../../core/MapInstance'
 import type { CompositionStatConfig } from '../CompositionStatConfig'
+import type { WaffleLegendConfig } from '../../../legend/composition/WaffleLegendConfig'
 
 /**
  * Waffle map type.
  */
 export interface WaffleMap extends MapInstance {
+    legend(): WaffleLegendConfig
+    legend(config: WaffleLegendConfig | false): this
+
     catColors(): any
     catColors(v: any): this
 
@@ -50,9 +54,6 @@ export interface WaffleMap extends MapInstance {
     dorling(): boolean
     dorling(v: boolean): this
 
-    animateDorling(): boolean
-    animateDorling(v: boolean): this
-
     waffleTotalCode(): string | undefined
     waffleTotalCode(v: string | undefined): this
 
@@ -61,11 +62,17 @@ export interface WaffleMap extends MapInstance {
 
     statWaffle(config: CompositionStatConfig): this
     statWaffle(
+        /** Config. */
         config: CompositionStatConfig,
+        /** Category parameter. */
         categoryParameter?: string,
+        /** Category codes. */
         categoryCodes?: string[],
+        /** Category labels. */
         categoryLabels?: string[],
+        /** Category colors. */
         categoryColors?: string[],
+        /** Total code. */
         totalCode?: string
     ): this
 }

package/build/types/map-types/composition/waffle/WaffleMapConfig.d.ts

@@ -1,25 +1,44 @@
 import type { MapConfig } from '../../../core/MapConfig'
+import type { WaffleLegendConfig } from '../../../legend/composition/WaffleLegendConfig'
 
 /**
  * Configuration for waffle chart composition maps.
  */
 export interface WaffleMapConfig extends MapConfig {
+    /** Waffle min size. */
     waffleMinSize?: number
+    /** Waffle max size. */
     waffleMaxSize?: number
+    /** Waffle grid size. */
     waffleGridSize?: number
+    /** Waffle cell padding. */
     waffleCellPadding?: number
+    /** Waffle stroke fill. */
     waffleStrokeFill?: string
+    /** Waffle stroke width. */
     waffleStrokeWidth?: number
+    /** Waffle rounded corners. */
     waffleRoundedCorners?: number
+    /** Waffle tooltip size. */
     waffleTooltipSize?: number
+    /** Cat colors. */
     catColors?: Record<string, string>
+    /** Cat labels. */
     catLabels?: Record<string, string>
+    /** Waffle other color. */
     waffleOtherColor?: string
+    /** Waffle other text. */
     waffleOtherText?: string
+    /** Show only when complete. */
     showOnlyWhenComplete?: boolean
+    /** No data fill style. */
     noDataFillStyle?: string
+    /** Dorling. */
     dorling?: boolean
-    animateDorling?: boolean
+    /** Waffle total code. */
     waffleTotalCode?: string
+    /** Stat codes. */
     statCodes?: string[]
+    /** Legend. */
+    legend?: WaffleLegendConfig | false
 }

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

@@ -4,10 +4,15 @@ 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
 }
@@ -16,10 +21,15 @@ export interface FlowNode {
  * 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
 }
@@ -28,7 +38,9 @@ export interface FlowLink {
  * Graph input used by flow maps.
  */
 export interface FlowGraph {
+    /** Nodes. */
     nodes: FlowNode[]
+    /** Links. */
     links: FlowLink[]
 }
 
@@ -36,10 +48,15 @@ export interface FlowGraph {
  * 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
 }
 
@@ -47,10 +64,15 @@ export interface FlowCurvatureSettings {
  * 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
 }
 
@@ -58,10 +80,15 @@ export interface FlowWidthGradientSettings {
  * 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
 }
 
@@ -69,35 +96,63 @@ export interface FlowBundleSettings {
  * 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/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.1",
     "description": "Reusable library to quickly create and customise web maps showing Eurostat data directly retrieved from Eurostat database.",
     "keywords": [
         "eurostat",
@@ -39,7 +39,9 @@
         "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"
+        "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",
@@ -76,6 +78,8 @@
         "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",