Lumagrid
    Preparing search index...

    Interface ChoroplethProps

    Props for Choropleth.

    interface ChoroplethProps {
        ariaLabel?: string;
        colorField?: string;
        data: TransformedData;
        height: number;
        idField?: string;
        labelField?: string;
        projectedPaths?: Record<string, string>;
        showLabels?: boolean;
        showLegend?: boolean;
        theme: ThemeDefinition;
        valueField?: string;
        valueProperty?: string;
        width: number;
        xField?: string;
        yField?: string;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index
    ariaLabel?: string
    colorField?: string

    Groups rows into colored series (LineChart).

    height: number
    idField?: string

    Identifies a node (ForceGraph).

    labelField?: string

    Category or display label: bar label, line x category, pie slice label, force-graph node label.

    projectedPaths?: Record<string, string>

    Optional pre-projected path strings. If provided, the component skips projection and uses these strings directly (useful with D3 projection). Keys must match feature IDs.

    showLabels?: boolean

    Render a text label (name and value) on each tile. Default: true.

    showLegend?: boolean

    Render a min..max color-scale legend. Default: true.

    valueField?: string

    Numeric measure: bar length, line y value, pie slice size, choropleth color value.

    valueProperty?: string

    Property in each feature's properties to map to color. Takes precedence over valueField.

    width: number
    xField?: string

    Use valueField, labelField or idField (the mapping depends on the chart, see CHANGELOG.md). Removed in 2.0.

    yField?: string

    Use valueField, labelField or idField (the mapping depends on the chart, see CHANGELOG.md). Removed in 2.0.