eurostat-map 4.4.5 → 4.6.0

package/build/types/layers/flow/FlowMapConfig.d.ts

@@ -0,0 +1,220 @@
+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
+}
+
+/**
+ * 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
+}
+
+/**
+ * Graph input used by flow maps.
+ */
+export interface FlowGraph {
+    /** Nodes. */
+    nodes: FlowNode[]
+    /** Links. */
+    links: FlowLink[]
+}
+
+/**
+ * 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
+}
+
+/**
+ * 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
+}
+
+/**
+ * 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
+}
+
+/**
+ * Configuration for flow maps.
+ */
+export interface FlowMapConfig extends MapConfig {
+    /** Flow graph. */
+    flowGraph?: FlowGraph
+
+    /** Grouped flow settings object. */
+    flowSettings?: {
+        color?: string
+        regionColors?: string[]
+        regionLabels?: string[]
+        arrows?: boolean
+        arrowScale?: number
+        maxWidth?: number
+        minWidth?: number
+        outlines?: boolean
+        outlineWidth?: number
+        outlineColor?: string
+        colorGradient?: boolean
+        stack?: boolean
+        nodes?: boolean
+        nodeType?: 'circle' | 'donut'
+        labelOffsets?: { x?: number; y?: number }
+        lineType?: 'curved' | 'straight' | 'sankey'
+        nodeSizeScale?: (value: number) => number
+        opacity?: number
+        internal?: boolean
+        topLocations?: number
+        topLocationsType?: 'sum' | 'origin' | 'destination'
+        curvatureSettings?: FlowCurvatureSettings
+        order?: (a: any, b: any) => number
+        widthGradient?: boolean
+        opacityGradient?: boolean
+        widthGradientSettings?: FlowWidthGradientSettings
+        bidirectional?: boolean
+        edgeBundling?: boolean
+        bundleSettings?: FlowBundleSettings
+    }
+
+    /** @deprecated Use flowSettings.color */
+    /** Flow color. */
+    flowColor?: string
+    /** @deprecated Use flowSettings.regionColors */
+    /** Flow region colors. */
+    flowRegionColors?: string[]
+    /** @deprecated Use flowSettings.regionLabels */
+    /** Flow region labels. */
+    flowRegionLabels?: string[]
+    /** @deprecated Use flowSettings.arrows */
+    /** Flow arrows. */
+    flowArrows?: boolean
+    /** @deprecated Use flowSettings.arrowScale */
+    /** Flow arrow scale. */
+    flowArrowScale?: number
+    /** @deprecated Use flowSettings.maxWidth */
+    /** Flow max width. */
+    flowMaxWidth?: number
+    /** @deprecated Use flowSettings.minWidth */
+    /** Flow min width. */
+    flowMinWidth?: number
+    /** @deprecated Use flowSettings.outlines */
+    /** Flow outlines. */
+    flowOutlines?: boolean
+    /** @deprecated Use flowSettings.outlineWidth */
+    /** Flow outline width. */
+    flowOutlineWidth?: number
+    /** @deprecated Use flowSettings.outlineColor */
+    /** Flow outline color. */
+    flowOutlineColor?: string
+    /** @deprecated Use flowSettings.colorGradient */
+    /** Flow color gradient. */
+    flowColorGradient?: boolean
+    /** @deprecated Use flowSettings.stack */
+    /** Flow stack. */
+    flowStack?: boolean
+    /** @deprecated Use flowSettings.nodes */
+    /** Flow nodes. */
+    flowNodes?: boolean
+    /** @deprecated Use flowSettings.nodeType */
+    /** Flow node type. */
+    flowNodeType?: 'circle' | 'donut'
+    /** @deprecated Use flowSettings.labelOffsets */
+    /** Flow label offsets. */
+    flowLabelOffsets?: { x?: number; y?: number }
+    /** @deprecated Use flowSettings.lineType */
+    /** Flow line type. */
+    flowLineType?: 'curved' | 'straight' | 'sankey'
+    /** @deprecated Use flowSettings.nodeSizeScale */
+    flowNodeSizeScale?: (value: number) => number
+    /** @deprecated Use flowSettings.opacity */
+    /** Flow opacity. */
+    flowOpacity?: number
+    /** @deprecated Use flowSettings.internal */
+    /** Flow internal. */
+    flowInternal?: boolean
+    /** @deprecated Use flowSettings.topLocations */
+    /** Flow top locations. */
+    flowTopLocations?: number
+    /** @deprecated Use flowSettings.topLocationsType */
+    /** Flow top locations type. */
+    flowTopLocationsType?: 'sum' | 'origin' | 'destination'
+    /** @deprecated Use flowSettings.curvatureSettings */
+    /** Flow curvature settings. */
+    flowCurvatureSettings?: FlowCurvatureSettings
+    /** @deprecated Use flowSettings.order */
+    flowOrder?: (a: any, b: any) => number
+    /** @deprecated Use flowSettings.widthGradient */
+    /** Flow width gradient. */
+    flowWidthGradient?: boolean
+    /** @deprecated Use flowSettings.opacityGradient */
+    /** Flow opacity gradient. */
+    flowOpacityGradient?: boolean
+    /** @deprecated Use flowSettings.widthGradientSettings */
+    /** Flow width gradient settings. */
+    flowWidthGradientSettings?: FlowWidthGradientSettings
+    /** @deprecated Use flowSettings.bidirectional */
+    /** Flow bidirectional. */
+    flowBidirectional?: boolean
+    /** @deprecated Use flowSettings.edgeBundling */
+    /** Flow edge bundling. */
+    flowEdgeBundling?: boolean
+    /** @deprecated Use flowSettings.bundleSettings */
+    /** Flow bundle settings. */
+    flowBundleSettings?: FlowBundleSettings
+}

