eurostat-map
    Preparing search index...

    Interface FlowMapConfig

    Configuration for flow maps.

    interface FlowMapConfig {
        svgId?: string;
        containerId?: string;
        proj?: string;
        projectionFunction?: () => any;
        scale?: "60M" | "20M" | "10M" | "03M" | "01M";
        nutsLevel?: number;
        nutsYear?: string | number;
        geoCenter?: [number, number];
        geo?: string;
        width?: number;
        height?: number;
        title?: string;
        subtitle?: string;
        footnote?: string;
        source?: string;
        stat?: StatConfig;
        legend?: false | LegendConfig;
        tooltip?: TooltipConfig;
        insets?: InsetConfig[];
        zoomExtent?: [number, number];
        gridCartogramSettings?: Partial<GridCartogramSettings>;
        dorlingSettings?: Partial<DorlingSettings>;
        drawCoastalMargin?: boolean;
        coastalMarginSettings?: Partial<CoastalMarginSettings>;
        drawGraticule?: boolean;
        labelling?: boolean;
        onBuild?: (map: MapInstance) => void;
        scalebar?: boolean | ScalebarConfig;
        gridCartogram?: boolean;
        filterGeometriesFunction?: (geometry: any) => boolean;
        backgroundMap?: boolean;
        minimap?: any;
        zoomButtons?: boolean;
        insetsButton?: boolean;
        legendButton?: boolean;
        placenames?: boolean;
        placenamesFilter?: (name: any) => boolean;
        header?: boolean;
        footer?: boolean;
        footerPadding?: number;
        headerPadding?: number;
        titlePosition?: [number, number];
        subtitlePosition?: [number, number];
        footnotePosition?: [number, number];
        logoPosition?: [number, number];
        ribbonPosition?: [number, number];
        zoomButtonsPosition?: [number, number];
        insetsButtonPosition?: [number, number];
        legendButtonPosition?: [number, number];
        hoverColor?: string;
        noDataFillStyle?: string;
        showSourceLink?: boolean;
        patternFill?: any;
        flowGraph?: FlowGraph;
        flowColor?: string;
        flowRegionColors?: string[];
        flowRegionLabels?: string[];
        flowArrows?: boolean;
        flowArrowScale?: number;
        flowMaxWidth?: number;
        flowMinWidth?: number;
        flowOutlines?: boolean;
        flowOutlineWidth?: number;
        flowOutlineColor?: string;
        flowColorGradient?: boolean;
        flowStack?: boolean;
        flowNodes?: boolean;
        flowNodeType?: "circle" | "donut";
        flowLabelOffsets?: { x?: number; y?: number };
        flowLineType?: "curved" | "straight" | "sankey";
        flowNodeSizeScale?: (value: number) => number;
        flowOpacity?: number;
        flowInternal?: boolean;
        flowTopLocations?: number;
        flowTopLocationsType?: "sum" | "origin" | "destination";
        flowCurvatureSettings?: FlowCurvatureSettings;
        flowOrder?: (a: any, b: any) => number;
        flowWidthGradient?: boolean;
        flowOpacityGradient?: boolean;
        flowWidthGradientSettings?: FlowWidthGradientSettings;
        flowBidirectional?: boolean;
        flowEdgeBundling?: boolean;
        flowBundleSettings?: FlowBundleSettings;
        [key: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any

      Allow additional properties for extensibility.

    Index

    Properties

    svgId? containerId? proj? projectionFunction? scale? nutsLevel? nutsYear? geoCenter? geo? width? height? title? subtitle? footnote? source? stat? legend? tooltip? insets? zoomExtent? gridCartogramSettings? dorlingSettings? drawCoastalMargin? coastalMarginSettings? drawGraticule? labelling? onBuild? scalebar? gridCartogram? filterGeometriesFunction? backgroundMap? minimap? zoomButtons? insetsButton? legendButton? placenames? placenamesFilter? header? footer? footerPadding? headerPadding? titlePosition? subtitlePosition? footnotePosition? logoPosition? ribbonPosition? zoomButtonsPosition? insetsButtonPosition? legendButtonPosition? hoverColor? noDataFillStyle? showSourceLink? patternFill? flowGraph? flowColor? flowRegionColors? flowRegionLabels? flowArrows? flowArrowScale? flowMaxWidth? flowMinWidth? flowOutlines? flowOutlineWidth? flowOutlineColor? flowColorGradient? flowStack? flowNodes? flowNodeType? flowLabelOffsets? flowLineType? flowNodeSizeScale? flowOpacity? flowInternal? flowTopLocations? flowTopLocationsType? flowCurvatureSettings? flowOrder? flowWidthGradient? flowOpacityGradient? flowWidthGradientSettings? flowBidirectional? flowEdgeBundling? flowBundleSettings?

    Properties

    svgId?: string

    Container settings.

    containerId?: string

    ID of the container element used to host the map.

    proj?: string

    NUTS2json geometries projection: '3035', '3857', '4326'. For custom projections, use 4326 and then set projectionFunction().

    projectionFunction?: () => any

    Function to set a custom projection. See d3-geo projections for examples.

    scale?: "60M" | "20M" | "10M" | "03M" | "01M"

    Scale of the map, for NUTSjson geometries.

    nutsLevel?: number

    NUTS level (0, 1, 2, 3).

    nutsYear?: string | number

    NUTS boundary year.

    geoCenter?: [number, number]

    Geographic center as [longitude, latitude].

    geo?: string

    NUTS2JSON geographic focus (e.g., 'EUR', 'WORLD', 'IC', 'GF'). See https://github.com/eurostat/Nuts2json#overseas-territories---map-insets

    width?: number

    Map dimensions.

    height?: number

    Map height in pixels.

    title?: string

    Map title.

    subtitle?: string

    Map subtitle.

    footnote?: string

    Footnote text shown below the map.

    source?: string

    Data source text.

    stat?: StatConfig

    Statistical data configuration.

    legend?: false | LegendConfig

    Legend configuration.

    tooltip?: TooltipConfig

    Tooltip configuration.

    insets?: InsetConfig[]

    Insets (small additional maps).

    zoomExtent?: [number, number]

    Zoom and pan settings.

    gridCartogramSettings?: Partial<GridCartogramSettings>

    Grid cartogram layout settings.

    dorlingSettings?: Partial<DorlingSettings>

    Dorling simulation settings.

    drawCoastalMargin?: boolean

    Show or hide the coastal margin effect.

    coastalMarginSettings?: Partial<CoastalMarginSettings>

    Coastal margin settings to override defaults.

    drawGraticule?: boolean

    Graticule.

    labelling?: boolean

    Labels.

    onBuild?: (map: MapInstance) => void

    Fires once the map is built.

    scalebar?: boolean | ScalebarConfig

    Scalebar configuration. Can be boolean or configuration object.

    gridCartogram?: boolean

    Grid cartogram enabled or disabled.

    filterGeometriesFunction?: (geometry: any) => boolean

    Custom geometry filtering function.

    backgroundMap?: boolean

    Toggle background map rendering (sea, country boundaries, etc.).

    minimap?: any

    Minimap configuration.

    zoomButtons?: boolean

    Show/hide zoom +/- buttons.

    insetsButton?: boolean

    Show/hide inset map toggle button.

    legendButton?: boolean

    Show/hide legend toggle button.

    placenames?: boolean

    Show/hide placename labels.

    placenamesFilter?: (name: any) => boolean

    Filter function for placename labels.

    header?: boolean

    Use a separate header section for titles.

    footer?: boolean

    Use a separate footer section for footnotes.

    footerPadding?: number

    Padding between the map and footer in pixels.

    headerPadding?: number

    Padding between the header and map in pixels.

    titlePosition?: [number, number]

    Position adjustment for map title: [x, y]

    subtitlePosition?: [number, number]

    Position adjustment for map subtitle: [x, y]

    footnotePosition?: [number, number]

    Position adjustment for footnote text: [x, y]

    logoPosition?: [number, number]

    Position adjustment for Eurostat logo: [x, y]

    ribbonPosition?: [number, number]

    Position adjustment for ribbon banner: [x, y]

    zoomButtonsPosition?: [number, number]

    Position adjustment for zoom buttons: [x, y]

    insetsButtonPosition?: [number, number]

    Position adjustment for insets button: [x, y]

    legendButtonPosition?: [number, number]

    Position adjustment for legend button: [x, y]

    hoverColor?: string

    Pointer hover color for NUTS regions.

    noDataFillStyle?: string

    Base fill color for regions with no statistical data.

    showSourceLink?: boolean

    Show the link to the remote Eurostat statistical dataset.

    patternFill?: any

    Pattern fill configurations.

    flowGraph?: FlowGraph

    Flow graph.

    flowColor?: string

    Flow color.

    flowRegionColors?: string[]

    Flow region colors.

    flowRegionLabels?: string[]

    Flow region labels.

    flowArrows?: boolean

    Flow arrows.

    flowArrowScale?: number

    Flow arrow scale.

    flowMaxWidth?: number

    Flow max width.

    flowMinWidth?: number

    Flow min width.

    flowOutlines?: boolean

    Flow outlines.

    flowOutlineWidth?: number

    Flow outline width.

    flowOutlineColor?: string

    Flow outline color.

    flowColorGradient?: boolean

    Flow color gradient.

    flowStack?: boolean

    Flow stack.

    flowNodes?: boolean

    Flow nodes.

    flowNodeType?: "circle" | "donut"

    Flow node type.

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

    Flow label offsets.

    flowLineType?: "curved" | "straight" | "sankey"

    Flow line type.

    flowNodeSizeScale?: (value: number) => number
    flowOpacity?: number

    Flow opacity.

    flowInternal?: boolean

    Flow internal.

    flowTopLocations?: number

    Flow top locations.

    flowTopLocationsType?: "sum" | "origin" | "destination"

    Flow top locations type.

    flowCurvatureSettings?: FlowCurvatureSettings

    Flow curvature settings.

    flowOrder?: (a: any, b: any) => number
    flowWidthGradient?: boolean

    Flow width gradient.

    flowOpacityGradient?: boolean

    Flow opacity gradient.

    flowWidthGradientSettings?: FlowWidthGradientSettings

    Flow width gradient settings.

    flowBidirectional?: boolean

    Flow bidirectional.

    flowEdgeBundling?: boolean

    Flow edge bundling.

    flowBundleSettings?: FlowBundleSettings

    Flow bundle settings.

    Settings

    Member Visibility

    On This Page

    Properties
    svgIdcontainerIdprojprojectionFunctionscalenutsLevelnutsYeargeoCentergeowidthheighttitlesubtitlefootnotesourcestatlegendtooltipinsetszoomExtentgridCartogramSettingsdorlingSettingsdrawCoastalMargincoastalMarginSettingsdrawGraticulelabellingonBuildscalebargridCartogramfilterGeometriesFunctionbackgroundMapminimapzoomButtonsinsetsButtonlegendButtonplacenamesplacenamesFilterheaderfooterfooterPaddingheaderPaddingtitlePositionsubtitlePositionfootnotePositionlogoPositionribbonPositionzoomButtonsPositioninsetsButtonPositionlegendButtonPositionhoverColornoDataFillStyleshowSourceLinkpatternFillflowGraphflowColorflowRegionColorsflowRegionLabelsflowArrowsflowArrowScaleflowMaxWidthflowMinWidthflowOutlinesflowOutlineWidthflowOutlineColorflowColorGradientflowStackflowNodesflowNodeTypeflowLabelOffsetsflowLineTypeflowNodeSizeScaleflowOpacityflowInternalflowTopLocationsflowTopLocationsTypeflowCurvatureSettingsflowOrderflowWidthGradientflowOpacityGradientflowWidthGradientSettingsflowBidirectionalflowEdgeBundlingflowBundleSettings