arquero/dist/types/helpers/bin.d.ts

Query processing and transformation of array-backed data tables.

/**
 * Options for binning number values.
 * @typedef {object} BinOptions
 * @property {number} [maxbins] The maximum number of bins.
 * @property {number} [minstep] The minimum step size between bins.
 * @property {number} [step] The exact step size to use between bins.
 *  If specified, the maxbins and minstep options are ignored.
 * @property {boolean} [nice=true] Flag indicating if bins should
 *  snap to "nice" human-friendly values such as multiples of ten.
 * @property {number} [offset=0] Step offset for bin boundaries.
 *  The default floors to the lower bin boundary. A value of 1 snaps
 *  one step higher to the upper bin boundary, and so on.
 */
/**
 * Generate a table expression that performs uniform binning of
 * number values. The resulting string can be used as part of the
 * input to table transformation verbs.
 * @param {string} name The name of the column to bin.
 * @param {BinOptions} [options] Binning scheme options.
 * @return {string} A table expression string for binned values.
 * @example bin('colA', { maxbins: 20 })
 */
export function bin(name: string, options?: BinOptions): string;
/**
 * Options for binning number values.
 */
export type BinOptions = {
    /**
     * The maximum number of bins.
     */
    maxbins?: number;
    /**
     * The minimum step size between bins.
     */
    minstep?: number;
    /**
     * The exact step size to use between bins.
     * If specified, the maxbins and minstep options are ignored.
     */
    step?: number;
    /**
     * Flag indicating if bins should
     * snap to "nice" human-friendly values such as multiples of ten.
     */
    nice?: boolean;
    /**
     * Step offset for bin boundaries.
     * The default floors to the lower bin boundary. A value of 1 snaps
     * one step higher to the upper bin boundary, and so on.
     */
    offset?: number;
};