eurostat-map 4.4.5 → 4.6.0

package/build/types/legend/choropleth/BivariateLegendConfig.d.ts

@@ -56,4 +56,83 @@ export interface BivariateLegendConfig extends LegendConfig {
 
     /** Padding between arrow and axis label in pixels. @default 10 */
     arrowPadding?: number
+
+    /**
+     * Labels displayed at low/high ends of each axis.
+     * @default { x: { low: 'Low', high: 'High' }, y: { low: 'Low', high: 'High' } }
+     */
+    axisExtremes?: {
+        x?: { low?: string; high?: string }
+        y?: { low?: string; high?: string }
+    }
+
+    /** Whether to show low/high endpoint labels on both axes. @default true */
+    showAxisExtremes?: boolean
+
+    /**
+     * Optional text annotations for each corner of the bivariate square.
+     * Add text for any combination of topRight, bottomRight, bottomLeft, topLeft.
+     * Supports line breaks using '<br>'/'<br/>' or '\\n'.
+     */
+    annotations?: {
+        topRight?: string
+        bottomRight?: string
+        bottomLeft?: string
+        topLeft?: string
+    }
+
+    /**
+     * Length of corner annotation callout lines in pixels.
+     * Can be a single number for all corners, or per-corner values.
+     * @default 18
+     */
+    annotationLineLength?:
+        | number
+        | {
+              topRight?: number
+              bottomRight?: number
+              bottomLeft?: number
+              topLeft?: number
+          }
+
+    /**
+     * Annotation text offsets in pixels.
+     * Use global `{ x, y }` or per-corner values.
+     * @default auto (based on corner direction)
+     */
+    annotationOffsets?:
+        | { x?: number; y?: number }
+        | {
+              topRight?: { x?: number; y?: number }
+              bottomRight?: { x?: number; y?: number }
+              bottomLeft?: { x?: number; y?: number }
+              topLeft?: { x?: number; y?: number }
+          }
+
+    /**
+     * Extra offset applied to the leader-line endpoint where it meets the annotation label.
+     * Use global `{ x, y }` or per-corner values.
+     * @default { x: 0, y: 0 }
+     */
+    annotationLineEndOffset?:
+        | { x?: number; y?: number }
+        | {
+              topRight?: { x?: number; y?: number }
+              bottomRight?: { x?: number; y?: number }
+              bottomLeft?: { x?: number; y?: number }
+              topLeft?: { x?: number; y?: number }
+          }
+
+    /**
+     * @deprecated Use annotationOffsets instead.
+     * Radial padding between corner annotation callout line end and text in pixels.
+     */
+    annotationPadding?:
+        | number
+        | {
+              topRight?: number
+              bottomRight?: number
+              bottomLeft?: number
+              topLeft?: number
+          }
 }

package/build/types/legend/choropleth/legend-choropleth-bivariate.d.ts

@@ -1,2 +1,2 @@
-/** Creates a bivariate choropleth legend */
-export function legend(config?: any): any
+/** Creates a bivariate choropleth legend */
+export function legend(config?: any): any

package/build/types/legend/choropleth/legend-choropleth-trivariate.d.ts

@@ -1,2 +1,2 @@
-/** Creates a trivariate choropleth legend */
-export function legend(config?: any): any
+/** Creates a trivariate choropleth legend */
+export function legend(config?: any): any

package/build/types/legend/choropleth/legend-choropleth.d.ts

@@ -1,2 +1,2 @@
-/** Creates a choropleth legend */
-export function legend(config?: any): any
+/** Creates a choropleth legend */
+export function legend(config?: any): any

package/build/types/legend/composition/legend-bar-chart.d.ts

@@ -1,2 +1,2 @@
-/** Creates a bar chart legend */
-export function legend(config?: any): any
+/** Creates a bar chart legend */
+export function legend(config?: any): any

package/build/types/legend/flow/legend-flow.d.ts

@@ -1,2 +1,2 @@
-/** Creates a flow map legend */
-export function legend(config?: any): any
+/** Creates a flow map legend */
+export function legend(config?: any): any

package/build/types/legend/legend-categorical.d.ts

@@ -1,2 +1,2 @@
-/** Creates a categorical legend */
-export function legend(config?: any): any
+/** Creates a categorical legend */
+export function legend(config?: any): any

package/build/types/legend/legend-continuous.d.ts

@@ -1,2 +1,2 @@
-/** Creates a continuous legend */
-export function legend(config?: any): any
+/** Creates a continuous legend */
+export function legend(config?: any): any

package/build/types/legend/legend-discrete.d.ts

