eurostat-map
    Preparing search index...

    Interface BivariateLegendConfig

    Configuration for bivariate choropleth map legends. Displays a 2D grid showing the relationship between two variables, with color squares representing different class combinations.

    interface BivariateLegendConfig {
        x?: number;
        y?: number;
        width?: number;
        height?: number;
        title?: string;
        subtitle?: string;
        titleFontSize?: number;
        boxPadding?: number;
        boxOpacity?: number;
        titlePadding?: number;
        shapeWidth?: number;
        shapeHeight?: number;
        shapePadding?: number;
        sepLineLength?: number;
        labelFontSize?: number;
        labelOffsets?: { x: number; y: number };
        labelFormatter?: (value: number, index?: number) => string;
        decimals?: number;
        orientation?: "vertical" | "horizontal";
        ascending?: boolean;
        noData?: boolean;
        noDataText?: string;
        noDataPadding?: number;
        noDataShapeWidth?: number;
        noDataShapeHeight?: number;
        maxMin?: boolean;
        maxMinLabels?: [string, string];
        squareSize?: number;
        rotation?: number;
        label1?: string;
        label2?: string;
        breaks1?: number[];
        breaks2?: number[];
        showBreaks?: boolean;
        tickLength?: number;
        yAxisLabelsOffset?: { x: number; y: number };
        xAxisLabelsOffset?: { x: number; y: number };
        yAxisTitleOffset?: { x: number; y: number };
        xAxisTitleOffset?: { x: number; y: number };
        noDataYOffset?: number;
        axisArrows?: boolean;
        arrowHeight?: number;
        arrowWidth?: number;
        arrowPadding?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    x? y? width? height? title? subtitle? titleFontSize? boxPadding? boxOpacity? titlePadding? shapeWidth? shapeHeight? shapePadding? sepLineLength? labelFontSize? labelOffsets? labelFormatter? decimals? orientation? ascending? noData? noDataText? noDataPadding? noDataShapeWidth? noDataShapeHeight? maxMin? maxMinLabels? squareSize? rotation? label1? label2? breaks1? breaks2? showBreaks? tickLength? yAxisLabelsOffset? xAxisLabelsOffset? yAxisTitleOffset? xAxisTitleOffset? noDataYOffset? axisArrows? arrowHeight? arrowWidth? arrowPadding?

    Properties

    x?: number

    Legend origin x-coordinate in pixels.

    y?: number

    Legend origin y-coordinate in pixels.

    width?: number

    Legend width in pixels.

    height?: number

    Legend height in pixels.

    title?: string

    Legend title text.

    subtitle?: string

    Legend subtitle text.

    titleFontSize?: number

    Legend title font size in pixels.

    boxPadding?: number

    Inner spacing around legend content.

    boxOpacity?: number

    Background opacity of the legend box.

    titlePadding?: number

    Padding between the title block and legend body.

    shapeWidth?: number

    Symbol swatch width in pixels.

    shapeHeight?: number

    Symbol swatch height in pixels.

    shapePadding?: number

    Horizontal gap between shape and label.

    sepLineLength?: number

    Length of separator lines in discrete legends.

    labelFontSize?: number

    Label font size in pixels.

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

    Pixel offsets applied to labels.

    labelFormatter?: (value: number, index?: number) => string

    Custom formatter for legend labels.

    decimals?: number

    Number of decimal places for auto-formatted labels.

    orientation?: "vertical" | "horizontal"

    Legend layout direction.

    ascending?: boolean

    Sort legend entries in ascending order when true.

    noData?: boolean

    Whether to display the no-data legend item.

    noDataText?: string

    Label used for no-data legend item.

    noDataPadding?: number

    Vertical gap before the no-data swatch in pixels.

    noDataShapeWidth?: number

    Width of the no-data swatch in pixels.

    noDataShapeHeight?: number

    Height of the no-data swatch in pixels.

    maxMin?: boolean

    Whether to show dataset min/max labels when supported.

    maxMinLabels?: [string, string]

    Text affixes for min/max labels as [minSuffix, maxSuffix].

    squareSize?: number

    Size of the legend square grid in pixels.

    100
    rotation?: number

    Rotation angle of the legend in degrees.

    0
    label1?: string

    Label for the first variable (y-axis).

    'Variable 1'
    label2?: string

    Label for the second variable (x-axis).

    'Variable 2'
    breaks1?: number[]

    Break points for the first variable. Auto-calculated if undefined.

    breaks2?: number[]

    Break points for the second variable. Auto-calculated if undefined.

    showBreaks?: boolean

    Whether to show break labels on the axes.

    false
    tickLength?: number

    Length of axis tick marks in pixels.

    5
    yAxisLabelsOffset?: { x: number; y: number }

    Offset adjustments for y-axis labels.

    { x: 0, y: 0 }
    xAxisLabelsOffset?: { x: number; y: number }

    Offset adjustments for x-axis labels.

    { x: 0, y: 0 }
    yAxisTitleOffset?: { x: number; y: number }

    Offset adjustments for y-axis title.

    { x: 0, y: 0 }
    xAxisTitleOffset?: { x: number; y: number }

    Offset adjustments for x-axis title.

    { x: 0, y: 0 }
    noDataYOffset?: number

    Extra vertical offset for the "no data" legend item in pixels.

    30
    axisArrows?: boolean

    Whether to show arrows at the end of the axes.

    true
    arrowHeight?: number

    Height of axis arrows in pixels.

    15
    arrowWidth?: number

    Width of axis arrows in pixels.

    14
    arrowPadding?: number

    Padding between arrow and axis label in pixels.

    10

    Settings

    Member Visibility

    On This Page

    Properties