eurostat-map 4.4.0 → 4.4.1

package/build/types/legend/SparklineLegendConfig.d.ts

@@ -1,68 +1,6 @@
-import { LegendConfig } from './LegendConfig'
-
-/**
- * Configuration for scale legend in sparkline maps.
- */
-export interface SparklineScaleLegendConfig {
-    /** Title for the scale legend section. */
-    title?: string | null
-
-    /** Padding between title and chart in pixels. @default 5 */
-    titlePadding?: number
-
-    /** Whether to show an example sparkline with averaged data. @default false */
-    showExampleChart?: boolean
-
-    /** Whether to show the region with maximum value. @default true */
-    showMaxRegion?: boolean
-
-    /** Custom example data for the sparkline. If null, uses averaged data. */
-    exampleData?: number[] | null
-
-    /** Number of ticks on Y axis. @default 5 */
-    tickCount?: number
-
-    /** Custom tick format function for Y axis values. */
-    tickFormat?: ((value: number) => string) | null
-
-    /** Whether to show X axis with date labels. @default true */
-    showXAxis?: boolean
-
-    /** Rotation angle for X axis labels in degrees. @default -45 */
-    xAxisRotation?: number
-
-    /** Step for showing X axis ticks (1 = every tick, 2 = every other, etc.). @default 1 */
-    xAxisTickStep?: number
-
-    /** Margins around the sparkline cell. Defaults to match the map's sparkline chart margin. */
-    margin?: { top: number; right: number; bottom: number; left: number }
-
-    /** Opacity of the sparkline. @default 0.5 */
-    lineOpacity?: number
-
-    /** Stroke width of the sparkline. @default 1 */
-    lineStrokeWidth?: number
-}
-
-/**
- * Configuration for no data legend in sparkline maps.
- */
-export interface SparklineNoDataLegendConfig {
-    /** Whether to show the no data legend item. @default true */
-    show?: boolean
-
-    /** Text label for "no data" item. @default 'No data' */
-    text?: string
-}
-
-/**
- * Configuration for sparkline map legends.
- * Shows the Y-axis scale and optionally an example sparkline chart.
- */
-export interface SparklineLegendConfig extends LegendConfig {
-    /** Configuration for the scale legend showing Y-axis range. */
-    scaleLegend?: Partial<SparklineScaleLegendConfig>
-
-    /** Configuration for the no data legend. Set to false to hide. */
-    noDataLegend?: Partial<SparklineNoDataLegendConfig> | false
-}
+export type {
+    SparklineScaleLegendConfig,
+    SparklineColorLegendConfig,
+    SparklineNoDataLegendConfig,
+    SparklineLegendConfig,
+} from './composition/SparklineLegendConfig'

package/build/types/legend/composition/CoxcombLegendConfig.d.ts

@@ -0,0 +1,85 @@
+import { LegendConfig } from '../LegendConfig'
+
+/**
+ * Configuration for size legend in coxcomb (polar area) charts.
+ */
+export interface CoxcombSizeLegendConfig {
+    /** Title for the size legend. */
+    title?: string | null
+
+    /** Padding between title and legend content in pixels. @default 15 */
+    titlePadding?: number
+
+    /** Custom values to display in the size legend. If not specified, values are auto-generated. */
+    values?: number[] | null
+
+    /** Custom labels for the size legend values. */
+    labels?: string[] | null
+
+    /** Custom formatter function for legend labels. */
+    labelFormatter?: ((value: number) => string) | null
+}
+
+/**
+ * Configuration for color legend in coxcomb (polar area) charts.
+ */
+export interface CoxcombColorLegendConfig {
+    /** Title for the color legend. */
+    title?: string | null
+
+    /** Padding between title and legend content in pixels. @default 15 */
+    titlePadding?: number
+
+    /** Top margin for the color legend in pixels. @default 23 */
+    marginTop?: number
+
+    /** Offset adjustments for labels. @default { x: 5, y: 5 } */
+    labelOffsets?: { x: number; y: number }
+
+    /** Width of color swatches in pixels. @default 25 */
+    shapeWidth?: number
+
+    /** Height of color swatches in pixels. @default 20 */
+    shapeHeight?: number
+
+    /** Padding between swatches in pixels. @default 1 */
+    shapePadding?: number
+
+    /** Whether to show a "no data" item. @default true */
+    noData?: boolean
+
+    /** Text label for "no data" item. @default 'No data' */
+    noDataText?: string
+}
+
+/**
+ * Configuration for time legend in coxcomb (polar area) charts.
+ */
+export interface CoxcombTimeLegendConfig {
+    /** Title for the time legend. */
+    title?: string | null
+
+    /** Padding between title and legend content in pixels. @default 15 */
+    titlePadding?: number
+
+    /** Top margin for the time legend in pixels. @default 20 */
+    marginTop?: number
+
+    /** Radius of the time legend circle in pixels. @default 35 */
+    radius?: number
+}
+
+/**
+ * Configuration for coxcomb (polar area) chart legends.
+ * Supports separate sub-legends for size, color, and time dimensions.
+ */
+export interface CoxcombLegendConfig extends LegendConfig {
+    /** Configuration for the wedge size legend. */
+    sizeLegend?: Partial<CoxcombSizeLegendConfig>
+
+    /** Configuration for the color/category legend. */
+    colorLegend?: Partial<CoxcombColorLegendConfig>
+
+    /** Configuration for the time period legend. */
+    timeLegend?: Partial<CoxcombTimeLegendConfig>
+}

