eurostat-map 4.4.5 → 4.6.0

package/build/types/layers/choropleth/ChoroplethConfig.d.ts

@@ -0,0 +1,39 @@
+import { MapConfig } from '../../core/MapConfig'
+import type { ChoroplethLegendConfig } from '../../legend/choropleth/ChoroplethLegendConfig'
+
+/**
+ * Configuration specific to choropleth maps
+ */
+export interface ChoroplethConfig extends MapConfig {
+    /** 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?: string[]
+    colorFunction?: (t: number) => string
+    /** Color scheme type. */
+    colorSchemeType?: 'discrete' | 'continuous'
+    /** Class to fill style. */
+    classToFillStyle?: { [classIndex: number]: string }
+
+    /** No-data styling. */
+    noDataFillStyle?: string
+
+    /** Value transformation (for continuous schemes). */
+    valueTransform?: (x: number) => number
+    valueUntransform?: (x: number) => number
+    /** Skip normalization. */
+    skipNormalization?: boolean
+
+    /** Diverging schemes. */
+    pointOfDivergence?: number
+}

package/build/types/layers/choropleth/ChoroplethMap.d.ts

@@ -0,0 +1,48 @@
+import { MapInstance } from '../../core/MapInstance'
+
+/**
+ * Choropleth map object
+ */
+export interface ChoroplethMap extends MapInstance {
+    numberOfClasses(): number
+    numberOfClasses(n: number): this
+
+    classificationMethod(): string
+    classificationMethod(method: 'quantile' | 'ckmeans' | 'jenks' | 'equinter' | 'threshold'): this
+
+    thresholds(): number[]
+    thresholds(t: number[]): this
+
+    colors(): string[]
+    colors(c: string[]): this
+
+    colorFunction(): (t: number) => string
+    colorFunction(fn: (t: number) => string): this
+
+    makeClassifNice(): boolean
+    makeClassifNice(v: boolean): this
+
+    classToFillStyle(): any
+    classToFillStyle(v: any): this
+
+    classifier(): any
+    classifier(v: any): this
+
+    colorSchemeType(): string
+    colorSchemeType(type: 'discrete' | 'continuous'): this
+
+    valueTransform(): (x: number) => number
+    valueTransform(v: (x: number) => number): this
+
+    valueUntransform(): (x: number) => number
+    valueUntransform(v: (x: number) => number): this
+
+    pointOfDivergence(): number | null
+    pointOfDivergence(v: number | null): this
+
+    skipNormalization(): boolean
+    skipNormalization(v: boolean): this
+
+    noDataFillStyle(): string
+    noDataFillStyle(style: string): this
+}

package/build/types/layers/choropleth/TrivariateChoroplethConfig.d.ts

@@ -0,0 +1,41 @@
+import type { MapConfig } from '../../core/MapConfig'
+import type { TrivariateLegendConfig } from '../../legend/choropleth/TrivariateLegendConfig'
+
+/**
+ * Ternary color settings for trivariate choropleth maps.
+ */
+export interface TrivariateTernarySettings {
+    /** Use sextant color mapping instead of continuous tricolore. */
+    sextant?: boolean
+    /** Array of 6 colors used when sextant mode is enabled. */
+    sextantColors?: [string, string, string, string, string, string]
+    /** Hue. */
+    hue?: number
+    /** Chroma. */
+    chroma?: number
+    /** Lightness. */
+    lightness?: number
+    /** Contrast. */
+    contrast?: number
+    /** Spread. */
+    spread?: number
+    /** Breaks. */
+    breaks?: number
+    /** Mean centering. */
+    meanCentering?: boolean
+}
+
+/**
+ * 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?: TrivariateTernarySettings
+}

package/build/types/layers/choropleth/TrivariateChoroplethMap.d.ts

@@ -0,0 +1,18 @@
+import type { MapInstance } from '../../core/MapInstance'
+import type { TrivariateChoroplethConfig, TrivariateTernarySettings } from './TrivariateChoroplethConfig'
+
+type TernarySettings = TrivariateTernarySettings
+
+/**
+ * Trivariate choropleth map type.
+ */
+export interface TrivariateChoroplethMap extends MapInstance {
+    ternaryCodes(): string[]
+    ternaryCodes(v: string[]): this
+
+    noDataFillStyle(): string
+    noDataFillStyle(v: string): this
+
+    ternarySettings(): TernarySettings
+    ternarySettings(v: Partial<TernarySettings>): this
+}

