eurostat-map 4.4.0 → 4.4.2

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

@@ -101,10 +101,14 @@ export const flags: Record<string, string>
  * Executes a function for all insets recursively.
  */
 export function executeForAllInsets(
+    /** Insets. */
     insets: any,
+    /** Main svg id. */
     mainSvgId: string,
     functionToExecute: (inset: MapInstance, ...args: any[]) => void,
+    /** Parameter. */
     parameter?: any,
+    /** Parameter2. */
     parameter2?: any
 ): void
 

package/build/types/index.d.ts

@@ -59,25 +59,35 @@ export type { TooltipConfig } from './core/TooltipConfig'
 export type { LegendConfig } from './legend/LegendConfig'
 export type { StatConfig } from './core/stat/StatConfig'
 export type { InsetConfig } from './core/InsetConfig'
+export type { CoastalMarginSettings } from './core/decoration/CoastalMarginSettings'
+export type { GridCartogramSettings, GridCartogramMargins } from './core/GridCartogramSettings'
+export type { DorlingSettings, DorlingStrength } from './core/DorlingSettings'
 
 // ==================== Legend Configuration Type Exports ====================
 
 // Main legend types
 export type { CategoricalLegendConfig } from './legend/CategoricalLegendConfig'
-export type { CoxcombLegendConfig } from './legend/CoxcombLegendConfig'
 export type { MushroomLegendConfig } from './legend/MushroomLegendConfig'
-export type { PieChartLegendConfig } from './legend/PieChartLegendConfig'
-export type { SparklineLegendConfig } from './legend/SparklineLegendConfig'
-export type { WaffleLegendConfig } from './legend/WaffleLegendConfig'
-export type { StripeCompositionLegendConfig } from './legend/StripeCompositionLegendConfig'
 export type { PatternFillLegendConfig } from './legend/PatternFillLegendConfig'
 
 // Choropleth legend types
+export type { ChoroplethLegendConfig } from './legend/choropleth/ChoroplethLegendConfig'
 export type { BivariateLegendConfig } from './legend/choropleth/BivariateLegendConfig'
 export type { HistogramLegendConfig } from './legend/choropleth/HistogramLegendConfig'
+export type { TrivariateLegendConfig } from './legend/choropleth/TrivariateLegendConfig'
 
 // Composition legend types
 export type { BarChartLegendConfig } from './legend/composition/BarChartLegendConfig'
+export type { CoxcombLegendConfig } from './legend/composition/CoxcombLegendConfig'
+export type { PieChartLegendConfig } from './legend/composition/PieChartLegendConfig'
+export type { WaffleLegendConfig } from './legend/composition/WaffleLegendConfig'
+export type { StripeCompositionLegendConfig } from './legend/composition/StripeCompositionLegendConfig'
+export type {
+    SparklineLegendConfig,
+    SparklineScaleLegendConfig,
+    SparklineColorLegendConfig,
+    SparklineNoDataLegendConfig,
+} from './legend/composition/SparklineLegendConfig'
 
 // Flow legend types
 export type { FlowMapLegendConfig } from './legend/flow/FlowMapLegendConfig'
@@ -133,11 +143,17 @@ export type { FlowMapConfig, FlowMap }
  * Options for fill pattern definitions
  */
 export interface FillPatternOptions {
+    /** Shape. */
     shape?: 'circle' | 'square'
+    /** Pattern size. */
     patternSize?: number
+    /** Min size. */
     minSize?: number
+    /** Max size. */
     maxSize?: number
+    /** Bck color. */
     bckColor?: string
+    /** Symb color. */
     symbColor?: string
 }
 
@@ -187,15 +203,10 @@ export function map(type: MapType, config?: MapConfig): MapInstance
  */
 export function getFillPatternDefinitionFunction(opts?: FillPatternOptions): (svg: any, numberOfClasses: number) => void
 
-/**
- * @deprecated Use getFillPatternDefinitionFunction instead
- */
-export function getFillPatternDefinitionFun(opts?: FillPatternOptions): (svg: any, numberOfClasses: number) => void
-
 /**
  * Get default labels for the map
  */
-export function getDefaultLabels(): { [key: string]: string }
+export function getDefaultLabels(): { [key: string]: any }
 
 /**
  * Project coordinates from map pixel space to geographic coordinates
@@ -225,12 +236,17 @@ export const version: string
 // ==================== Default Export ====================
 
 declare const eurostatmap: {
+    /** Map. */
     map: typeof map
+    /** Get fill pattern definition function. */
     getFillPatternDefinitionFunction: typeof getFillPatternDefinitionFunction
-    getFillPatternDefinitionFun: typeof getFillPatternDefinitionFun
+    /** Get default labels. */
     getDefaultLabels: typeof getDefaultLabels
+    /** Project from map. */
     projectFromMap: typeof projectFromMap
+    /** Project to map. */
     projectToMap: typeof projectToMap
+    /** Version. */
     version: typeof version
 }
 

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

