eurostat-map
    Preparing search index...

    Interface GridCartogramSettings

    Settings for grid cartogram layout and geometry.

    interface GridCartogramSettings {
        shape: "hexagon" | "square";
        margins: GridCartogramMargins;
        cellPadding: number;
        countryLabelSettings?: {
            countryLabels?:
                | "code"
                | "name"
                | ((id: string, name: string, region?: any) => string);
            countryLabelFontSize?: number;
            countryLabelMinFontSize?: number;
            countryLabelPadding?: number;
            countryLabelAvoidOverlap?: boolean;
        };
        countryLabels?: | "code"
        | "name"
        | ((id: string, name: string, region?: any) => string);
        countryLabelFontSize?: number;
        countryLabelMinFontSize?: number;
        countryLabelPadding?: number;
        countryLabelAvoidOverlap?: boolean;
        chartOffset: GridCartogramChartOffset;
        positions?: string;
    }
    Index

    Properties

    shape margins cellPadding countryLabelSettings? countryLabels? countryLabelFontSize? countryLabelMinFontSize? countryLabelPadding? countryLabelAvoidOverlap? chartOffset positions?

    Properties

    shape: "hexagon" | "square"

    Grid cell shape.

    margins: GridCartogramMargins

    Margins around the grid drawing area.

    cellPadding: number

    Extra spacing between grid cells in pixels.

    countryLabelSettings?: {
        countryLabels?:
            | "code"
            | "name"
            | ((id: string, name: string, region?: any) => string);
        countryLabelFontSize?: number;
        countryLabelMinFontSize?: number;
        countryLabelPadding?: number;
        countryLabelAvoidOverlap?: boolean;
    }

    Country-label rendering settings for grid cartograms.

    Type Declaration

    • OptionalcountryLabels?: "code" | "name" | ((id: string, name: string, region?: any) => string)

      Show country labels as codes, names, or a custom string.

    • OptionalcountryLabelFontSize?: number

      Base font size for country labels in grid cartograms.

    • OptionalcountryLabelMinFontSize?: number

      Minimum font size allowed when shrinking labels to avoid overlap.

    • OptionalcountryLabelPadding?: number

      Extra padding subtracted from the available label width before fitting.

    • OptionalcountryLabelAvoidOverlap?: boolean

      Disable automatic label shrinking/stretching to avoid overlap.

      true
    countryLabels?:
        | "code"
        | "name"
        | ((id: string, name: string, region?: any) => string)

    Use countryLabelSettings.countryLabels instead.

    countryLabelFontSize?: number

    Use countryLabelSettings.countryLabelFontSize instead.

    countryLabelMinFontSize?: number

    Use countryLabelSettings.countryLabelMinFontSize instead.

    countryLabelPadding?: number

    Use countryLabelSettings.countryLabelPadding instead.

    countryLabelAvoidOverlap?: boolean

    Use countryLabelSettings.countryLabelAvoidOverlap instead.

    chartOffset: GridCartogramChartOffset

    Shared chart offset in grid cells for chart-based map types.

    positions?: string

    Custom grid layout CSV string. If undefined, the built-in layout for the selected shape is used.

    Settings

    Member Visibility

    On This Page

    Properties