package/build/types/layers/choropleth/ValueByAlphaConfig.d.ts

@@ -0,0 +1,8 @@
+import type { ChoroplethConfig } from './ChoroplethConfig'
+
+/**
+ * Configuration for value-by-alpha choropleth maps.
+ */
+export interface ValueByAlphaConfig extends ChoroplethConfig {
+    opacityScale?: (value: number) => number
+}

package/build/types/layers/choropleth/ValueByAlphaMap.d.ts

@@ -0,0 +1,9 @@
+import type { MapInstance } from '../../core/MapInstance'
+
+/**
+ * Value-by-alpha choropleth map type.
+ */
+export interface ValueByAlphaMap extends MapInstance {
+    opacityScale(): ((value: number) => number) | null
+    opacityScale(v: ((value: number) => number) | null): this
+}

package/build/types/layers/composition/CompositionStatConfig.d.ts

@@ -0,0 +1,59 @@
+/**
+ * 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>>> {
+    /**
+     * 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>
+    /** Unit text. */
+    unitText?: string
+    preprocess?: (regionId: string, value: any) => any
+    transform?: (value: number) => number
+
+    /** Category parameter. Required when not using `customData`. */
+    categoryParameter?: string
+    /** Category codes. */
+    categoryCodes?: string[]
+    /** Category labels. */
+    categoryLabels?: string[]
+    /** Category colors. */
+    categoryColors?: string[]
+    /** Total code. */
+    totalCode?: string
+
+    /** Legacy nested API supported by buildStatCompositionMethod. */
+    stat?: {
+        /** Eurostat dataset code. */
+        eurostatDatasetCode?: string
+        /** Filters. */
+        filters?: Record<string, any>
+        /** Unit text. */
+        unitText?: string
+        preprocess?: (regionId: string, value: any) => any
+        transform?: (value: number) => number
+    }
+}

package/build/types/layers/composition/bar/BarMap.d.ts

@@ -0,0 +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
+
+    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/layers/composition/bar/BarMapConfig.d.ts

@@ -0,0 +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
+    /** 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/layers/composition/coxcomb/CoxcombMap.d.ts

@@ -0,0 +1,75 @@
+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 | 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
+
+    catLabels(): any
+    catLabels(v: any): this
+
+    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
+    hoverColor(v: string): this
+
+    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/layers/composition/coxcomb/CoxcombMapConfig.d.ts

@@ -0,0 +1,47 @@
+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 {
+    /** 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. */
+    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/layers/composition/coxcomb/CoxcombStatConfig.d.ts

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

package/build/types/layers/composition/pie/PieMap.d.ts

@@ -0,0 +1,84 @@
+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 | false
+    legend(config: PieChartLegendConfig | false): 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
+
+    compositionSettings(): {
+        type?: 'flag' | 'pie' | 'ring' | 'segment' | 'radar' | 'agepyramid' | 'halftone'
+        /** Radar wedge radius mode: share within symbol (default) or absolute values across map. */
+        radarValueMode?: 'share' | 'absolute'
+        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'
+        /** Radar wedge radius mode: share within symbol (default) or absolute values across map. */
+        radarValueMode?: 'share' | 'absolute'
+        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
+
+    compositionTotalCode(): string | undefined
+    compositionTotalCode(v: string | undefined): this
+
+    statCodes(): string[] | undefined
+    statCodes(v: string[] | undefined): this
+
+    statPie(config: CompositionStatConfig): this
+    /** @deprecated Legacy positional signature. Prefer statPie({ categoryParameter, categoryCodes, ... }). */
+    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/layers/composition/pie/PieMapConfig.d.ts

@@ -0,0 +1,50 @@
+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-specific rendering settings. */
+    pieSettings?: {
+        innerRadius?: number
+    }
+    /** Consolidated composition symbol settings. */
+    compositionSettings?: {
+        type?: 'flag' | 'pie' | 'ring' | 'segment' | 'radar' | 'agepyramid' | 'halftone'
+        /** Radar wedge radius mode: share within symbol (default) or absolute values across map. */
+        radarValueMode?: 'share' | 'absolute'
+        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. */
+    tooltipPieInnerRadius?: 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
+    /** Dorling. */
+    dorling?: boolean
+    /** Total code used to compute optional 'other' composition share. */
+    compositionTotalCode?: string
+    /** Stat codes. */
+    statCodes?: string[]
+    /** Legend. */
+    legend?: PieChartLegendConfig | false
+}