@jsfkit/types
    Preparing search index...

    Type Alias ChartBinning

    ChartBinning:
        | ChartNumericBinning & { type: "auto" }
        | ChartNumericBinning & { type: "width"; width: number }
        | ChartNumericBinning & { count: integer; type: "count" }
        | { categoryField: string; type: "category" }

    How a bin transform divides values into bins.

    Type Declaration

    • ChartNumericBinning & { type: "auto" }
      • type: "auto"

        The application chooses the bins.

    • ChartNumericBinning & { type: "width"; width: number }
      • type: "width"

        Bins of a fixed width.

      • width: number

        The width of each bin, in the units of the binned values. The bins run on past the largest value, so the last bin can end beyond it, but they stop at an overflow threshold, where the last bin can be narrower.

    • ChartNumericBinning & { count: integer; type: "count" }
      • count: integer

        The number of bins, including the underflow and overflow bins. The regular bins divide the range between the thresholds, or between the smallest and largest values, evenly.

      • type: "count"

        A fixed number of bins, of equal width.

    • { categoryField: string; type: "category" }
      • categoryField: string

        The field holding each record's category.

      • type: "category"

        Each distinct category is its own bin.