eurostat-map
    Preparing search index...

    Interface ProportionalSymbolColorLegendConfig

    Configuration for color legend in proportional symbol maps.

    interface ProportionalSymbolColorLegendConfig {
        title?: string;
        titlePadding?: number;
        marginTop?: number;
        shapeWidth?: number;
        shapeHeight?: number;
        shapePadding?: number;
        labelOffsets?: { x: number; y: number };
        decimals?: number;
        labelFormatter?: (value: number) => string;
        labelType?: "thresholds" | "ranges";
        labels?: string[];
        noData?: boolean;
        noDataText?: string;
        sepLineLength?: number;
        sepLineStroke?: string;
        sepLineStrokeWidth?: number;
        tickLength?: number;
        pointOfDivergenceLabel?: string;
        pointOfDivergence?: number;
        pointOfDivergencePadding?: number;
        divergingLineLength?: number;
        divergingArrowLength?: number;
    }
    Index

    Properties

    title?: string

    Title for the color legend.

    titlePadding?: number

    Padding between title and legend content in pixels.

    10
    
    marginTop?: number

    Top margin (distance from size legend) in pixels.

    30
    
    shapeWidth?: number

    Width of color swatches in pixels.

    25
    
    shapeHeight?: number

    Height of color swatches in pixels.

    20
    
    shapePadding?: number

    Padding between swatches in pixels.

    1
    
    labelOffsets?: { x: number; y: number }

    Offset adjustments for labels.

    { x: 5, y: 0 }
    
    decimals?: number

    Number of decimal places for legend labels.

    0
    
    labelFormatter?: (value: number) => string

    Custom formatter function for legend labels.

    labelType?: "thresholds" | "ranges"

    Type of labels to show.

    'thresholds'
    
    labels?: string[]

    User-defined labels for each class.

    noData?: boolean

    Whether to show a "no data" item.

    true
    
    noDataText?: string

    Text label for "no data" item.

    'No data'
    
    sepLineLength?: number

    Length of separation line in pixels.

    24
    
    sepLineStroke?: string

    Color of separation line.

    'black'
    
    sepLineStrokeWidth?: number

    Width of separation line in pixels.

    1
    
    tickLength?: number

    Length of threshold ticks in pixels.

    5
    
    pointOfDivergenceLabel?: string

    Label for the point of divergence in diverging legends.

    pointOfDivergence?: number

    Value at the point of divergence in diverging legends.

    pointOfDivergencePadding?: number

    Padding around divergence point in pixels.

    7
    
    divergingLineLength?: number

    Length of diverging line in pixels.

    divergingArrowLength?: number

    Length of diverging arrows in pixels.