package/build/types/layers/proportional-symbol/ProportionalSymbolConfig.d.ts

@@ -0,0 +1,47 @@
+import type { MapConfig } from '../../core/MapConfig'
+
+export interface ProportionalSymbolSettings {
+    shape?: string
+    customShape?: any
+    customSVG?: any
+    spikeWidth?: number
+    offset?: { x: number; y: number }
+    barWidth?: number
+    minValue?: number | undefined
+    maxValue?: number | undefined
+    fill?: string
+    fillOpacity?: number
+    stroke?: string
+    strokeWidth?: number
+    strokeOpacity?: number
+    sizeScale?: 'sqrt' | 'linear' | any
+    minSize?: number
+    maxSize?: number
+    classes?: number
+    colors?: string[] | null
+    colorFun?: any
+    classToFillStyle?: any
+    thresholds?: number[]
+    classificationMethod?: string
+    brightenFactor?: number
+    codeLabels?: boolean
+}
+
+/**
+ * Configuration for proportional symbol maps
+ */
+export interface ProportionalSymbolConfig extends MapConfig {
+    /** Symbol shape used for markers. */
+    symbol?: 'circle' | 'square'
+    /** Base symbol size factor. */
+    size?: number
+
+    /** Dorling cartogram. */
+    dorling?: boolean
+
+    /** Size function. */
+    psCustomSize?: (value: number) => number
+
+    /** Grouped proportional symbol style settings. */
+    psSettings?: ProportionalSymbolSettings
+}

package/build/types/layers/proportional-symbol/ProportionalSymbolMap.d.ts