package/build/types/legend/composition/PieChartLegendConfig.d.ts

@@ -0,0 +1,68 @@
+import { LegendConfig } from '../LegendConfig'
+
+/**
+ * Configuration for size legend in pie chart maps.
+ */
+export interface PieChartSizeLegendConfig {
+    /** Title for the size legend. */
+    title?: string | null
+
+    /** Padding between title and legend content in pixels. @default 10 */
+    titlePadding?: number
+
+    /** Custom values to display in the size legend. If not specified, values are auto-generated. */
+    values?: number[] | null
+
+    /** Custom formatter function for legend labels. */
+    labelFormatter?: ((value: number) => string) | undefined
+
+    /** Whether to show a "no data" item. @default false */
+    noData?: boolean
+
+    /** Text label for "no data" item. @default 'No data' */
+    noDataText?: string
+}
+
+/**
+ * Configuration for color legend in pie chart maps.
+ */
+export interface PieChartColorLegendConfig {
+    /** Title for the color legend. */
+    title?: string | null
+
+    /** Padding between title and legend content in pixels. @default 10 */
+    titlePadding?: number
+
+    /** Top margin (distance from size legend) in pixels. @default 33 */
+    marginTop?: number
+
+    /** Offset adjustments for labels. @default { x: 5, y: 5 } */
+    labelOffsets?: { x: number; y: number }
+
+    /** Width of color swatches in pixels. @default 25 */
+    shapeWidth?: number
+
+    /** Height of color swatches in pixels. @default 20 */
+    shapeHeight?: number
+
+    /** Padding between swatches in pixels. @default 1 */
+    shapePadding?: number
+
+    /** Whether to show a "no data" item. @default true */
+    noData?: boolean
+
+    /** Text label for "no data" item. @default 'No data' */
+    noDataText?: string
+}
+
+/**
+ * Configuration for pie chart map legends.
+ * Supports separate legends for pie size and slice colors.
+ */
+export interface PieChartLegendConfig extends LegendConfig {
+    /** Configuration for the pie size legend. Set to false to hide. */
+    sizeLegend?: Partial<PieChartSizeLegendConfig> | false
+
+    /** Configuration for the color/category legend. Set to false to hide. */
+    colorLegend?: Partial<PieChartColorLegendConfig> | false
+}

package/build/types/legend/composition/SparklineLegendConfig.d.ts

@@ -0,0 +1,94 @@
+import { LegendConfig } from '../LegendConfig'
+
+/**
+ * Configuration for scale legend in sparkline maps.
+ */
+export interface SparklineScaleLegendConfig {
+    /** Title for the scale legend section. */
+    title?: string | null
+
+    /** Padding between title and chart in pixels. @default 5 */
+    titlePadding?: number
+
+    /** Whether to show an example sparkline with averaged data. @default false */
+    showExampleChart?: boolean
+
+    /** Whether to show the region with maximum value. @default true */
+    showMaxRegion?: boolean
+
+    /** Custom example data for the sparkline. If null, uses averaged data. */
+    exampleData?: number[] | null
+
+    /** Number of ticks on Y axis. @default 5 */
+    tickCount?: number
+
+    /** Custom tick format function for Y axis values. */
+    tickFormat?: ((value: number) => string) | null
+
+    /** Whether to show X axis with date labels. @default true */
+    showXAxis?: boolean
+
+    /** Rotation angle for X axis labels in degrees. @default -45 */
+    xAxisRotation?: number
+
+    /** Step for showing X axis ticks (1 = every tick, 2 = every other, etc.). @default 1 */
+    xAxisTickStep?: number
+
+    /** Margins around the sparkline cell. Defaults to match the map's sparkline chart margin. */
+    margin?: { top: number; right: number; bottom: number; left: number }
+
+    /** Opacity of the sparkline. @default 0.5 */
+    lineOpacity?: number
+
+    /** Stroke width of the sparkline. @default 1 */
+    lineStrokeWidth?: number
+}
+
+/**
+ * Configuration for sparkline color legend (explains sparkLineColor/sparkAreaColor rules).
+ */
+export interface SparklineColorLegendConfig {
+    /** Show. */
+    show?: boolean
+    /** Title. */
+    title?: string | null
+    /** Title padding. */
+    titlePadding?: number
+    /** Margin top. */
+    marginTop?: number
+    /** Item gap. */
+    itemGap?: number
+    /** Swatch width. */
+    swatchWidth?: number
+    /** Swatch height. */
+    swatchHeight?: number
+    /** Label offset x. */
+    labelOffsetX?: number
+    /** Items. */
+    items?: Array<{ color: string; label: string }>
+}
+
+/**
+ * Configuration for no data legend in sparkline maps.
+ */
+export interface SparklineNoDataLegendConfig {
+    /** Whether to show the no data legend item. @default true */
+    show?: boolean
+
+    /** Text label for "no data" item. @default 'No data' */
+    text?: string
+}
+
+/**
+ * Configuration for sparkline map legends.
+ */
+export interface SparklineLegendConfig extends LegendConfig {
+    /** Configuration for the scale legend showing Y-axis range. */
+    scaleLegend?: Partial<SparklineScaleLegendConfig>
+
+    /** Optional categorical color legend for spark colors. */
+    colorLegend?: Partial<SparklineColorLegendConfig> | false
+
+    /** Configuration for the no data legend. Set to false to hide. */
+    noDataLegend?: Partial<SparklineNoDataLegendConfig> | false
+}

