eurostat-map
    Preparing search index...

    Interface StatConfig

    Configuration for a statistical data source. Pass this to map.stat() or as the config argument to statData().

    Preferred for multi-channel maps: register named datasets with map.stat('datasetName', config) and map them with map.encoding(...).

    interface StatConfig {
        customData?: Record<
            string,
            number
            | string
            | { value: number | string; status?: string },
        >;
        eurostatDatasetCode?: string;
        filters?: Record<string, string>;
        precision?: number;
        csvURL?: string;
        geoCol?: string;
        valueCol?: string;
        unitText?: string;
        preprocess?: (regionId: string, value: any) => any;
        transform?: (value: number) => number;
        label?: string;
    }
    Index

    Properties

    customData? eurostatDatasetCode? filters? precision? csvURL? geoCol? valueCol? unitText? preprocess? transform? label?

    Properties

    customData?: Record<
        string,
        number
        | string
        | { value: number | string; status?: string },
    >

    Custom data keyed by region ID. Use instead of a remote data source.

    eurostatDatasetCode?: string

    Eurostat dataset code. e.g. 'demo_r_d3dens'

    filters?: Record<string, string>

    Filters for the Eurostat API query.

    { TIME: '2024', UNIT: 'EUR_HAB' }
    precision?: number

    Number of decimal places for Eurostat API data.

    2
    csvURL?: string

    URL of a CSV file to use as the data source.

    geoCol?: string

    CSV column containing NUTS region IDs.

    'geo'
    valueCol?: string

    CSV column containing statistical values.

    'value'
    unitText?: string

    Unit of measure label shown in tooltips. e.g. 'people/km²'

    preprocess?: (regionId: string, value: any) => any

    Optional preprocessing hook called with (regionId, value) before transform. Return null/undefined/false to filter out the region.

    transform?: (value: number) => number

    Optional transform function applied to raw values after data loads. e.g. v => v * 1000

    label?: string

    Dataset label/name from the Eurostat API response.

    Settings

    Member Visibility

    On This Page

    Properties