eurostat-map
    Preparing search index...

    Interface CompositionStatConfig<TCustomData>

    Statistical configuration for composition maps (pie, bar, waffle, stripe).

    Either eurostatDatasetCode + categoryParameter (Eurostat API path) or customData (custom data path) must be provided.

    interface CompositionStatConfig<
        TCustomData = Record<string, Record<string, number>>,
    > {
        customData?: TCustomData;
        eurostatDatasetCode?: string;
        filters?: Record<string, any>;
        unitText?: string;
        transform?: (value: number) => number;
        categoryParameter?: string;
        categoryCodes?: string[];
        categoryLabels?: string[];
        categoryColors?: string[];
        totalCode?: string;
        stat?: {
            eurostatDatasetCode?: string;
            filters?: Record<string, any>;
            unitText?: string;
            transform?: (value: number) => number;
        };
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    customData? eurostatDatasetCode? filters? unitText? transform? categoryParameter? categoryCodes? categoryLabels? categoryColors? totalCode? stat?

    Properties

    customData?: TCustomData

    Custom data keyed by region ID then category code. Use instead of eurostatDatasetCode when supplying data directly. When customData is set, eurostatDatasetCode and categoryParameter are not required.

    customData: {
      ES: { cat1: 2, cat2: 3, cat3: 5 },
      DE: { cat1: 4, cat2: 1, cat3: 6 },
    }
    eurostatDatasetCode?: string

    Eurostat dataset code. Required when not using customData.

    filters?: Record<string, any>

    Filters.

    unitText?: string

    Unit text.

    transform?: (value: number) => number
    categoryParameter?: string

    Category parameter. Required when not using customData.

    categoryCodes?: string[]

    Category codes.

    categoryLabels?: string[]

    Category labels.

    categoryColors?: string[]

    Category colors.

    totalCode?: string

    Total code.

    stat?: {
        eurostatDatasetCode?: string;
        filters?: Record<string, any>;
        unitText?: string;
        transform?: (value: number) => number;
    }

    Legacy nested API supported by buildStatCompositionMethod.

    Type Declaration

    • OptionaleurostatDatasetCode?: string

      Eurostat dataset code.

    • Optionalfilters?: Record<string, any>

      Filters.

    • OptionalunitText?: string

      Unit text.

    • Optionaltransform?: (value: number) => number

    Settings

    Member Visibility

    On This Page

    Properties