eurostat-map
    Preparing search index...

    Interface InsetConfig

    Configuration for map insets (smaller additional maps, e.g. overseas territories)

    interface InsetConfig {
        geo?: string;
        title?: string;
        titlePosition?: [number, number];
        subtitle?: string;
        subtitlePosition?: [number, number];
        scale?: string | number;
        width?: number;
        height?: number;
        x?: number;
        y?: number;
        proj?: string;
        svgId?: string;
        position?: { x?: number; y?: number; z?: number };
        labels?: LabelsConfig;
        zoomButtons?: boolean;
        nuts2jsonBaseURL?: string;
        projectionFunction?: boolean | Function;
        scalebar?: boolean | ScalebarConfig;
        showScalebar?: boolean;
        scalebarPosition?: [number, number];
        scalebarTickHeight?: number;
        scalebarSegmentHeight?: number;
        scalebarFontSize?: number;
        scalebarUnits?: string;
        scalebarTextOffset?: [number, number];
        scalebarMaxWidth?: number;
        scalebarMinWidth?: number;
        insets?: InsetConfig[];
        insetBoxPosition?: [number, number];
        [key: string]: any;
    }

    Indexable

    • [key: string]: any
    Index

    Properties

    geo?: string

    Geographic code (e.g., 'MT', 'PT20', 'CARIB').

    title?: string

    Title.

    titlePosition?: [number, number]

    Position of the title, relative to the inset's top-left corner.

    subtitle?: string

    Subtitle.

    subtitlePosition?: [number, number]

    Position of the subtitle, relative to the inset's top-left corner.

    scale?: string | number

    Scale. Named nuts2json scale (e.g. '01M', '03M', '10M', '20M', '60M') or a number.

    width?: number

    Width.

    height?: number

    Height.

    x?: number

    X position of the inset within the inset box.

    y?: number

    Y position of the inset within the inset box.

    proj?: string

    Proj.

    svgId?: string

    Id of the <svg> element the inset is drawn into. Auto-generated if omitted.

    position?: { x?: number; y?: number; z?: number }

    Manual re-centering/zoom of the inset's own projection.

    labels?: LabelsConfig

    Label rendering settings for this inset.

    zoomButtons?: boolean

    Whether to show zoom buttons on this inset.

    false
    
    nuts2jsonBaseURL?: string

    Custom base URL for this inset's nuts2json boundary data.

    projectionFunction?: boolean | Function

    Custom D3 projection function for this inset.

    scalebar?: boolean | ScalebarConfig

    Scalebar settings for this inset. true uses the default scalebar config.

    showScalebar?: boolean

    Use scalebar: { show: true } instead.

    scalebarPosition?: [number, number]

    Use scalebar: { position: [x, y] } instead.

    scalebarTickHeight?: number

    Use scalebar: { tickHeight } instead.

    scalebarSegmentHeight?: number

    Use scalebar: { segmentHeight } instead.

    scalebarFontSize?: number

    Scalebar label font size in pixels.

    scalebarUnits?: string

    Use scalebar: { units } instead.

    scalebarTextOffset?: [number, number]

    Use scalebar: { textOffset } instead.

    scalebarMaxWidth?: number

    Use scalebar: { maxWidth } instead.

    scalebarMinWidth?: number

    Minimum width of the scalebar in pixels.

    insets?: InsetConfig[]

    Nested insets belonging to this inset (e.g. bivariate choropleth per-inset legend classification).

    insetBoxPosition?: [number, number]

    Position of nested insets' inset box, relative to this inset.