package/build/types/legend/composition/StripeCompositionLegendConfig.d.ts

@@ -0,0 +1,11 @@
+import { LegendConfig } from '../LegendConfig'
+
+/**
+ * Configuration for stripe composition map legends.
+ * Used to display a legend with colored rectangles representing different categories
+ * in stripe composition maps (regions divided into colored stripes showing composition).
+ */
+export interface StripeCompositionLegendConfig extends LegendConfig {
+    // Inherits all properties from LegendConfig
+    // No additional specific properties beyond the base legend configuration
+}

package/build/types/legend/composition/WaffleLegendConfig.d.ts

@@ -0,0 +1,74 @@
+import { LegendConfig } from '../LegendConfig'
+
+/**
+ * Configuration for size legend in waffle chart maps.
+ */
+export interface WaffleSizeLegendConfig {
+    /** Title for the size legend. */
+    title?: string | null
+
+    /** Padding between title and legend content in pixels. @default 10 */
+    titlePadding?: number
+
+    /** Custom values to display in the size legend. If not specified, values are auto-generated. */
+    values?: number[] | null
+
+    /** Custom formatter function for legend labels. */
+    labelFormatter?: ((value: number) => string) | undefined
+
+    /** Simplified grid size for size legend examples (e.g., 5 means 5x5 = 25 cells). @default 5 */
+    gridSize?: number
+
+    /** Padding between cells in size legend in pixels. @default 0.5 */
+    cellPadding?: number
+
+    /** Whether to show a "no data" item. @default false */
+    noData?: boolean
+
+    /** Text label for "no data" item. @default 'No data' */
+    noDataText?: string
+}
+
+/**
+ * Configuration for color legend in waffle chart maps.
+ */
+export interface WaffleColorLegendConfig {
+    /** Title for the color legend. */
+    title?: string | null
+
+    /** Padding between title and legend content in pixels. @default 10 */
+    titlePadding?: number
+
+    /** Top margin (distance from size legend) in pixels. @default 33 */
+    marginTop?: number
+
+    /** Offset adjustments for labels. @default { x: 5, y: 5 } */
+    labelOffsets?: { x: number; y: number }
+
+    /** Width of color swatches in pixels. @default 25 */
+    shapeWidth?: number
+
+    /** Height of color swatches in pixels. @default 20 */
+    shapeHeight?: number
+
+    /** Padding between swatches in pixels. @default 1 */
+    shapePadding?: number
+
+    /** Whether to show a "no data" item. @default true */
+    noData?: boolean
+
+    /** Text label for "no data" item. @default 'No data' */
+    noDataText?: string
+}
+
+/**
+ * Configuration for waffle chart map legends.
+ * Waffle charts display data as grids of small squares, with colors representing categories.
+ */
+export interface WaffleLegendConfig extends LegendConfig {
+    /** Configuration for the waffle size legend. */
+    sizeLegend?: Partial<WaffleSizeLegendConfig>
+
+    /** Configuration for the color/category legend. Set to false to hide. */
+    colorLegend?: Partial<WaffleColorLegendConfig> | false
+}

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

@@ -4,12 +4,20 @@ import type { MapConfig } from '../../core/MapConfig'
  * Configuration for bivariate choropleth maps.
  */
 export interface BivariateChoroplethConfig extends MapConfig {
+    /** 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

@@ -4,26 +4,32 @@ import { MapConfig } from '../../core/MapConfig'
  * Configuration specific to choropleth maps
  */
 export interface ChoroplethConfig extends MapConfig {
-    // Classification
+    /** 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

@@ -4,15 +4,25 @@ import type { MapConfig } from '../../core/MapConfig'
  * Configuration for trivariate choropleth maps.
  */
 export interface TrivariateChoroplethConfig extends MapConfig {
+    /** 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>>>
 }