eurostat-map 4.3.58 → 4.4.1

package/build/types/legend/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/SparklineLegendConfig.d.ts

@@ -0,0 +1,6 @@
+export type {
+    SparklineScaleLegendConfig,
+    SparklineColorLegendConfig,
+    SparklineNoDataLegendConfig,
+    SparklineLegendConfig,
+} from './composition/SparklineLegendConfig'

package/build/types/legend/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/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
+}

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