eurostat-map 4.3.58 → 4.4.0

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

@@ -0,0 +1,59 @@
+import { LegendConfig } from '../LegendConfig'
+
+/**
+ * Configuration for bivariate choropleth map legends.
+ * Displays a 2D grid showing the relationship between two variables,
+ * with color squares representing different class combinations.
+ */
+export interface BivariateLegendConfig extends LegendConfig {
+    /** Size of the legend square grid in pixels. @default 100 */
+    squareSize?: number
+
+    /** Rotation angle of the legend in degrees. @default 0 */
+    rotation?: number
+
+    /** Label for the first variable (y-axis). @default 'Variable 1' */
+    label1?: string
+
+    /** Label for the second variable (x-axis). @default 'Variable 2' */
+    label2?: string
+
+    /** Break points for the first variable. Auto-calculated if undefined. */
+    breaks1?: number[]
+
+    /** Break points for the second variable. Auto-calculated if undefined. */
+    breaks2?: number[]
+
+    /** Whether to show break labels on the axes. @default false */
+    showBreaks?: boolean
+
+    /** Length of axis tick marks in pixels. @default 5 */
+    tickLength?: number
+
+    /** Offset adjustments for y-axis labels. @default { x: 0, y: 0 } */
+    yAxisLabelsOffset?: { x: number; y: number }
+
+    /** Offset adjustments for x-axis labels. @default { x: 0, y: 0 } */
+    xAxisLabelsOffset?: { x: number; y: number }
+
+    /** Offset adjustments for y-axis title. @default { x: 0, y: 0 } */
+    yAxisTitleOffset?: { x: number; y: number }
+
+    /** Offset adjustments for x-axis title. @default { x: 0, y: 0 } */
+    xAxisTitleOffset?: { x: number; y: number }
+
+    /** Extra vertical offset for the "no data" legend item in pixels. @default 30 */
+    noDataYOffset?: number
+
+    /** Whether to show arrows at the end of the axes. @default true */
+    axisArrows?: boolean
+
+    /** Height of axis arrows in pixels. @default 15 */
+    arrowHeight?: number
+
+    /** Width of axis arrows in pixels. @default 14 */
+    arrowWidth?: number
+
+    /** Padding between arrow and axis label in pixels. @default 10 */
+    arrowPadding?: number
+}

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

@@ -0,0 +1,26 @@
+/**
+ * Configuration for histogram display in choropleth legends.
+ * Shows the distribution of data values across classification bins as bars.
+ */
+export interface HistogramLegendConfig {
+    /** Orientation of the histogram bars. @default 'horizontal' */
+    orientation?: 'horizontal' | 'vertical'
+
+    /** Whether to show count values on the bars. @default false */
+    showCounts?: boolean
+
+    /** Whether to show percentage values on the bars. @default false */
+    showPercentages?: boolean
+
+    /** Rotation angle for axis labels in degrees. @default 0 */
+    labelRotation?: number
+
+    /** Margins around the histogram. @default { top: 0, right: 0, bottom: 0, left: 0 } */
+    margin?: { top: number; right: number; bottom: number; left: number }
+
+    /** Height of the histogram in pixels. @default 200 */
+    height?: number
+
+    /** Width of the histogram in pixels. @default 270 */
+    width?: number
+}

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

@@ -0,0 +1,32 @@
+export interface TrivariateLegendConfig {
+    /** Width of the legend in pixels. @default 160 */
+    width?: number
+    /** Height of the legend in pixels. @default 160 */
+    height?: number
+    /** Padding around the ternary plot. @default { top: 50, right: 50, bottom: 10, left: 50 } */
+    padding?: { top: number; right: number; bottom: number; left: number }
+    /** Plot type. @default 'continuous' */
+    type?: 'continuous' | 'discrete'
+    /** Whether to show the center point and guide lines. @default true */
+    showCenter?: boolean
+    /** Label for the center annotation. @default 'Average' */
+    centerLabel?: string
+    /** Whether to show grid lines. @default false */
+    showLines?: boolean
+    /** Number of minor grid subdivisions between major grid lines. @default 5 */
+    minorSubdivisions?: number
+    /** Axis corner labels. @default ['Variable 1', 'Variable 2', 'Variable 3'] */
+    labels?: [string, string, string]
+    /** Position of axis labels. @default 'edge' */
+    labelPosition?: 'corner' | 'edge'
+    /** Whether colour is applied to triangles or data points. @default 'points' */
+    colorTarget?: 'triangles' | 'points'
+    /** Whether to render data points. @default true */
+    showData?: boolean
+    /** Offsets for the center annotation label and curve. */
+    centerAnnotationOffsets?: { labelX: number; labelY: number; curveX: number; curveY: number }
+    /** Legend title. */
+    title?: string
+    /** Legend subtitle. */
+    subtitle?: string
+}

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

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

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

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

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

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

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