@@ -0,0 +1,94 @@
+import { MapInstance } from '../../core/MapInstance'
+import type { ProportionalSymbolSettings } from './ProportionalSymbolConfig'
+
+/**
+ * Proportional symbol map object
+ */
+export interface ProportionalSymbolMap extends MapInstance {
+    psSettings(): ProportionalSymbolSettings
+    psSettings(v: ProportionalSymbolSettings): this
+
+    psMaxSize(): number
+    psMaxSize(v: number): this
+
+    psMinSize(): number
+    psMinSize(v: number): this
+
+    psMaxValue(): number | undefined
+    psMaxValue(v: number | undefined): this
+
+    psMinValue(): number | undefined
+    psMinValue(v: number | undefined): this
+
+    psFill(): string
+    psFill(v: string): this
+
+    psFillOpacity(): number
+    psFillOpacity(v: number): this
+
+    psStrokeOpacity(): number
+    psStrokeOpacity(v: number): this
+
+    psStroke(): string
+    psStroke(v: string): this
+
+    psStrokeWidth(): number
+    psStrokeWidth(v: number): this
+
+    classifierSize(): any
+    classifierSize(v: any): this
+
+    classifierColor(): any
+    classifierColor(v: any): this
+
+    psShape(): string
+    psShape(v: string): this
+
+    psCustomShape(): any
+    psCustomShape(v: any): this
+
+    psBarWidth(): number
+    psBarWidth(v: number): this
+
+    psClassToFillStyle(): any
+    psClassToFillStyle(v: any): this
+
+    psColorFun(): any
+    psColorFun(v: any): this
+
+    psSizeScale(): any
+    psSizeScale(v: any): this
+
+    noDataFillStyle(): string
+    noDataFillStyle(v: string): this
+
+    psThresholds(): number[]
+    psThresholds(v: number[]): this
+
+    psColors(): string[] | null
+    psColors(v: string[] | null): this
+
+    psCustomSVG(): any
+    psCustomSVG(v: any): this
+
+    psOffset(): { x: number; y: number }
+    psOffset(v: { x: number; y: number }): this
+
+    psClassificationMethod(): string
+    psClassificationMethod(v: string): this
+
+    psClasses(): number
+    psClasses(v: number): this
+
+    dorling(): boolean
+    dorling(v: boolean): this
+
+    psSpikeWidth(): number
+    psSpikeWidth(v: number): this
+
+    psCodeLabels(): boolean
+    psCodeLabels(v: boolean): this
+
+    psBrightenFactor(): number
+    psBrightenFactor(v: number): this
+}

package/build/types/layers/proportional-symbol/mushroom/MushroomMap.d.ts

@@ -0,0 +1,67 @@
+import type { MapInstance } from '../../../core/MapInstance'
+
+/**
+ * Mushroom map type.
+ */
+export interface MushroomMap extends MapInstance {
+    mushroomSettings(): {
+        codes: [string, string]
+        minSize: number
+        maxSize: number
+        colors: [string, string]
+        orientation: 'horizontal' | 'vertical'
+        sizeScaleFunction: any
+        sizeScaleFunctionV1: any
+        sizeScaleFunctionV2: any
+    }
+    mushroomSettings(v: {
+        codes?: [string, string]
+        minSize?: number
+        maxSize?: number
+        colors?: [string, string]
+        orientation?: 'horizontal' | 'vertical'
+        sizeScaleFunction?: any
+        sizeScaleFunctionV1?: any
+        sizeScaleFunctionV2?: any
+    }): this
+
+    /** @deprecated Use mushroomSettings({ codes }) */
+    mushroomCodes(): [string, string]
+    /** @deprecated Use mushroomSettings({ codes }) */
+    mushroomCodes(v: [string, string]): this
+
+    /** @deprecated Use mushroomSettings({ minSize }) */
+    mushroomMinSize(): number
+    /** @deprecated Use mushroomSettings({ minSize }) */
+    mushroomMinSize(v: number): this
+
+    /** @deprecated Use mushroomSettings({ maxSize }) */
+    mushroomMaxSize(): number
+    /** @deprecated Use mushroomSettings({ maxSize }) */
+    mushroomMaxSize(v: number): this
+
+    /** @deprecated Use mushroomSettings({ colors }) */
+    mushroomColors(): [string, string]
+    /** @deprecated Use mushroomSettings({ colors }) */
+    mushroomColors(v: [string, string]): this
+
+    /** @deprecated Use mushroomSettings({ orientation }) */
+    mushroomOrientation(): 'horizontal' | 'vertical'
+    /** @deprecated Use mushroomSettings({ orientation }) */
+    mushroomOrientation(v: 'horizontal' | 'vertical'): this
+
+    /** @deprecated Use mushroomSettings({ sizeScaleFunction }) */
+    mushroomSizeScaleFunction(): any
+    /** @deprecated Use mushroomSettings({ sizeScaleFunction }) */
+    mushroomSizeScaleFunction(v: any): this
+
+    /** @deprecated Use mushroomSettings({ sizeScaleFunctionV1 }) */
+    mushroomSizeScaleFunctionV1(): any
+    /** @deprecated Use mushroomSettings({ sizeScaleFunctionV1 }) */
+    mushroomSizeScaleFunctionV1(v: any): this
+
+    /** @deprecated Use mushroomSettings({ sizeScaleFunctionV2 }) */
+    mushroomSizeScaleFunctionV2(): any
+    /** @deprecated Use mushroomSettings({ sizeScaleFunctionV2 }) */
+    mushroomSizeScaleFunctionV2(v: any): this
+}