@@ -1,2 +1,2 @@
-/** Creates a discrete legend */
-export function legend(config?: any): any
+/** Creates a discrete legend */
+export function legend(config?: any): any

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

@@ -1,13 +1,13 @@
-import type { MapInstance } from '../core/MapInstance'
-
-/** Base legend configuration */
-export interface LegendConfig {
-  title?: string
-  titleFontSize?: number
-  labelFontSize?: number
-  labelDelimiter?: string
-  noDataText?: string
-}
-
-/** Creates a legend instance */
-export function legend(config?: LegendConfig): any
+import type { MapInstance } from '../core/MapInstance'
+
+/** Base legend configuration */
+export interface LegendConfig {
+  title?: string
+  titleFontSize?: number
+  labelFontSize?: number
+  labelDelimiter?: string
+  noDataText?: string
+}
+
+/** Creates a legend instance */
+export function legend(config?: LegendConfig): any

package/build/types/legend/proportional-symbol/ProportionalSymbolsLegendConfig.d.ts

@@ -7,6 +7,9 @@ export interface ProportionalSymbolSizeLegendConfig {
     /** Title for the size legend. */
     title?: string | null
 
+    /** Subtitle displayed below the title. */
+    subtitle?: string | null
+
     /** Padding between title and legend content in pixels. @default 15 */
     titlePadding?: number
 
@@ -57,6 +60,9 @@ export interface ProportionalSymbolColorLegendConfig {
     /** Title for the color legend. */
     title?: string | null
 
+    /** Subtitle displayed below the title. */
+    subtitle?: string | null
+
     /** Padding between title and legend content in pixels. @default 10 */
     titlePadding?: number
 

package/build/types/legend/proportional-symbol/legend-proportional-symbols.d.ts

@@ -1,2 +1,2 @@
-/** Creates a proportional symbols legend */
-export function legend(config?: any): any
+/** Creates a proportional symbols legend */
+export function legend(config?: any): any

package/build/types/map-types/CategoricalMapConfig.d.ts

@@ -1,11 +1,11 @@
-import type { MapConfig } from '../core/MapConfig'
-
-/**
- * Configuration for categorical map
- */
-export interface CategoricalMapConfig extends MapConfig {
-    /** Category-to-color mapping */
-    classToFillStyle?: Record<string, string>
-    /** Fill style for regions with no data */
-    noDataFillStyle?: string
-}
+import type { MapConfig } from '../core/MapConfig'
+
+/**
+ * Configuration for categorical map
+ */
+export interface CategoricalMapConfig extends MapConfig {
+    /** Category-to-color mapping */
+    classToFillStyle?: Record<string, string>
+    /** Fill style for regions with no data */
+    noDataFillStyle?: string
+}

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

@@ -1,4 +1,4 @@
-import type { MapInstance } from '../../core/MapInstance'
-
-/** Creates a bivariate choropleth map instance */
-export function map(config?: any): MapInstance
+import type { MapInstance } from '../../core/MapInstance'
+
+/** Creates a bivariate choropleth map instance */
+export function map(config?: any): MapInstance

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

@@ -1,4 +1,4 @@
-import type { MapInstance } from '../../core/MapInstance'
-
-/** Creates a trivariate choropleth map instance */
-export function map(config?: any): MapInstance
+import type { MapInstance } from '../../core/MapInstance'
+
+/** Creates a trivariate choropleth map instance */
+export function map(config?: any): MapInstance

package/build/types/map-types/choropleth/map-value-by-alpha.d.ts

@@ -1,4 +1,4 @@
-import type { MapInstance } from '../../core/MapInstance'
-
-/** Creates a value-by-alpha map instance */
-export function map(config?: any): MapInstance
+import type { MapInstance } from '../../core/MapInstance'
+
+/** Creates a value-by-alpha map instance */
+export function map(config?: any): MapInstance

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

@@ -1,8 +1,15 @@
 /**
  * Statistical configuration for composition maps (pie, bar, waffle, stripe).
  *
+ * Preferred API:
+ * - `map.stat('composition', { ... })`
+ * - `map.encoding('composition', { stat: 'composition' })`
+ *
  * Either `eurostatDatasetCode` + `categoryParameter` (Eurostat API path)
  * or `customData` (custom data path) must be provided.
+ *
+ * Legacy positional signatures in `statPie/statWaffle/statBar/statStripe` and
+ * `map.stat('composition', config, categoryParameter, ...)` remain supported.
  */
 export interface CompositionStatConfig<TCustomData = Record<string, Record<string, number>>> {
     /**

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

@@ -1,79 +1,97 @@
-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 | false
-    legend(config: BarChartLegendConfig | false): this
-
-    barType(): 'stacked' | 'grouped'
-    barType(v: 'stacked' | 'grouped'): this
-
-    catColors(): any
-    catColors(v: any): this
-
-    catLabels(): any
-    catLabels(v: any): this
-
-    showOnlyWhenComplete(): boolean
-    showOnlyWhenComplete(v: boolean): this
-
-    noDataFillStyle(): string
-    noDataFillStyle(v: string): this
-
-    barMaxWidth(): number
-    barMaxWidth(v: number): this
-
-    barMinWidth(): number
-    barMinWidth(v: number): this
-
-    barHeight(): number
-    barHeight(v: number): this
-
-    barGroupWidth(): number
-    barGroupWidth(v: number): this
-
-    barGroupGap(): number
-    barGroupGap(v: number): this
-
-    barGroupMinHeight(): number
-    barGroupMinHeight(v: number): this
-
-    barGroupMaxHeight(): number
-    barGroupMaxHeight(v: number): this
-
-    barStrokeFill(): string
-    barStrokeFill(v: string): this
-
-    barStrokeWidth(): number
-    barStrokeWidth(v: number): this
-
-    barCornerRadius(): number
-    barCornerRadius(v: number): this
-
-    barOtherColor(): string
-    barOtherColor(v: string): this
-
-    barOtherText(): string
-    barOtherText(v: string): this
-
-    barTooltipWidth(): number
-    barTooltipWidth(v: number): this
-
-    barTooltipHeight(): number
-    barTooltipHeight(v: number): this
-
-    dorling(): boolean
-    dorling(v: boolean): this
-
-    barTotalCode(): string | undefined
-    barTotalCode(v: string | undefined): this
-
-    statCodes(): string[] | undefined
-    statCodes(v: string[] | undefined): this
-
-    statBar(config: CompositionStatConfig): this
-}
+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 | false
+    legend(config: BarChartLegendConfig | false): this
+
+    barType(): 'stacked' | 'grouped'
+    barType(v: 'stacked' | 'grouped'): this
+
+    catColors(): any
+    catColors(v: any): this
+
+    catLabels(): any
+    catLabels(v: any): this
+
+    showOnlyWhenComplete(): boolean
+    showOnlyWhenComplete(v: boolean): this
+
+    noDataFillStyle(): string
+    noDataFillStyle(v: string): this
+
+    barMaxWidth(): number
+    barMaxWidth(v: number): this
+
+    barMinWidth(): number
+    barMinWidth(v: number): this
+
+    barHeight(): number
+    barHeight(v: number): this
+
+    barGroupWidth(): number
+    barGroupWidth(v: number): this
+
+    barSettings(): any
+    barSettings(v: any): this
+
+    barGroupGap(): number
+    barGroupGap(v: number): this
+
+    barGroupMinHeight(): number
+    barGroupMinHeight(v: number): this
+
+    barGroupMaxHeight(): number
+    barGroupMaxHeight(v: number): this
+
+    barStrokeFill(): string
+    barStrokeFill(v: string): this
+
+    barStrokeWidth(): number
+    barStrokeWidth(v: number): this
+
+    barCornerRadius(): number
+    barCornerRadius(v: number): this
+
+    barOtherColor(): string
+    barOtherColor(v: string): this
+
+    barOtherText(): string
+    barOtherText(v: string): this
+
+    barTooltipWidth(): number
+    barTooltipWidth(v: number): this
+
+    barTooltipHeight(): number
+    barTooltipHeight(v: number): this
+
+    dorling(): boolean
+    dorling(v: boolean): this
+
+    barTotalCode(): string | undefined
+    barTotalCode(v: string | undefined): this
+
+    statCodes(): string[] | undefined
+    statCodes(v: string[] | undefined): this
+
+    statBar(config: CompositionStatConfig): this
+    /** @deprecated Legacy positional signature. Prefer statBar({ categoryParameter, categoryCodes, ... }). */
+    statBar(
+        /** 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/bar/BarMapConfig.d.ts

@@ -1,54 +1,76 @@
-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
-    /** Bar total code. */
-    barTotalCode?: string
-    /** Stat codes. */
-    statCodes?: string[]
-    /** Legend. */
-    legend?: BarChartLegendConfig | false
-}
+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
+    /** Grouped bar settings object. */
+    barSettings?: {
+        type?: 'stacked' | 'grouped'
+        minWidth?: number
+        maxWidth?: number
+        height?: number
+        groupWidth?: number
+        groupMinWidth?: number
+        groupMaxWidth?: number
+        groupGap?: number
+        groupMinHeight?: number
+        groupMaxHeight?: number
+        groupMaxValue?: number
+        groupMaxWidthValue?: number
+        strokeFill?: string
+        strokeWidth?: number
+        cornerRadius?: number
+        otherColor?: string
+        otherText?: string
+        tooltipWidth?: number
+        tooltipHeight?: 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
+    /** Bar total code. */
+    barTotalCode?: string
+    /** Stat codes. */
+    statCodes?: string[]
+    /** Legend. */
+    legend?: BarChartLegendConfig | false
+}

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

@@ -9,6 +9,23 @@ export interface CoxcombMap extends MapInstance {
     legend(): CoxcombLegendConfig | false
     legend(config: CoxcombLegendConfig | false): this
 
+    coxcombSettings(): {
+        minRadius: number
+        maxRadius: number
+        strokeFill: string
+        strokeWidth: number
+        rings: boolean
+        offsets: { x: number; y: number }
+    }
+    coxcombSettings(v: {
+        minRadius?: number
+        maxRadius?: number
+        strokeFill?: string
+        strokeWidth?: number
+        rings?: boolean
+        offsets?: { x: number; y: number }
+    }): this
+
     catColors(): any
     catColors(v: any): this
 
@@ -18,19 +35,29 @@ export interface CoxcombMap extends MapInstance {
     noDataFillStyle(): string
     noDataFillStyle(v: string): this
 
+    /** @deprecated Use coxcombSettings({ maxRadius }) */
     coxcombMaxRadius(): number
+    /** @deprecated Use coxcombSettings({ maxRadius }) */
     coxcombMaxRadius(v: number): this
 
+    /** @deprecated Use coxcombSettings({ minRadius }) */
     coxcombMinRadius(): number
+    /** @deprecated Use coxcombSettings({ minRadius }) */
     coxcombMinRadius(v: number): this
 
+    /** @deprecated Use coxcombSettings({ rings }) */
     coxcombRings(): boolean
+    /** @deprecated Use coxcombSettings({ rings }) */
     coxcombRings(v: boolean): this
 
+    /** @deprecated Use coxcombSettings({ strokeFill }) */
     coxcombStrokeFill(): string
+    /** @deprecated Use coxcombSettings({ strokeFill }) */
     coxcombStrokeFill(v: string): this
 
+    /** @deprecated Use coxcombSettings({ strokeWidth }) */
     coxcombStrokeWidth(): number
+    /** @deprecated Use coxcombSettings({ strokeWidth }) */
     coxcombStrokeWidth(v: number): this
 
     hoverColor(): string
@@ -39,7 +66,9 @@ export interface CoxcombMap extends MapInstance {
     classifierSize(): any
     classifierSize(v: any): this
 
+    /** @deprecated Use coxcombSettings({ offsets }) */
     coxcombOffsets(): { x: number; y: number }
+    /** @deprecated Use coxcombSettings({ offsets }) */
     coxcombOffsets(v: { x: number; y: number }): this
 
     statCoxcomb(config: CoxcombStatConfig): this

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

@@ -5,16 +5,31 @@ import type { CoxcombLegendConfig } from '../../../legend/composition/CoxcombLeg
  * Configuration for coxcomb (polar area) chart maps.
  */
 export interface CoxcombMapConfig extends MapConfig {
+    /** Grouped coxcomb settings. */
+    coxcombSettings?: {
+        minRadius?: number
+        maxRadius?: number
+        strokeFill?: string
+        strokeWidth?: number
+        rings?: boolean
+        offsets?: { x: number; y: number }
+    }
+    /** @deprecated Use coxcombSettings.minRadius */
     /** Coxcomb min radius. */
     coxcombMinRadius?: number
+    /** @deprecated Use coxcombSettings.maxRadius */
     /** Coxcomb max radius. */
     coxcombMaxRadius?: number
+    /** @deprecated Use coxcombSettings.strokeFill */
     /** Coxcomb stroke fill. */
     coxcombStrokeFill?: string
+    /** @deprecated Use coxcombSettings.strokeWidth */
     /** Coxcomb stroke width. */
     coxcombStrokeWidth?: number
+    /** @deprecated Use coxcombSettings.rings */
     /** Coxcomb rings. */
     coxcombRings?: boolean
+    /** @deprecated Use coxcombSettings.offsets */
     /** Coxcomb offsets. */
     coxcombOffsets?: { x: number; y: number }
     /** Hover color. */