@@ -2,42 +2,67 @@
  * Parent configuration for map legends. Each map type will extend this with its own specific properties, but these are the common ones that apply to all legend types.
  */
 export interface LegendConfig {
+    /** Legend origin x-coordinate in pixels. */
     x?: number
+    /** Legend origin y-coordinate in pixels. */
     y?: number
+    /** Legend width in pixels. */
     width?: number
+    /** Legend height in pixels. */
     height?: number
 
+    /** Legend title text. */
     title?: string
-    titleWidth?: number
+    /** Legend subtitle text. */
+    subtitle?: string
+    /** Legend title font size in pixels. */
     titleFontSize?: number
 
-    // Box styling
-    boxWidth?: number
-    boxHeight?: number
+    /** Box styling. */
+    /** Inner spacing around legend content. */
     boxPadding?: number
-    boxCornerRadius?: number
+    /** Background opacity of the legend box. */
+    boxOpacity?: number
+    /** Padding between the title block and legend body. */
+    titlePadding?: number
 
-    // Shape styling (for proportional symbol legends)
+    /** Shape styling (for proportional symbol legends). */
+    /** Symbol swatch width in pixels. */
     shapeWidth?: number
+    /** Symbol swatch height in pixels. */
     shapeHeight?: number
+    /** Horizontal gap between shape and label. */
     shapePadding?: number
+    /** Length of separator lines in discrete legends. */
+    sepLineLength?: number
 
-    // Label styling
+    /** Label styling. */
+    /** Label font size in pixels. */
     labelFontSize?: number
-    labelOffset?: number
-    labelWrap?: number
-    labelDecimalPlaces?: number
+    /** Pixel offsets applied to labels. */
+    labelOffsets?: { x: number; y: number }
+    /** Custom formatter for legend labels. */
+    labelFormatter?: ((value: number, index?: number) => string) | null
+    /** Number of decimal places for auto-formatted labels. */
+    decimals?: number
 
-    // Orientation
+    /** Legend layout direction. */
     orientation?: 'vertical' | 'horizontal'
+    /** Sort legend entries in ascending order when true. */
     ascending?: boolean
-
-    // Cells (for manual legend specification)
-    cells?: any[]
-
-    // No data label
+    /** Whether to display the no-data legend item. */
     noData?: boolean
+    /** Label used for no-data legend item. */
     noDataText?: string
+    /** Vertical gap before the no-data swatch in pixels. */
+    noDataPadding?: number
+    /** Width of the no-data swatch in pixels. */
+    noDataShapeWidth?: number
+    /** Height of the no-data swatch in pixels. */
+    noDataShapeHeight?: number
 
-    [key: string]: any
+    /** Whether to show dataset min/max labels when supported. */
+    maxMin?: boolean
+    /** Text affixes for min/max labels as [minSuffix, maxSuffix]. */
+    maxMinLabels?: [string, string]
 }

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/choropleth/ChoroplethLegendConfig.d.ts

@@ -0,0 +1,80 @@
+import type { LegendConfig } from '../LegendConfig'
+import type { HistogramLegendConfig } from './HistogramLegendConfig'
+
+/**
+ * Configuration for choropleth map legends.
+ * Supports discrete, continuous, diverging, and histogram legend variants.
+ */
+export interface ChoroplethLegendConfig extends LegendConfig {
+    /** Padding between the legend title and the legend body in pixels. @default 5 */
+    titlePadding?: number
+
+    /** Label style for discrete legends. @default 'thresholds' */
+    labelType?: 'thresholds' | 'ranges'
+
+    /** Length of the separator line in pixels for discrete legends. @default shapeWidth */
+    sepLineLength?: number
+
+    /** Length of threshold tick marks in pixels. @default 4 */
+    tickLength?: number
+
+    /** Number of decimal places for auto-formatted labels. Auto-detected when undefined. */
+    decimals?: number
+
+    /** Offset adjustments for labels. @default { x: 3, y: 0 } */
+    labelOffsets?: { x: number; y: number }
+
+    /** Custom formatter for legend labels. */
+    labelFormatter?: ((value: number, classIndex?: number) => string) | null
+
+    /** User-defined labels for classes in discrete legends. */
+    labels?: string[] | null
+
+    /** Histogram legend configuration. Set to null/undefined to disable histogram mode. */
+    histogram?: Partial<HistogramLegendConfig> | null
+
+    /** Label shown at the divergence point for diverging legends. */
+    pointOfDivergenceLabel?: string
+
+    /** Class index/value position used for diverging legends. */
+    pointOfDivergence?: number
+
+    /** Extra padding around the divergence marker in pixels. @default 7 */
+    pointOfDivergencePadding?: number
+
+    /** Explicit diverging guide line length in pixels. */
+    divergingLineLength?: number
+
+    /** Explicit diverging arrow length in pixels. */
+    divergingArrowLength?: number
+
+    /** Label shown at the low end of continuous legends. @default 'Low' */
+    lowLabel?: string
+
+    /** Label shown at the high end of continuous legends. @default 'High' */
+    highLabel?: string
+
+    /** Number of ticks to show on continuous legends. Use 0 to disable. @default 0 */
+    ticks?: number
+
+    /** Explicit tick values for continuous legends. */
+    tickValues?: number[]
+
+    /** Explicit tick labels for continuous legends. */
+    tickLabels?: Array<string | number>
+
+    /** Pixel tolerance used when hovering continuous legends to highlight nearby regions. @default 10 */
+    highlightTolerance?: number
+
+    /** Whether to show dataset min/max labels where supported. @default true */
+    maxMin?: boolean
+
+    /** Text affixes for min/max labels as [minSuffix, maxSuffix]. @default ['', ''] */
+    maxMinLabels?: [string, string]
+
+    /** Length of min/max tick marks in pixels. Defaults to tickLength when omitted. */
+    maxMinTickLength?: number
+
+    /** Whether to append region names to min/max labels. */
+    maxMinRegionLabels?: boolean
+}

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
+}