vega-lite/build/bin.d.ts

Vega-Lite is a concise high-level language for interactive visualization.

import { ExtendedChannel } from './channel.js';
import { ParameterExtent } from './selection.js';
export interface BaseBin {
    /**
     * The number base to use for automatic bin determination (default is base 10).
     *
     * __Default value:__ `10`
     *
     */
    base?: number;
    /**
     * An exact step size to use between bins.
     *
     * __Note:__ If provided, options such as maxbins will be ignored.
     */
    step?: number;
    /**
     * An array of allowable step sizes to choose from.
     * @minItems 1
     */
    steps?: number[];
    /**
     * A minimum allowable step size (particularly useful for integer values).
     */
    minstep?: number;
    /**
     * Scale factors indicating allowable subdivisions. The default value is [5, 2], which indicates that for base 10 numbers (the default base), the method may consider dividing bin sizes by 5 and/or 2. For example, for an initial step size of 10, the method can check if bin sizes of 2 (= 10/5), 5 (= 10/2), or 1 (= 10/(5*2)) might also satisfy the given constraints.
     *
     * __Default value:__ `[5, 2]`
     *
     * @minItems 1
     */
    divide?: [number, number];
    /**
     * Maximum number of bins.
     *
     * __Default value:__ `6` for `row`, `column` and `shape` channels; `10` for other channels
     *
     * @minimum 2
     */
    maxbins?: number;
    /**
     * A value in the binned domain at which to anchor the bins, shifting the bin boundaries if necessary to ensure that a boundary aligns with the anchor value.
     *
     * __Default value:__ the minimum bin extent value
     */
    anchor?: number;
    /**
     * If true, attempts to make the bin boundaries use human-friendly boundaries, such as multiples of ten.
     *
     * __Default value:__ `true`
     */
    nice?: boolean;
}
/**
 * Binning properties or boolean flag for determining whether to bin data or not.
 */
export interface BinParams extends BaseBin {
    /**
     * A two-element (`[min, max]`) array indicating the range of desired bin values.
     */
    extent?: BinExtent;
    /**
     * When set to `true`, Vega-Lite treats the input data as already binned.
     */
    binned?: boolean;
}
export type Bin = boolean | BinParams | 'binned' | null;
export type BinExtent = [number, number] | ParameterExtent;
/**
 * Create a key for the bin configuration. Not for prebinned bin.
 */
export declare function binToString(bin: BinParams | true): string;
/**
 * Vega-Lite should bin the data.
 */
export declare function isBinning(bin: BinParams | boolean | 'binned'): bin is BinParams | true;
/**
 * The data is already binned and so Vega-Lite should not bin it again.
 */
export declare function isBinned(bin: BinParams | boolean | 'binned'): bin is 'binned' | BinParams;
export declare function isBinParams(bin: BinParams | boolean | 'binned'): bin is BinParams;
export declare function isParameterExtent(extent: unknown): extent is ParameterExtent;
export declare function autoMaxBins(channel?: ExtendedChannel): number;
//# sourceMappingURL=bin.d.ts.map