package/build/types/layers/proportional-symbol/mushroom/MushroomMapConfig.d.ts

@@ -0,0 +1,39 @@
+import type { MapConfig } from '../../../core/MapConfig'
+
+/**
+ * Configuration for mushroom maps.
+ */
+export interface MushroomMapConfig extends MapConfig {
+    /** Grouped mushroom settings. */
+    mushroomSettings?: {
+        codes?: [string, string]
+        minSize?: number
+        maxSize?: number
+        colors?: [string, string]
+        orientation?: 'horizontal' | 'vertical'
+        sizeScaleFunction?: (value: number) => number
+        sizeScaleFunctionV1?: (value: number) => number
+        sizeScaleFunctionV2?: (value: number) => number
+    }
+    /** @deprecated Use mushroomSettings.codes */
+    /** Mushroom codes. */
+    mushroomCodes?: [string, string]
+    /** @deprecated Use mushroomSettings.minSize */
+    /** Mushroom min size. */
+    mushroomMinSize?: number
+    /** @deprecated Use mushroomSettings.maxSize */
+    /** Mushroom max size. */
+    mushroomMaxSize?: number
+    /** @deprecated Use mushroomSettings.colors */
+    /** Mushroom colors. */
+    mushroomColors?: [string, string]
+    /** @deprecated Use mushroomSettings.orientation */
+    /** Mushroom orientation. */
+    mushroomOrientation?: 'horizontal' | 'vertical'
+    /** @deprecated Use mushroomSettings.sizeScaleFunction */
+    mushroomSizeScaleFunction?: (value: number) => number
+    /** @deprecated Use mushroomSettings.sizeScaleFunctionV1 */
+    mushroomSizeScaleFunctionV1?: (value: number) => number
+    /** @deprecated Use mushroomSettings.sizeScaleFunctionV2 */
+    mushroomSizeScaleFunctionV2?: (value: number) => number
+}

package/build/types/layers/spark/SparkMap.d.ts

@@ -0,0 +1,56 @@
+import type { MapInstance } from '../../core/MapInstance'
+import type { SparkStatConfig } from './SparkStatConfig'
+import type { SparklineLegendConfig } from '../../legend/composition/SparklineLegendConfig'
+import type { SparkSettings } from './SparkMapConfig'
+
+/**
+ * Spark map type.
+ */
+export interface SparkMap extends MapInstance {
+    sparkSettings(): SparkSettings
+    sparkSettings(v: SparkSettings): this
+
+    legend(): SparklineLegendConfig | false
+    legend(config: SparklineLegendConfig | false): this
+
+    sparkLineColor(): any
+    sparkLineColor(v: any): this
+
+    showOnlyWhenComplete(): boolean
+    showOnlyWhenComplete(v: boolean): this
+
+    sparkType(): 'line' | 'area' | 'bar'
+    sparkType(v: 'line' | 'area' | 'bar'): this
+
+    sparkLineWidth(): number
+    sparkLineWidth(v: number): this
+
+    sparkLineHeight(): number
+    sparkLineHeight(v: number): this
+
+    sparkLineStrokeWidth(): number
+    sparkLineStrokeWidth(v: number): this
+
+    sparkLineOpacity(): number
+    sparkLineOpacity(v: number): this
+
+    sparkLineCircleRadius(): number
+    sparkLineCircleRadius(v: number): this
+
+    sparkLineAreaColor(): any
+    sparkLineAreaColor(v: any): this
+
+    sparkTooltipChart(): any
+    sparkTooltipChart(v: any): this
+
+    sparkLineChartFunction(): any
+    sparkLineChartFunction(v: any): this
+
+    sparkLineOffsets(): { x: number; y: number }
+    sparkLineOffsets(v: { x: number; y: number }): this
+
+    /** Manually set sparkline data instead of fetching it from Eurostat. */
+    sparklineData(dataObject: Record<string, Record<string, number>>): this
+    /** Configure fetching data from Eurostat and generating spark lines. */
+    statSpark(config: SparkStatConfig): this
+}

package/build/types/layers/spark/SparkMapConfig.d.ts

