vega-lite/build/compositemark/boxplot.d.ts

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

import { Orientation } from 'vega';
import { Encoding } from '../encoding.js';
import { MarkInvalidMixins } from '../invalid.js';
import { NormalizerParams } from '../normalize/index.js';
import { GenericUnitSpec, NormalizedLayerSpec } from '../spec/index.js';
import { CompositeMarkNormalizer } from './base.js';
import { GenericCompositeMarkDef, PartsMixins } from './common.js';
export declare const BOXPLOT: "boxplot";
export type BoxPlot = typeof BOXPLOT;
export declare const BOXPLOT_PARTS: readonly ["box", "median", "outliers", "rule", "ticks"];
type BoxPlotPart = (typeof BOXPLOT_PARTS)[number];
export type BoxPlotPartsMixins = PartsMixins<BoxPlotPart>;
export interface BoxPlotConfig extends BoxPlotPartsMixins {
    /** Size of the box and median tick of a box plot */
    size?: number;
    /**
     * The extent of the whiskers. Available options include:
     * - `"min-max"`: min and max are the lower and upper whiskers respectively.
     * - A number representing multiple of the interquartile range. This number will be multiplied by the IQR to determine whisker boundary, which spans from the smallest data to the largest data within the range _[Q1 - k * IQR, Q3 + k * IQR]_ where _Q1_ and _Q3_ are the first and third quartiles while _IQR_ is the interquartile range (_Q3-Q1_).
     *
     * __Default value:__ `1.5`.
     */
    extent?: 'min-max' | number;
}
export type BoxPlotDef = GenericCompositeMarkDef<BoxPlot> & BoxPlotConfig & MarkInvalidMixins & {
    /**
     * Type of the mark. For box plots, this should always be `"boxplot"`.
     * [boxplot](https://vega.github.io/vega-lite/docs/boxplot.html)
     */
    type: BoxPlot;
    /**
     * Orientation of the box plot. This is normally automatically determined based on types of fields on x and y channels. However, an explicit `orient` be specified when the orientation is ambiguous.
     *
     * __Default value:__ `"vertical"`.
     */
    orient?: Orientation;
};
export interface BoxPlotConfigMixins {
    /**
     * Box Config
     */
    boxplot?: BoxPlotConfig;
}
export declare const boxPlotNormalizer: CompositeMarkNormalizer<"boxplot">;
export declare function getBoxPlotType(extent: number | 'min-max'): "min-max" | "tukey";
export declare function normalizeBoxPlot(spec: GenericUnitSpec<Encoding<string>, BoxPlot | BoxPlotDef>, { config }: NormalizerParams): NormalizedLayerSpec;
export {};
//# sourceMappingURL=boxplot.d.ts.map