eurostat-map
    Preparing search index...

    Interface ProportionalSymbolMap

    Proportional symbol map object

    interface ProportionalSymbolMap {
        svgId(): string;
        svgId(id: string): this;
        containerId(): string;
        containerId(id: string): this;
        width(): number;
        width(w: number): this;
        height(): number;
        height(h: number): this;
        geo(): string;
        geo(g: string): this;
        proj(): string;
        proj(p: string): this;
        scale(): string;
        scale(s: "60M" | "20M" | "10M" | "03M" | "01M"): this;
        nutsLevel(): number | "mixed";
        nutsLevel(level: number | "mixed"): this;
        nutsYear(): number;
        nutsYear(year: number): this;
        position(v: { x?: number; y?: number; z?: number }): this;
        position(): { x: number; y: number; z: number };
        projectionFunction(): any;
        projectionFunction(fn: any): this;
        title(): string;
        title(t: string): this;
        subtitle(): string;
        subtitle(t: string): this;
        footnote(): string | false;
        footnote(text: string | false): this;
        footnoteTooltipText(): string | false;
        footnoteTooltipText(text: string | false): this;
        footnoteWrap(): number | false;
        footnoteWrap(chars: number | false): this;
        stat(): StatConfig;
        stat(config: StatConfig): this;
        stat(key: string): StatConfig;
        stat(key: string, config: StatConfig): this;
        statData(): StatData;
        statData(key: string): StatData;
        statData(key: string, data: StatData): this;
        getTime(): string;
        noDataText(): string;
        noDataText(text: string): this;
        language(): string;
        language(lang: string): this;
        legend(): LegendConfig;
        legend(config: false | LegendConfig): this;
        updateLegend(): this;
        tooltip(): TooltipConfig;
        tooltip(config: TooltipConfig): this;
        zoomExtent(): [number, number];
        zoomExtent(extent: [number, number]): this;
        zoomButtons(): boolean;
        zoomButtons(show: boolean): this;
        insets(): false | "default" | InsetConfig[];
        insets(config: false | "default" | InsetConfig[]): this;
        drawGraticule(): boolean;
        drawGraticule(show: boolean): this;
        drawCoastalMargin(): boolean;
        drawCoastalMargin(show: boolean): this;
        coastalMarginSettings(): object;
        coastalMarginSettings(settings: object): this;
        placenames(): boolean;
        placenames(show: boolean): this;
        labels(): object;
        labels(config: object): this;
        annotations(): any;
        annotations(config: any): this;
        stamp(): object;
        stamp(config: { x: number; y: number; text: string; size?: number }): this;
        showScalebar(): boolean;
        showScalebar(show: boolean): this;
        scalebarPosition(): [number, number];
        scalebarPosition(pos: [number, number]): this;
        showEstatLogo(): boolean;
        showEstatLogo(show: boolean): this;
        showEstatRibbon(): boolean;
        showEstatRibbon(show: boolean): this;
        dorlingPadding(): number;
        dorlingPadding(padding: number): this;
        onZoomEnd(): (event: any) => void;
        onZoomEnd(fn: (event: any) => void): this;
        onZoom(): (event: any) => void;
        onZoom(fn: (event: any) => void): this;
        onRegionMouseOver(): (
            event: MouseEvent,
            regionId: string,
            props: any,
        ) => void;
        onRegionMouseOver(
            fn: (event: MouseEvent, regionId: string, props: any) => void,
        ): this;
        onRegionMouseMove(): (
            event: MouseEvent,
            regionId: string,
            props: any,
        ) => void;
        onRegionMouseMove(
            fn: (event: MouseEvent, regionId: string, props: any) => void,
        ): this;
        onRegionMouseOut(): (
            event: MouseEvent,
            regionId: string,
            props: any,
        ) => void;
        onRegionMouseOut(
            fn: (event: MouseEvent, regionId: string, props: any) => void,
        ): this;
        onRegionClick(): (event: MouseEvent, regionId: string, props: any) => void;
        onRegionClick(
            fn: (event: MouseEvent, regionId: string, props: any) => void,
        ): this;
        onBuild(): (map: MapInstance) => void;
        onBuild(callback: (map: MapInstance) => void): this;
        build(): this;
        updateGeoData(): this;
        updateStatData(): this;
        updateStatValues(): this;
        updateClassification(): this;
        updateStyle(): this;
        recalculateLayout(): void;
        exportMapToSVG(): this;
        exportMapToPNG(
            width?: number,
            height?: number,
        ): Promise<ProportionalSymbolMap>;
        setFromURL(): this;
        transitionDuration(): number;
        transitionDuration(ms: number): this;
        filtersDefinitionFunction(): (svg: any, numberOfClasses: number) => void;
        filtersDefinitionFunction(
            fn: (svg: any, numberOfClasses: number) => void,
        ): this;
        regionCentroids(): { id: string; x: number; y: number }[];
        psMaxSize(): number;
        psMaxSize(v: number): this;
        psMinSize(): number;
        psMinSize(v: number): this;
        psMaxValue(): number;
        psMaxValue(v: number): this;
        psMinValue(): number;
        psMinValue(v: number): this;
        psFill(): string;
        psFill(v: string): this;
        psFillOpacity(): number;
        psFillOpacity(v: number): this;
        psStrokeOpacity(): number;
        psStrokeOpacity(v: number): this;
        psStroke(): string;
        psStroke(v: string): this;
        psStrokeWidth(): number;
        psStrokeWidth(v: number): this;
        classifierSize(): any;
        classifierSize(v: any): this;
        classifierColor(): any;
        classifierColor(v: any): this;
        psShape(): string;
        psShape(v: string): this;
        psCustomShape(): any;
        psCustomShape(v: any): this;
        psBarWidth(): number;
        psBarWidth(v: number): this;
        psClassToFillStyle(): any;
        psClassToFillStyle(v: any): this;
        psColorFun(): any;
        psColorFun(v: any): this;
        psSizeScale(): any;
        psSizeScale(v: any): this;
        noDataFillStyle(): string;
        noDataFillStyle(v: string): this;
        psThresholds(): number[];
        psThresholds(v: number[]): this;
        psColors(): string[];
        psColors(v: string[]): this;
        psCustomSVG(): any;
        psCustomSVG(v: any): this;
        psOffset(): { x: number; y: number };
        psOffset(v: { x: number; y: number }): this;
        psClassificationMethod(): string;
        psClassificationMethod(v: string): this;
        psClasses(): number;
        psClasses(v: number): this;
        dorling(): boolean;
        dorling(v: boolean): this;
        dorlingStrength(): any;
        dorlingStrength(v: any): this;
        dorlingIterations(): number;
        dorlingIterations(v: number): this;
        animateDorling(): boolean;
        animateDorling(v: boolean): this;
        psSpikeWidth(): number;
        psSpikeWidth(v: number): this;
        psCodeLabels(): boolean;
        psCodeLabels(v: boolean): this;
        psBrightenFactor(): number;
        psBrightenFactor(v: number): this;
        [key: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any

      Allow additional map-type-specific properties and methods.

    Index

    Methods

    svgId containerId width height geo proj scale nutsLevel nutsYear position projectionFunction title subtitle footnote footnoteTooltipText footnoteWrap stat statData getTime noDataText language legend updateLegend tooltip zoomExtent zoomButtons insets drawGraticule drawCoastalMargin coastalMarginSettings placenames labels annotations stamp showScalebar scalebarPosition showEstatLogo showEstatRibbon dorlingPadding onZoomEnd onZoom onRegionMouseOver onRegionMouseMove onRegionMouseOut onRegionClick onBuild build updateGeoData updateStatData updateStatValues updateClassification updateStyle recalculateLayout exportMapToSVG exportMapToPNG setFromURL transitionDuration filtersDefinitionFunction regionCentroids psMaxSize psMinSize psMaxValue psMinValue psFill psFillOpacity psStrokeOpacity psStroke psStrokeWidth classifierSize classifierColor psShape psCustomShape psBarWidth psClassToFillStyle psColorFun psSizeScale noDataFillStyle psThresholds psColors psCustomSVG psOffset psClassificationMethod psClasses dorling dorlingStrength dorlingIterations animateDorling psSpikeWidth psCodeLabels psBrightenFactor

    Methods

    • Initial map viewport. x/y in projected coordinates, z is pixel size (map units per screen pixel — smaller = more zoomed in).

      Parameters

      • v: { x?: number; y?: number; z?: number }

      Returns this

      map.position({ x: 4800000, y: 3400000, z: 6000 })

    • Returns { x: number; y: number; z: number }

    • Returns the time dimension value from the loaded Eurostat dataset. Useful for displaying the data period in the map title.

      Returns string

      map.onBuild(() => map.title('Population ' + map.getTime()))

    • Builds the map from scratch. Call once after initial configuration.

      Returns this

      eurostatmap.map('choropleth')
        .stat({ eurostatDatasetCode: 'demo_r_d3dens' })
        .build()

    Settings

    Member Visibility

    On This Page

    Methods
    svgIdcontainerIdwidthheightgeoprojscalenutsLevelnutsYearpositionprojectionFunctiontitlesubtitlefootnotefootnoteTooltipTextfootnoteWrapstatstatDatagetTimenoDataTextlanguagelegendupdateLegendtooltipzoomExtentzoomButtonsinsetsdrawGraticuledrawCoastalMargincoastalMarginSettingsplacenameslabelsannotationsstampshowScalebarscalebarPositionshowEstatLogoshowEstatRibbondorlingPaddingonZoomEndonZoomonRegionMouseOveronRegionMouseMoveonRegionMouseOutonRegionClickonBuildbuildupdateGeoDataupdateStatDataupdateStatValuesupdateClassificationupdateStylerecalculateLayoutexportMapToSVGexportMapToPNGsetFromURLtransitionDurationfiltersDefinitionFunctionregionCentroidspsMaxSizepsMinSizepsMaxValuepsMinValuepsFillpsFillOpacitypsStrokeOpacitypsStrokepsStrokeWidthclassifierSizeclassifierColorpsShapepsCustomShapepsBarWidthpsClassToFillStylepsColorFunpsSizeScalenoDataFillStylepsThresholdspsColorspsCustomSVGpsOffsetpsClassificationMethodpsClassesdorlingdorlingStrengthdorlingIterationsanimateDorlingpsSpikeWidthpsCodeLabelspsBrightenFactor