MAIDR Documentation - v4.4.0
    Preparing search index...

    Interface HexbinDeclaration

    Hexagonal binning: the standard answer to an overplotted scatter.

    A lattice of cells each carrying a count, with the one difference that decides its navigation: a hex lattice staggers alternate rows, so a column index does not identify a position and each bin carries its own centre.

    interface HexbinDeclaration {
        title?: string;
        name?: string;
        type: HEXBIN;
        x?: string;
        y?: string;
        count?: string;
        row?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    title?: string

    Overrides the layer's announced title. Maps to MaidrLayer.title.

    Names the chart; use DeclarationBase.name to say which layer of it this is.

    name?: string

    Names this layer among sibling layers. Maps to MaidrLayer.name.

    Announced on a layer switch in place of the trace type, so a hue-split figure says "Male" and "Female" rather than "error_bar plot" twice.

    type: HEXBIN

    TraceType.HEXBIN — the string 'hexbin'.

    x?: string

    Field holding the bin's centre along the x axis, in data units. Maps to HexbinPoint.x.

    Screen coordinates would announce every bin's position in pixels.

    The chain is a hexbin's own: x names a bin centre here and a category, a lane or a quantile on other charts, so no chain could be shared. It is the shipped d3 hexbin binder's, which is where these bins are already read from.

    'x', falling back to x0 or cx

    y?: string

    Field holding the bin's centre along the y axis, in data units. Maps to HexbinPoint.y.

    'y', falling back to y0 or cy

    count?: string

    Field holding how many points fell in the bin. Maps to HexbinPoint.count.

    The length fallback is what makes a d3-hexbin bin work untouched: its bins are arrays of the points that fell in them.

    'count', falling back to length, value, n or total

    row?: string

    Field holding the lattice row a bin sits on, for data that names it.

    Omitted, rows are grouped by identical y, which is what a lattice computed by the usual libraries produces.