@@ -0,0 +1,68 @@
+import { LegendConfig } from '../LegendConfig'
+
+/**
+ * Configuration for size legend in bar chart maps.
+ */
+export interface BarChartSizeLegendConfig {
+    /** 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 null, auto-generates [min, mid, max]. */
+    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 bar chart maps.
+ */
+export interface BarChartColorLegendConfig {
+    /** 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 20 */
+    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 bar chart map legends.
+ * Adapts automatically to the map's barType ('stacked' or 'grouped').
+ */
+export interface BarChartLegendConfig extends LegendConfig {
+    /** Configuration for the bar size legend. Set to false to hide. */
+    sizeLegend?: Partial<BarChartSizeLegendConfig> | false
+
+    /** Configuration for the color/category legend. Set to false to hide. */
+    colorLegend?: Partial<BarChartColorLegendConfig> | false
+}

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

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

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

@@ -0,0 +1,117 @@
+import { LegendConfig } from '../LegendConfig'
+
+/**
+ * Configuration for flow width legend in flow maps.
+ */
+export interface FlowWidthLegendConfig {
+    /** Title for the flow width legend. */
+    title?: string | null
+
+    /** Padding between title and legend content in pixels. @default 20 */
+    titlePadding?: number
+
+    /** Custom values to display in the flow width legend. If null, values are auto-generated. */
+    values?: number[] | null
+
+    /** Top margin for the flow width legend in pixels. @default 15 */
+    marginTop?: number
+
+    /** Custom formatter function for legend labels. */
+    labelFormatter?: ((value: number) => string) | undefined
+
+    /** Manual override for legend labels. */
+    labels?: string[] | null
+
+    /** Color of the flow lines in the legend. @default '#616161' */
+    color?: string
+
+    /** Orientation of the flow width legend. @default 'horizontal' */
+    orientation?: 'horizontal' | 'vertical'
+
+    /** Number of segments to display. @default 3 */
+    segments?: number
+
+    /** Width of the legend in pixels. @default 150 */
+    width?: number
+
+    /** Whether to show max/min labels. @default false */
+    maxMin?: boolean
+}
+
+/**
+ * Configuration for node size legend in flow maps.
+ */
+export interface NodeSizeLegendConfig {
+    /** Title for the node size legend. */
+    title?: string | null
+
+    /** Padding between title and legend content in pixels. @default 25 */
+    titlePadding?: number
+
+    /** Custom values to display in the node size legend. If null, values are auto-generated. */
+    values?: number[] | null
+
+    /** Manual override for legend labels. */
+    labels?: string[] | null
+
+    /** Top margin for the node size legend in pixels. @default 20 */
+    marginTop?: number
+
+    /** Custom formatter function for legend labels. */
+    labelFormatter?: ((value: number) => string) | undefined
+}
+
+/**
+ * Configuration for flow color legend in flow maps.
+ */
+export interface FlowColorLegendConfig {
+    /** Title for the flow color legend. */
+    title?: string | null
+
+    /** Padding between title and legend content in pixels. @default 0 */
+    titlePadding?: number
+
+    /** Top margin for the flow color legend in pixels. @default 50 */
+    marginTop?: number
+
+    /** User-defined legend items for custom flow color function. */
+    items?: Array<{ label: string; color: string }>
+
+    /** Whether to use labels as ticks. @default false */
+    ticks?: boolean
+}
+
+/**
+ * Configuration for region color legend in flow maps.
+ */
+export interface RegionColorLegendConfig {
+    /** Title for the region color legend. */
+    title?: string | null
+
+    /** Padding between title and legend content in pixels. @default 15 */
+    titlePadding?: number
+
+    /** Top margin for the region color legend in pixels. @default 40 */
+    marginTop?: number
+
+    /** Labels for the region types. @default ['Exporter', 'Importer'] */
+    labels?: string[]
+}
+
+/**
+ * Configuration for flow map legends.
+ * Flow maps can display multiple legend types: flow width, node size, flow color, and region color.
+ */
+export interface FlowMapLegendConfig extends LegendConfig {
+    /** Configuration for the flow width legend. */
+    flowWidthLegend?: Partial<FlowWidthLegendConfig>
+
+    /** Configuration for the node size legend. */
+    nodeSizeLegend?: Partial<NodeSizeLegendConfig>
+
+    /** Configuration for the flow color legend. */
+    flowColorLegend?: Partial<FlowColorLegendConfig>
+
+    /** Configuration for the region color legend. */
+    regionColorLegend?: Partial<RegionColorLegendConfig>
+}

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

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

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

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

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

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

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

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

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

@@ -0,0 +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

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

@@ -0,0 +1,134 @@
+import { LegendConfig } from '../LegendConfig'
+
+/**
+ * Configuration for size legend in proportional symbol maps.
+ */
+export interface ProportionalSymbolSizeLegendConfig {
+    /** Title for the size legend. */
+    title?: string | null
+
+    /** Padding between title and legend content in pixels. @default 15 */
+    titlePadding?: number
+
+    /** Manually defined raw data values for the size legend. */
+    values?: number[]
+
+    /** Number of elements to display in the legend. @default 3 */
+    cellNb?: number
+
+    /** Vertical distance between consecutive legend shape elements in pixels. @default 15 */
+    shapePadding?: number
+
+    /** Offset adjustments for shapes. @default { x: 0, y: 0 } */
+    shapeOffsets?: { x: number; y: number }
+
+    /** Fill color for shapes in the legend. @default 'white' */
+    shapeFill?: string
+
+    /** Stroke color for shapes in the legend. */
+    shapeStroke?: string | null
+
+    /** Stroke width for shapes in the legend in pixels. */
+    shapeStrokeWidth?: number | null
+
+    /** Offset adjustments for labels. @default { x: 10, y: 0 } */
+    labelOffsets?: { x: number; y: number }
+
+    /** Number of decimal places for legend labels. @default 0 */
+    decimals?: number
+
+    /** Custom formatter function for legend labels. */
+    labelFormatter?: ((value: number) => string) | undefined
+
+    /** User-defined labels for each size. */
+    labels?: string[] | null
+
+    /** 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 proportional symbol maps.
+ */
+export interface ProportionalSymbolColorLegendConfig {
+    /** 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 30 */
+    marginTop?: 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
+
+    /** Offset adjustments for labels. @default { x: 5, y: 0 } */
+    labelOffsets?: { x: number; y: number }
+
+    /** Number of decimal places for legend labels. @default 0 */
+    decimals?: number
+
+    /** Custom formatter function for legend labels. */
+    labelFormatter?: ((value: number) => string) | undefined
+
+    /** Type of labels to show. @default 'thresholds' */
+    labelType?: 'thresholds' | 'ranges'
+
+    /** User-defined labels for each class. */
+    labels?: string[] | null
+
+    /** Whether to show a "no data" item. @default true */
+    noData?: boolean
+
+    /** Text label for "no data" item. @default 'No data' */
+    noDataText?: string
+
+    /** Length of separation line in pixels. @default 24 */
+    sepLineLength?: number
+
+    /** Color of separation line. @default 'black' */
+    sepLineStroke?: string
+
+    /** Width of separation line in pixels. @default 1 */
+    sepLineStrokeWidth?: number
+
+    /** Length of threshold ticks in pixels. @default 5 */
+    tickLength?: number
+
+    /** Label for the point of divergence in diverging legends. */
+    pointOfDivergenceLabel?: string
+
+    /** Value at the point of divergence in diverging legends. */
+    pointOfDivergence?: number
+
+    /** Padding around divergence point in pixels. @default 7 */
+    pointOfDivergencePadding?: number
+
+    /** Length of diverging line in pixels. */
+    divergingLineLength?: number
+
+    /** Length of diverging arrows in pixels. */
+    divergingArrowLength?: number
+}
+
+/**
+ * Configuration for proportional symbol map legends.
+ * Shows both symbol size and color classifications.
+ */
+export interface ProportionalSymbolsLegendConfig extends LegendConfig {
+    /** Configuration for the symbol size legend. */
+    sizeLegend?: Partial<ProportionalSymbolSizeLegendConfig>
+
+    /** Configuration for the color classification legend. Set to false to hide. */
+    colorLegend?: Partial<ProportionalSymbolColorLegendConfig> | false
+}

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

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

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

@@ -0,0 +1,21 @@
+import type { MapInstance } from '../core/MapInstance'
+
+/**
+ * Categorical map type.
+ */
+export interface CategoricalMap extends MapInstance {
+    classToFillStyle(): any
+    classToFillStyle(v: any): this
+
+    classToText(): any
+    classToText(v: any): this
+
+    noDataFillStyle(): string
+    noDataFillStyle(v: string): this
+
+    tooltipText(): any
+    tooltipText(v: any): this
+
+    classifier(): any
+    classifier(v: any): this
+}

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

@@ -0,0 +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
+}

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

@@ -0,0 +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
+}

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

@@ -0,0 +1,34 @@
+/**
+ * All supported map types
+ */
+export type MapType =
+    | 'choropleth'
+    | 'ch'
+    | 'proportionalSymbol'
+    | 'proportionalSymbols'
+    | 'ps'
+    | 'categorical'
+    | 'ct'
+    | 'bivariateChoropleth'
+    | 'chbi'
+    | 'trivariateChoropleth'
+    | 'ternary'
+    | 'chtri'
+    | 'stripeComposition'
+    | 'scomp'
+    | 'stripe'
+    | 'pieChart'
+    | 'pie'
+    | 'sparkline'
+    | 'spark'
+    | 'sparklines'
+    | 'flow'
+    | 'flowmap'
+    | 'coxcomb'
+    | 'polar'
+    | 'alpha'
+    | 'valueByAlpha'
+    | 'mushroom'
+    | 'waffle'
+    | 'bar'
+    | 'barComposition'

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

@@ -0,0 +1,15 @@
+import type { MapConfig } from '../../core/MapConfig'
+
+/**
+ * Configuration for bivariate choropleth maps.
+ */
+export interface BivariateChoroplethConfig extends MapConfig {
+    numberOfClasses?: number
+    breaks1?: number[]
+    breaks2?: number[]
+    startColor?: string
+    color1?: string
+    color2?: string
+    endColor?: string
+    noDataFillStyle?: string
+}

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

@@ -0,0 +1,39 @@
+import type { MapInstance } from '../../core/MapInstance'
+
+/**
+ * Bivariate choropleth map type.
+ */
+export interface BivariateChoroplethMap extends MapInstance {
+    numberOfClasses(): number
+    numberOfClasses(v: number): this
+
+    breaks1(): number[] | undefined
+    breaks1(v: number[] | undefined): this
+
+    breaks2(): number[] | undefined
+    breaks2(v: number[] | undefined): this
+
+    startColor(): string
+    startColor(v: string): this
+
+    color1(): string
+    color1(v: string): this
+
+    color2(): string
+    color2(v: string): this
+
+    endColor(): string
+    endColor(v: string): this
+
+    classToFillStyle(): any
+    classToFillStyle(v: any): this
+
+    noDataFillStyle(): string
+    noDataFillStyle(v: string): this
+
+    classifier1(): any
+    classifier1(v: any): this
+
+    classifier2(): any
+    classifier2(v: any): this
+}

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

@@ -0,0 +1,29 @@
+import { MapConfig } from '../../core/MapConfig'
+
+/**
+ * Configuration specific to choropleth maps
+ */
+export interface ChoroplethConfig extends MapConfig {
+    // Classification
+    numberOfClasses?: number
+    classificationMethod?: 'quantile' | 'ckmeans' | 'jenks' | 'equinter' | 'threshold'
+    thresholds?: number[]
+    makeClassifNice?: boolean
+
+    // Colors
+    colors?: string[]
+    colorFunction?: (t: number) => string
+    colorSchemeType?: 'discrete' | 'continuous'
+    classToFillStyle?: { [classIndex: number]: string }
+
+    // No data styling
+    noDataFillStyle?: string
+
+    // Value transformation (for continuous schemes)
+    valueTransform?: (x: number) => number
+    valueUntransform?: (x: number) => number
+    skipNormalization?: boolean
+
+    // Diverging schemes
+    pointOfDivergence?: number
+}