@@ -0,0 +1,75 @@
+import type { MapConfig } from '../../core/MapConfig'
+import type { SparklineLegendConfig } from '../../legend/composition/SparklineLegendConfig'
+
+export interface SparkSettings {
+    type?: 'line' | 'area' | 'bar'
+    lineOffsets?: { x: number; y: number }
+    lineWidth?: number
+    lineHeight?: number
+    lineStrokeWidth?: number
+    lineOpacity?: number
+    lineColor?: string | ((value: number, index: number, data: any[]) => string)
+    areaColor?: string | ((value: number, index: number, data: any[]) => string)
+    lineCircleRadius?: number
+    tooltipChart?: {
+        width: number
+        height: number
+        margin: { left: number; right: number; top: number; bottom: number }
+        circleRadius: number
+    }
+    lineChartFunction?: (node: any, data: any[], width: number, height: number, isForTooltip?: boolean) => void
+}
+
+/**
+ * Configuration for sparkline maps.
+ */
+export interface SparkMapConfig extends MapConfig {
+    /** Grouped sparkline rendering settings. */
+    sparkSettings?: SparkSettings
+
+    /** Spark type. */
+    sparkType?: 'line' | 'area' | 'bar'
+
+    /** Object-form stat configuration for temporal sparkline datasets. */
+    dates?: string[]
+    labels?: string[]
+    eurostatDatasetCode?: string
+    customData?: Record<string, Record<string, number>>
+    filters?: Record<string, any>
+    unitText?: string
+    preprocess?: (regionId: string, value: any) => any
+    transform?: (value: any) => any
+
+    sparkLineColor?: string | ((value: number, index: number, data: any[]) => string)
+    sparkAreaColor?: string | ((value: number, index: number, data: any[]) => string)
+    /** Spark line width. */
+    sparkLineWidth?: number
+    /** Spark line height. */
+    sparkLineHeight?: number
+    /** Spark line stroke width. */
+    sparkLineStrokeWidth?: number
+    /** Spark line opacity. */
+    sparkLineOpacity?: number
+    /** Spark line circle radius. */
+    sparkLineCircleRadius?: number
+    /** Spark tooltip chart. */
+    sparkTooltipChart?: {
+        /** Width. */
+        width: number
+        /** Height. */
+        height: number
+        /** Margin. */
+        margin: { left: number; right: number; top: number; bottom: number }
+        /** Circle radius. */
+        circleRadius: number
+    }
+    /** Spark line offsets. */
+    sparkLineOffsets?: { x: number; y: number }
+    /** Show only when complete. */
+    showOnlyWhenComplete?: boolean
+    sparkLineChartFunction?: (node: any, data: any[], width: number, height: number, isForTooltip?: boolean) => void
+    /** Spark yscale. */
+    sparkYScale?: any
+    /** Legend. */
+    legend?: SparklineLegendConfig | false
+}

package/build/types/layers/spark/SparkStatConfig.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Statistical configuration for sparkline maps.
+ *
+ * Either `eurostatDatasetCode` + `dates` (Eurostat API path)
+ * or `customData` (custom data path) must be provided.
+ */
+export interface SparkStatConfig {
+    /**
+     * Custom data keyed by region ID then date string.
+     * Use instead of `eurostatDatasetCode` when supplying data directly.
+     * When `customData` is set, `eurostatDatasetCode` is not required;
+     * `dates` defaults to the key order of the first region's entries.
+     * @example
+     * customData: {
+     *   ES: { '2020': 100, '2021': 120, '2022': 115 },
+     *   DE: { '2020': 200, '2021': 190, '2022': 210 },
+     * }
+     */
+    customData?: Record<string, Record<string, number>>
+
+    /** 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
+    /** Date keys to fetch. Required when not using `customData`. */
+    dates?: string[]
+    /** Display labels for each date. */
+    labels?: string[]
+}

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

@@ -6,6 +6,8 @@ export interface LegendConfig {
     x?: number
     /** Legend origin y-coordinate in pixels. */
     y?: number
+    /** Automatically position the legend in a map corner. Manual x/y coordinates take precedence. */
+    position?: 'top right' | 'bottom right' | 'top left' | 'bottom left'
     /** Legend width in pixels. */
     width?: number
     /** Legend height in pixels. */
@@ -65,4 +67,5 @@ export interface LegendConfig {
     maxMin?: boolean
     /** Text affixes for min/max labels as [minSuffix, maxSuffix]. */
     maxMinLabels?: [string, string]
+    layer?: any
 }