eurostat-map 4.4.0 → 4.4.2

package/build/types/map-types/choropleth/BivariateChoroplethConfig.d.ts

@@ -1,15 +1,27 @@
 import type { MapConfig } from '../../core/MapConfig'
+import type { BivariateLegendConfig } from '../../legend/choropleth/BivariateLegendConfig'
 
 /**
  * Configuration for bivariate choropleth maps.
  */
 export interface BivariateChoroplethConfig extends MapConfig {
+    /** Bivariate choropleth legend configuration. */
+    legend?: BivariateLegendConfig | false
+
+    /** Number of classes. */
     numberOfClasses?: number
+    /** Breaks1. */
     breaks1?: number[]
+    /** Breaks2. */
     breaks2?: number[]
+    /** Start color. */
     startColor?: string
+    /** Color1. */
     color1?: string
+    /** Color2. */
     color2?: string
+    /** End color. */
     endColor?: string
+    /** No data fill style. */
     noDataFillStyle?: string
 }

package/build/types/map-types/choropleth/ChoroplethConfig.d.ts

@@ -1,29 +1,39 @@
 import { MapConfig } from '../../core/MapConfig'
+import type { ChoroplethLegendConfig } from '../../legend/choropleth/ChoroplethLegendConfig'
 
 /**
  * Configuration specific to choropleth maps
  */
 export interface ChoroplethConfig extends MapConfig {
-    // Classification
+    /** Choropleth legend configuration. */
+    legend?: ChoroplethLegendConfig | false
+
+    /** Classification. */
     numberOfClasses?: number
+    /** Classification method. */
     classificationMethod?: 'quantile' | 'ckmeans' | 'jenks' | 'equinter' | 'threshold'
+    /** Thresholds. */
     thresholds?: number[]
+    /** Make classif nice. */
     makeClassifNice?: boolean
 
-    // Colors
+    /** Colors. */
     colors?: string[]
     colorFunction?: (t: number) => string
+    /** Color scheme type. */
     colorSchemeType?: 'discrete' | 'continuous'
+    /** Class to fill style. */
     classToFillStyle?: { [classIndex: number]: string }
 
-    // No data styling
+    /** No-data styling. */
     noDataFillStyle?: string
 
-    // Value transformation (for continuous schemes)
+    /** Value transformation (for continuous schemes). */
     valueTransform?: (x: number) => number
     valueUntransform?: (x: number) => number
+    /** Skip normalization. */
     skipNormalization?: boolean
 
-    // Diverging schemes
+    /** Diverging schemes. */
     pointOfDivergence?: number
 }

package/build/types/map-types/choropleth/TrivariateChoroplethConfig.d.ts

@@ -1,18 +1,32 @@
 import type { MapConfig } from '../../core/MapConfig'
+import type { TrivariateLegendConfig } from '../../legend/choropleth/TrivariateLegendConfig'
 
 /**
  * Configuration for trivariate choropleth maps.
  */
 export interface TrivariateChoroplethConfig extends MapConfig {
+    /** Trivariate choropleth legend configuration. */
+    legend?: TrivariateLegendConfig | false
+
+    /** Ternary codes. */
     ternaryCodes?: [string, string, string]
+    /** No data fill style. */
     noDataFillStyle?: string
+    /** Ternary settings. */
     ternarySettings?: {
+        /** Hue. */
         hue?: number
+        /** Chroma. */
         chroma?: number
+        /** Lightness. */
         lightness?: number
+        /** Contrast. */
         contrast?: number
+        /** Spread. */
         spread?: number
+        /** Breaks. */
         breaks?: number
+        /** Mean centering. */
         meanCentering?: boolean
     }
 }

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

@@ -2,20 +2,33 @@
  * Statistical configuration for composition maps (pie, bar, waffle, stripe).
  */
 export interface CompositionStatConfig {
+    /** Eurostat dataset code. */
     eurostatDatasetCode?: string
+    /** Filters. */
     filters?: Record<string, any>
+    /** Unit text. */
     unitText?: string
+    transform?: (value: number) => number
 
+    /** Category parameter. */
     categoryParameter?: string
+    /** Category codes. */
     categoryCodes?: string[]
+    /** Category labels. */
     categoryLabels?: string[]
+    /** Category colors. */
     categoryColors?: string[]
+    /** Total code. */
     totalCode?: string
 
-    // Legacy nested API supported by buildStatCompositionMethod
+    /** Legacy nested API supported by buildStatCompositionMethod. */
     stat?: {
+        /** Eurostat dataset code. */
         eurostatDatasetCode?: string
+        /** Filters. */
         filters?: Record<string, any>
+        /** Unit text. */
         unitText?: string
+        transform?: (value: number) => number
     }
 }

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

