Lumagrid
    Preparing search index...

    Interface HeatmapProps

    Props for Heatmap.

    interface HeatmapProps {
        ariaLabel?: string;
        colorField?: string;
        columnField?: string;
        data: TransformedData;
        height: number;
        idField?: string;
        labelField?: string;
        onSelect?: (cell: HeatmapCell) => void;
        rowField?: string;
        showLegend?: boolean;
        showValues?: boolean;
        theme: ThemeDefinition;
        valueField?: 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).

    columnField?: string

    Field naming the column of each cell. Default: labelField, then the first string field.

    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.

    onSelect?: (cell: HeatmapCell) => void

    Called when a cell is clicked or activated with Enter/Space.

    rowField?: string

    Field naming the row of each cell. Default: the second string field.

    showLegend?: boolean

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

    showValues?: boolean

    Render the value inside each cell. Default: true.

    valueField?: string

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

    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.