eurostat-map 4.4.2 → 4.4.4

package/build/package.json

@@ -1,6 +1,6 @@
 {
     "name": "eurostat-map",
-    "version": "4.3.58",
+    "version": "4.4.4",
     "description": "Reusable library to quickly create and customise web maps showing Eurostat data directly retrieved from Eurostat database.",
     "keywords": [
         "eurostat",

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

@@ -112,6 +112,9 @@ export interface MapConfig {
     /** Show/hide inset map toggle button. */
     insetsButton?: boolean
 
+    /** Show/hide legend toggle button. */
+    legendButton?: boolean
+
     /** Show/hide placename labels. */
     placenames?: boolean
 
@@ -151,6 +154,9 @@ export interface MapConfig {
     /** Position adjustment for insets button: [x, y] */
     insetsButtonPosition?: [number, number]
 
+    /** Position adjustment for legend button: [x, y] */
+    legendButtonPosition?: [number, number]
+
     /** Pointer hover color for NUTS regions. */
     hoverColor?: string
 

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

@@ -152,7 +152,7 @@ export interface MapInstance {
      * Get or set legend configuration. Pass false to remove the legend.
      * @example map.legend({ x: 10, y: 90, title: 'Density, people/km²' })
      */
-    legend(): LegendConfig
+    legend(): LegendConfig | false
     legend(config: LegendConfig | false): this
 
     /** Force-update the legend after data or style changes. */
@@ -266,6 +266,10 @@ export interface MapInstance {
     insetsButton(): boolean
     insetsButton(show: boolean): this
 
+    /** Show/hide legend toggle button. */
+    legendButton(): boolean
+    legendButton(show: boolean): this
+
     /** Filter function for placename labels. */
     placenamesFilter(): ((name: any) => boolean) | undefined
     placenamesFilter(fn: (name: any) => boolean): this
@@ -314,6 +318,10 @@ export interface MapInstance {
     insetsButtonPosition(): [number, number] | undefined
     insetsButtonPosition(pos: [number, number]): this
 
+    /** Position adjustment for legend button: [x, y] */
+    legendButtonPosition(): [number, number] | undefined
+    legendButtonPosition(pos: [number, number]): this
+
     /** Pointer hover color for NUTS regions. */
     hoverColor(): string
     hoverColor(color: string): this

package/build/types/index.d.ts

@@ -58,16 +58,23 @@ export type EurostatMap = MapInstance
 export type { TooltipConfig } from './core/TooltipConfig'
 export type { LegendConfig } from './legend/LegendConfig'
 export type { StatConfig } from './core/stat/StatConfig'
+export type { StatData } from './core/stat/StatData'
 export type { InsetConfig } from './core/InsetConfig'
 export type { CoastalMarginSettings } from './core/decoration/CoastalMarginSettings'
+export type { ScalebarConfig } from './core/decoration/ScalebarConfig'
+export type { StampConfig } from './core/decoration/StampConfig'
 export type { GridCartogramSettings, GridCartogramMargins } from './core/GridCartogramSettings'
 export type { DorlingSettings, DorlingStrength } from './core/DorlingSettings'
+export type { MinimapConfig } from './core/minimaps'
+export type { LocationConfig } from './core/locations'
+export type { GeometriesClass } from './core/geo/geometries'
 
 // ==================== Legend Configuration Type Exports ====================
 
 // Main legend types
 export type { CategoricalLegendConfig } from './legend/CategoricalLegendConfig'
 export type { MushroomLegendConfig } from './legend/MushroomLegendConfig'
+export type { MushroomSizeLegendConfig, MushroomColorLegendConfig } from './legend/MushroomLegendConfig'
 export type { PatternFillLegendConfig } from './legend/PatternFillLegendConfig'
 
 // Choropleth legend types
@@ -78,9 +85,13 @@ export type { TrivariateLegendConfig } from './legend/choropleth/TrivariateLegen
 
 // Composition legend types
 export type { BarChartLegendConfig } from './legend/composition/BarChartLegendConfig'
+export type { BarChartSizeLegendConfig, BarChartColorLegendConfig } from './legend/composition/BarChartLegendConfig'
 export type { CoxcombLegendConfig } from './legend/composition/CoxcombLegendConfig'
+export type { CoxcombSizeLegendConfig, CoxcombColorLegendConfig, CoxcombTimeLegendConfig } from './legend/composition/CoxcombLegendConfig'
 export type { PieChartLegendConfig } from './legend/composition/PieChartLegendConfig'
+export type { PieChartSizeLegendConfig, PieChartColorLegendConfig } from './legend/composition/PieChartLegendConfig'
 export type { WaffleLegendConfig } from './legend/composition/WaffleLegendConfig'
+export type { WaffleSizeLegendConfig, WaffleColorLegendConfig } from './legend/composition/WaffleLegendConfig'
 export type { StripeCompositionLegendConfig } from './legend/composition/StripeCompositionLegendConfig'
 export type {
     SparklineLegendConfig,
@@ -91,9 +102,14 @@ export type {
 
 // Flow legend types
 export type { FlowMapLegendConfig } from './legend/flow/FlowMapLegendConfig'
+export type { FlowWidthLegendConfig, NodeSizeLegendConfig, FlowColorLegendConfig, RegionColorLegendConfig } from './legend/flow/FlowMapLegendConfig'
 
 // Proportional symbol legend types
 export type { ProportionalSymbolsLegendConfig } from './legend/proportional-symbol/ProportionalSymbolsLegendConfig'
+export type {
+    ProportionalSymbolSizeLegendConfig,
+    ProportionalSymbolColorLegendConfig,
+} from './legend/proportional-symbol/ProportionalSymbolsLegendConfig'
 
 // ==================== Map Type Exports ====================
 
@@ -136,6 +152,14 @@ export type { SparkMapConfig, SparkMap, SparkStatConfig }
 
 // Flow map types
 export type { FlowMapConfig, FlowMap }
+export type {
+    FlowNode,
+    FlowLink,
+    FlowGraph,
+    FlowCurvatureSettings,
+    FlowWidthGradientSettings,
+    FlowBundleSettings,
+} from './map-types/flow/FlowMapConfig'
 
 // ==================== Pattern Fill Options ====================
 

package/build/types/map-types/composition/CompositionStatConfig.d.ts

@@ -1,8 +1,24 @@
 /**
  * Statistical configuration for composition maps (pie, bar, waffle, stripe).
+ *
+ * Either `eurostatDatasetCode` + `categoryParameter` (Eurostat API path)
+ * or `customData` (custom data path) must be provided.
  */
-export interface CompositionStatConfig {
-    /** Eurostat dataset code. */
+export interface CompositionStatConfig<TCustomData = Record<string, Record<string, number>>> {
+    /**
+     * Custom data keyed by region ID then category code.
+     * Use instead of `eurostatDatasetCode` when supplying data directly.
+     * When `customData` is set, `eurostatDatasetCode` and `categoryParameter`
+     * are not required.
+     * @example
+     * customData: {
+     *   ES: { cat1: 2, cat2: 3, cat3: 5 },
+     *   DE: { cat1: 4, cat2: 1, cat3: 6 },
+     * }
+     */
+    customData?: TCustomData
+
+    /** Eurostat dataset code. Required when not using `customData`. */
     eurostatDatasetCode?: string
     /** Filters. */
     filters?: Record<string, any>
@@ -10,7 +26,7 @@ export interface CompositionStatConfig {
     unitText?: string
     transform?: (value: number) => number
 
-    /** Category parameter. */
+    /** Category parameter. Required when not using `customData`. */
     categoryParameter?: string
     /** Category codes. */
     categoryCodes?: string[]

package/build/types/map-types/composition/bar/BarMap.d.ts

@@ -6,7 +6,7 @@ import type { BarChartLegendConfig } from '../../../legend/composition/BarChartL
  * Bar map type.
  */
 export interface BarMap extends MapInstance {
-    legend(): BarChartLegendConfig
+    legend(): BarChartLegendConfig | false
     legend(config: BarChartLegendConfig | false): this
 
     barType(): 'stacked' | 'grouped'

package/build/types/map-types/composition/coxcomb/CoxcombMap.d.ts

@@ -6,7 +6,7 @@ import type { CoxcombLegendConfig } from '../../../legend/composition/CoxcombLeg
  * Coxcomb map type.
  */
 export interface CoxcombMap extends MapInstance {
-    legend(): CoxcombLegendConfig
+    legend(): CoxcombLegendConfig | false
     legend(config: CoxcombLegendConfig | false): this
 
     catColors(): any

package/build/types/map-types/composition/coxcomb/CoxcombStatConfig.d.ts

@@ -3,14 +3,11 @@ import { CompositionStatConfig } from '../CompositionStatConfig'
 /**
  * Statistical configuration for coxcomb maps.
  */
-export interface CoxcombStatConfig extends CompositionStatConfig {
+export interface CoxcombStatConfig extends CompositionStatConfig<Record<string, Record<string, Record<string, number>>>> {
     /** Eurostat path. */
     timeParameter?: string
     /** Times. */
     times: string[]
     /** Time labels. */
     timeLabels?: string[]
-
-    /** Custom data path. */
-    customData?: Record<string, Record<string, Record<string, number>>>
 }

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

@@ -6,7 +6,7 @@ import type { PieChartLegendConfig } from '../../../legend/composition/PieChartL
  * Pie map type.
  */
 export interface PieMap extends MapInstance {
-    legend(): PieChartLegendConfig
+    legend(): PieChartLegendConfig | false
     legend(config: PieChartLegendConfig | false): this
 
     catColors(): any
@@ -21,32 +21,47 @@ export interface PieMap extends MapInstance {
     noDataFillStyle(): string
     noDataFillStyle(v: string): this
 
-    pieMaxRadius(): number
-    pieMaxRadius(v: number): this
-
-    pieMinRadius(): number
-    pieMinRadius(v: number): this
-
-    pieChartInnerRadius(): number
-    pieChartInnerRadius(v: number): this
-
-    pieOtherColor(): string
-    pieOtherColor(v: string): this
-
-    pieOtherText(): string
-    pieOtherText(v: string): this
-
-    pieStrokeFill(): string
-    pieStrokeFill(v: string): this
-
-    pieStrokeWidth(): number
-    pieStrokeWidth(v: number): this
+    pieSettings(): {
+        innerRadius?: number
+    }
+    pieSettings(v: { innerRadius?: number }): this
+
+    compositionSettings(): {
+        type?: 'flag' | 'pie' | 'ring' | 'segment' | 'radar' | 'agepyramid' | 'halftone'
+        minSize?: number
+        maxSize?: number
+        strokeFill?: string
+        strokeWidth?: number
+        reverseOrder?: boolean
+        /** Category code order for composition rendering. */
+        order?: string[]
+        stripesOrientation?: number
+        offsetAngle?: number
+        agePyramidHeightFactor?: number
+        otherColor?: string
+        otherText?: string
+    }
+    compositionSettings(v: {
+        type?: 'flag' | 'pie' | 'ring' | 'segment' | 'radar' | 'agepyramid' | 'halftone'
+        minSize?: number
+        maxSize?: number
+        strokeFill?: string
+        strokeWidth?: number
+        reverseOrder?: boolean
+        /** Category code order for composition rendering. */
+        order?: string[]
+        stripesOrientation?: number
+        offsetAngle?: number
+        agePyramidHeightFactor?: number
+        otherColor?: string
+        otherText?: string
+    }): this
 
     dorling(): boolean
     dorling(v: boolean): this
 
-    pieTotalCode(): string | undefined
-    pieTotalCode(v: string | undefined): this
+    compositionTotalCode(): string | undefined
+    compositionTotalCode(v: string | undefined): this
 
     statCodes(): string[] | undefined
     statCodes(v: string[] | undefined): this

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

@@ -5,16 +5,26 @@ import type { PieChartLegendConfig } from '../../../legend/composition/PieChartL
  * 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
+    /** Pie-specific rendering settings. */
+    pieSettings?: {
+        innerRadius?: number
+    }
+    /** Consolidated composition symbol settings. */
+    compositionSettings?: {
+        type?: 'flag' | 'pie' | 'ring' | 'segment' | 'radar' | 'agepyramid' | 'halftone'
+        minSize?: number
+        maxSize?: number
+        strokeFill?: string
+        strokeWidth?: number
+        reverseOrder?: boolean
+        /** Category code order for composition rendering. */
+        order?: string[]
+        stripesOrientation?: number
+        offsetAngle?: number
+        agePyramidHeightFactor?: number
+        otherColor?: string
+        otherText?: string
+    }
     /** Tooltip pie radius. */
     tooltipPieRadius?: number
     /** Tooltip pie inner radius. */
@@ -23,18 +33,14 @@ export interface PieMapConfig extends MapConfig {
     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
-    /** Pie total code. */
-    pieTotalCode?: string
+    /** Total code used to compute optional 'other' composition share. */
+    compositionTotalCode?: string
     /** Stat codes. */
     statCodes?: string[]
     /** Legend. */

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

@@ -6,7 +6,7 @@ import type { StripeCompositionLegendConfig } from '../../../legend/composition/
  * Stripe map type.
  */
 export interface StripeMap extends MapInstance {
-    legend(): StripeCompositionLegendConfig
+    legend(): StripeCompositionLegendConfig | false
     legend(config: StripeCompositionLegendConfig | false): this
 
     stripeWidth(): number
@@ -21,6 +21,12 @@ export interface StripeMap extends MapInstance {
     catLabels(): any
     catLabels(v: any): this
 
+    stripeOtherColor(): string
+    stripeOtherColor(v: string): this
+
+    stripeOtherText(): string
+    stripeOtherText(v: string): this
+
     showOnlyWhenComplete(): boolean
     showOnlyWhenComplete(v: boolean): this
 
@@ -33,6 +39,9 @@ export interface StripeMap extends MapInstance {
     pieChartInnerRadius(): number
     pieChartInnerRadius(v: number): this
 
+    stripeTotalCode(): string | undefined
+    stripeTotalCode(v: string | undefined): this
+
     statCodes(): string[] | undefined
     statCodes(v: string[] | undefined): this
 
@@ -47,6 +56,8 @@ export interface StripeMap extends MapInstance {
         /** Category labels. */
         categoryLabels?: string[],
         /** Category colors. */
-        categoryColors?: string[]
+        categoryColors?: string[],
+        /** Total code. */
+        totalCode?: string
     ): this
 }

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

@@ -13,6 +13,10 @@ export interface StripeMapConfig extends MapConfig {
     catColors?: Record<string, string>
     /** Cat labels. */
     catLabels?: Record<string, string>
+    /** Stripe other color. */
+    stripeOtherColor?: string
+    /** Stripe other text. */
+    stripeOtherText?: string
     /** Show only when complete. */
     showOnlyWhenComplete?: boolean
     /** No data fill style. */
@@ -21,6 +25,8 @@ export interface StripeMapConfig extends MapConfig {
     pieChartRadius?: number
     /** Pie chart inner radius. */
     pieChartInnerRadius?: number
+    /** Stripe total code. */
+    stripeTotalCode?: string
     /** Stat codes. */
     statCodes?: string[]
     /** Legend. */

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

@@ -6,7 +6,7 @@ import type { WaffleLegendConfig } from '../../../legend/composition/WaffleLegen
  * Waffle map type.
  */
 export interface WaffleMap extends MapInstance {
-    legend(): WaffleLegendConfig
+    legend(): WaffleLegendConfig | false
     legend(config: WaffleLegendConfig | false): this
 
     catColors(): any

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

@@ -6,7 +6,7 @@ import type { SparklineLegendConfig } from '../../legend/composition/SparklineLe
  * Spark map type.
  */
 export interface SparkMap extends MapInstance {
-    legend(): SparklineLegendConfig
+    legend(): SparklineLegendConfig | false
     legend(config: SparklineLegendConfig | false): this
 
     sparkLineColor(): any

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

@@ -1,16 +1,32 @@
 /**
  * Statistical configuration for sparkline maps.
+ *
+ * Either `eurostatDatasetCode` + `dates` (Eurostat API path)
+ * or `customData` (custom data path) must be provided.
  */
 export interface SparkStatConfig {
-    /** Eurostat dataset code. */
-    eurostatDatasetCode: string
+    /**
+     * Custom data keyed by region ID then date string.
+     * Use instead of `eurostatDatasetCode` when supplying data directly.
+     * When `customData` is set, `eurostatDatasetCode` is not required;
+     * `dates` defaults to the key order of the first region's entries.
+     * @example
+     * customData: {
+     *   ES: { '2020': 100, '2021': 120, '2022': 115 },
+     *   DE: { '2020': 200, '2021': 190, '2022': 210 },
+     * }
+     */
+    customData?: Record<string, Record<string, number>>
+
+    /** Eurostat dataset code. Required when not using `customData`. */
+    eurostatDatasetCode?: string
     /** Filters. */
     filters?: Record<string, any>
     /** Unit text. */
     unitText?: string
     transform?: (value: number) => number
-    /** Dates. */
-    dates: string[]
-    /** Labels. */
+    /** Date keys to fetch. Required when not using `customData`. */
+    dates?: string[]
+    /** Display labels for each date. */
     labels?: string[]
 }

package/package.json

@@ -1,21 +1,20 @@
 {
     "name": "eurostat-map",
-    "version": "4.4.2",
+    "version": "4.4.4",
     "description": "Reusable library to quickly create and customise web maps showing Eurostat data directly retrieved from Eurostat database.",
     "keywords": [
+        "cartography",
+        "data visualization",
+        "dataviz",
+        "maps",
+        "d3",
+        "europe",
         "eurostat",
         "statistics",
-        "europe",
         "SVG",
         "NUTS",
-        "map",
-        "D3",
-        "cartography",
-        "thematic",
-        "mapping",
-        "eurostat-map",
-        "dataviz",
-        "data visualization"
+        "thematic-mapping",
+        "eurostat-map"
     ],
     "homepage": "https://github.com/eurostat/eurostat-map",
     "author": "",
@@ -41,8 +40,9 @@
         "copy-types": "copyfiles -u 2 \"src/types/**/*.d.ts\" build/types",
         "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",
+        "update-docs": "typedoc --options typedoc.json",
+        "update-examples": "npm run update-examples-manifest && npm run generate-previews",
+        "update-examples-manifest": "node examples/scripts/update-examples-manifest.js",
         "generate-previews": "node examples/scripts/generate-previews.js"
     },
     "dependencies": {