@@ -1,10 +1,14 @@
 import type { MapInstance } from '../../../core/MapInstance'
 import type { CompositionStatConfig } from '../CompositionStatConfig'
+import type { BarChartLegendConfig } from '../../../legend/composition/BarChartLegendConfig'
 
 /**
  * Bar map type.
  */
 export interface BarMap extends MapInstance {
+    legend(): BarChartLegendConfig
+    legend(config: BarChartLegendConfig | false): this
+
     barType(): 'stacked' | 'grouped'
     barType(v: 'stacked' | 'grouped'): this
 
@@ -65,9 +69,6 @@ export interface BarMap extends MapInstance {
     dorling(): boolean
     dorling(v: boolean): this
 
-    animateDorling(): boolean
-    animateDorling(v: boolean): this
-
     barTotalCode(): string | undefined
     barTotalCode(v: string | undefined): this
 

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

@@ -1,30 +1,54 @@
 import type { MapConfig } from '../../../core/MapConfig'
+import type { BarChartLegendConfig } from '../../../legend/composition/BarChartLegendConfig'
 
 /**
  * Configuration for bar chart composition maps.
  */
 export interface BarMapConfig extends MapConfig {
+    /** Bar type. */
     barType?: 'stacked' | 'grouped'
+    /** Cat colors. */
     catColors?: Record<string, string>
+    /** Cat labels. */
     catLabels?: Record<string, string>
+    /** Show only when complete. */
     showOnlyWhenComplete?: boolean
+    /** No data fill style. */
     noDataFillStyle?: string
+    /** Bar min width. */
     barMinWidth?: number
+    /** Bar max width. */
     barMaxWidth?: number
+    /** Bar height. */
     barHeight?: number
+    /** Bar group width. */
     barGroupWidth?: number
+    /** Bar group gap. */
     barGroupGap?: number
+    /** Bar group min height. */
     barGroupMinHeight?: number
+    /** Bar group max height. */
     barGroupMaxHeight?: number
+    /** Bar stroke fill. */
     barStrokeFill?: string
+    /** Bar stroke width. */
     barStrokeWidth?: number
+    /** Bar corner radius. */
     barCornerRadius?: number
+    /** Bar other color. */
     barOtherColor?: string
+    /** Bar other text. */
     barOtherText?: string
+    /** Bar tooltip width. */
     barTooltipWidth?: number
+    /** Bar tooltip height. */
     barTooltipHeight?: number
+    /** Dorling. */
     dorling?: boolean
-    animateDorling?: boolean
+    /** Bar total code. */
     barTotalCode?: string
+    /** Stat codes. */
     statCodes?: string[]
+    /** Legend. */
+    legend?: BarChartLegendConfig | false
 }

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

@@ -1,10 +1,14 @@
 import type { MapInstance } from '../../../core/MapInstance'
 import type { CoxcombStatConfig } from './CoxcombStatConfig'
+import type { CoxcombLegendConfig } from '../../../legend/composition/CoxcombLegendConfig'
 
 /**
  * Coxcomb map type.
  */
 export interface CoxcombMap extends MapInstance {
+    legend(): CoxcombLegendConfig
+    legend(config: CoxcombLegendConfig | false): this
+
     catColors(): any
     catColors(v: any): this
 

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

@@ -1,18 +1,32 @@
 import type { MapConfig } from '../../../core/MapConfig'
+import type { CoxcombLegendConfig } from '../../../legend/composition/CoxcombLegendConfig'
 
 /**
  * Configuration for coxcomb (polar area) chart maps.
  */
 export interface CoxcombMapConfig extends MapConfig {
+    /** Coxcomb min radius. */
     coxcombMinRadius?: number
+    /** Coxcomb max radius. */
     coxcombMaxRadius?: number
+    /** Coxcomb stroke fill. */
     coxcombStrokeFill?: string
+    /** Coxcomb stroke width. */
     coxcombStrokeWidth?: number
+    /** Coxcomb rings. */
     coxcombRings?: boolean
+    /** Coxcomb offsets. */
     coxcombOffsets?: { x: number; y: number }
+    /** Hover color. */
     hoverColor?: string
+    /** Cat colors. */
     catColors?: Record<string, string>
+    /** Cat labels. */
     catLabels?: Record<string, string>
+    /** No data fill style. */
     noDataFillStyle?: string
+    /** Classifier size. */
     classifierSize?: any
+    /** Legend. */
+    legend?: CoxcombLegendConfig | false
 }

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

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

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
 }