import type BoxPlotPointOptions from './BoxPlotPointOptions';
import type { ColumnSeriesOptions, ColumnSeriesTooltipOptions } from '../Column/ColumnSeriesOptions';
import type ColorType from '../../Core/Color/ColorType';
import type DashStyleValue from '../../Core/Renderer/DashStyleValue';
import type DataLabelOptions from '../../Core/Series/DataLabelOptions';
import type { PointShortOptions } from '../../Core/Series/PointOptions';
import type { SeriesStatesOptions } from '../../Core/Series/SeriesOptions';
export type BoxPlotPointValKey = 'low' | 'q1' | 'median' | 'q3' | 'high';
export interface BoxPlotDataLabelOptions extends DataLabelOptions {
    /**
     * The point key to use for positioning this data label.
     * Possible values are `low`, `q1`, `median`, `q3` and `high`.
     *
     * @sample {highcharts} highcharts/series-boxplot/data-labels/
     *         Multiple data labels
     *
     * @default high
     *
     * @product highcharts
     */
    alignToKey?: BoxPlotPointValKey;
}
/**
 * A box plot is a convenient way of depicting groups of data through their
 * five-number summaries: the smallest observation (sample minimum), lower
 * quartile (Q1), median (Q2), upper quartile (Q3), and largest observation
 * (sample maximum).
 *
 * A `boxplot` series. If the [type](#series.boxplot.type) option is
 * not specified, it is inherited from [chart.type](#chart.type).
 *
 * @sample highcharts/demo/box-plot/
 *         Box plot
 *
 * @sample {highcharts} highcharts/css/boxplot/
 *         Box plot in styled mode
 *
 * @sample {highcharts} highcharts/series-scatter/jitter-boxplot
 *         Jittered scatter plot on top of a box plot
 *
 * @extends   plotOptions.column
 *
 * @extends   series,plotOptions.boxplot
 *
 * @excluding borderColor, borderWidth, groupZPadding,
 *                states, boostThreshold, boostBlending
 *
 * @excluding dataParser, dataURL, marker, stack, stacking, states,
 *            boostThreshold, boostBlending
 *
 * @product highcharts
 *
 * @requires highcharts-more
 */
export interface BoxPlotSeriesOptions extends ColumnSeriesOptions {
    /**
     * The dash style of the box.
     *
     * @sample {highcharts} highcharts/plotoptions/box-plot-styling/
     *         Box plot styling
     *
     * @sample {highcharts} highcharts/css/boxplot/
     *         Box plot in styled mode
     *
     * @default Solid
     *
     * @since 8.1.0
     *
     * @product highcharts
     */
    boxDashStyle?: DashStyleValue;
    /**
     *
     * @default high
     */
    colorKey?: string;
    /**
     * An array of data points for the series. For the `boxplot` series
     * type, points can be given in the following ways:
     *
     * 1. An array of arrays with 6 or 5 values. In this case, the values
     *  correspond
     *    to `x,low,q1,median,q3,high`. If the first value is a string, it is
     *    applied as the name of the point, and the `x` value is inferred. The
     *  `x`
     *    value can also be omitted, in which case the inner arrays should be of
     *    length 5. Then the `x` value is automatically calculated, either
     *  starting
     *    at 0 and incremented by 1, or from `pointStart` and `pointInterval`
     *  given
     *    in the series options.
     *    ```js
     *    data: [
     *        [0, 3, 0, 10, 3, 5],
     *        [1, 7, 8, 7, 2, 9],
     *        [2, 6, 9, 5, 1, 3]
     *    ]
     *    ```
     *
     * 2. An array of objects with named values. The following snippet shows
     *  only a
     *    few settings, see the complete options set below. If the total number
     *  of
     *    data points exceeds the series'
     *    [turboThreshold](#series.boxplot.turboThreshold), this option is not
     *    available.
     *    ```js
     *    data: [{
     *        x: 1,
     *        low: 4,
     *        q1: 9,
     *        median: 9,
     *        q3: 1,
     *        high: 10,
     *        name: "Point2",
     *        color: "#00FF00"
     *    }, {
     *        x: 1,
     *        low: 5,
     *        q1: 7,
     *        median: 3,
     *        q3: 6,
     *        high: 2,
     *        name: "Point1",
     *        color: "#FF00FF"
     *    }]
     *    ```
     *
     * @sample {highcharts} highcharts/series/data-array-of-arrays/
     *         Arrays of numeric x and y
     *
     * @sample {highcharts} highcharts/series/data-array-of-arrays-datetime/
     *         Arrays of datetime x and y
     *
     * @sample {highcharts} highcharts/series/data-array-of-name-value/
     *         Arrays of point.name and y
     *
     * @sample {highcharts} highcharts/series/data-array-of-objects/
     *         Config objects
     *
     * @extends series.line.data
     *
     * @excluding marker
     *
     * @product highcharts
     */
    data?: Array<(BoxPlotPointOptions | PointShortOptions)>;
    dataLabels?: (BoxPlotDataLabelOptions | Array<BoxPlotDataLabelOptions>);
    /**
     * The fill color of the box.
     *
     * In styled mode, the fill color can be set with the
     * `.highcharts-boxplot-box` class.
     *
     * @sample {highcharts} highcharts/plotoptions/box-plot-styling/
     *         Box plot styling
     *
     * @type {Highcharts.ColorType}
     *
     * @default 'var(--highcharts-background-color)'
     *
     * @since 3.0
     *
     * @product highcharts
     */
    fillColor?: ColorType;
    /**
     * The width of the line surrounding the box. If any of
     * [stemWidth](#plotOptions.boxplot.stemWidth),
     * [medianWidth](#plotOptions.boxplot.medianWidth)
     * or [whiskerWidth](#plotOptions.boxplot.whiskerWidth) are `null`,
     * the lineWidth also applies to these lines.
     *
     * @sample {highcharts} highcharts/plotoptions/box-plot-styling/
     *         Box plot styling
     *
     * @sample {highcharts} highcharts/plotoptions/error-bar-styling/
     *         Error bar styling
     *
     * @since 3.0
     *
     * @product highcharts
     */
    lineWidth?: number;
    /**
     * The length of a BoxPlot point's lower whisker. Overrides
     * [whiskerLength](#boxplot.options.whiskerLength), overridden by
     * [lowerWhiskerLength](#boxplot.point.lowerWhiskerLength).
     *
     * @sample {highcharts} highcharts/series-boxplot/whisker-length
     *         Configuring whisker length
     *
     * @product highcharts
     */
    lowerWhiskerLength?: (number | string);
    /**
     * The color of the median line. If `undefined`, the general series
     * color applies.
     *
     * In styled mode, the median stroke width can be set with the
     * `.highcharts-boxplot-median` class.
     *
     * @sample {highcharts} highcharts/plotoptions/box-plot-styling/
     *         Box plot styling
     *
     * @sample {highcharts} highcharts/css/boxplot/
     *         Box plot in styled mode
     *
     * @sample {highcharts} highcharts/plotoptions/error-bar-styling/
     *         Error bar styling
     *
     * @type {Highcharts.ColorType}
     *
     * @since 3.0
     *
     * @product highcharts
     */
    medianColor?: ColorType;
    /**
     * The dash style of the median.
     *
     * @sample {highcharts} highcharts/plotoptions/box-plot-styling/
     *         Box plot styling
     *
     * @sample {highcharts} highcharts/css/boxplot/
     *         Box plot in styled mode
     *
     * @default Solid
     *
     * @since 8.1.0
     *
     * @product highcharts
     */
    medianDashStyle?: DashStyleValue;
    /**
     * The pixel width of the median line. If `null`, the
     * [lineWidth](#plotOptions.boxplot.lineWidth) is used.
     *
     * In styled mode, the median stroke width can be set with the
     * `.highcharts-boxplot-median` class.
     *
     * @sample {highcharts} highcharts/plotoptions/box-plot-styling/
     *         Box plot styling
     *
     * @sample {highcharts} highcharts/css/boxplot/
     *         Box plot in styled mode
     *
     * @since 3.0
     *
     * @product highcharts
     */
    medianWidth?: number;
    states?: SeriesStatesOptions<BoxPlotSeriesOptions>;
    /**
     * The color of the stem, the vertical line extending from the box to
     * the whiskers. If `undefined`, the series color is used.
     *
     * In styled mode, the stem stroke can be set with the
     * `.highcharts-boxplot-stem` class.
     *
     * @sample {highcharts} highcharts/plotoptions/box-plot-styling/
     *         Box plot styling
     *
     * @sample {highcharts} highcharts/css/boxplot/
     *         Box plot in styled mode
     *
     * @sample {highcharts} highcharts/plotoptions/error-bar-styling/
     *         Error bar styling
     *
     * @type {Highcharts.ColorType}
     *
     * @since 3.0
     *
     * @product highcharts
     */
    stemColor?: ColorType;
    /**
     * The dash style of the stem, the vertical line extending from the
     * box to the whiskers.
     *
     * @sample {highcharts} highcharts/plotoptions/box-plot-styling/
     *         Box plot styling
     *
     * @sample {highcharts} highcharts/css/boxplot/
     *         Box plot in styled mode
     *
     * @sample {highcharts} highcharts/plotoptions/error-bar-styling/
     *         Error bar styling
     *
     * @default Solid
     *
     * @since 3.0
     *
     * @product highcharts
     */
    stemDashStyle?: DashStyleValue;
    /**
     * The width of the stem, the vertical line extending from the box to
     * the whiskers. If `undefined`, the width is inherited from the
     * [lineWidth](#plotOptions.boxplot.lineWidth) option.
     *
     * In styled mode, the stem stroke width can be set with the
     * `.highcharts-boxplot-stem` class.
     *
     * @sample {highcharts} highcharts/plotoptions/box-plot-styling/
     *         Box plot styling
     *
     * @sample {highcharts} highcharts/css/boxplot/
     *         Box plot in styled mode
     *
     * @sample {highcharts} highcharts/plotoptions/error-bar-styling/
     *         Error bar styling
     *
     * @since 3.0
     *
     * @product highcharts
     */
    stemWidth?: number;
    /**
     * The Y axis value to serve as the base for the columns, for
     * distinguishing between values above and below a threshold. If `null`,
     * the columns extend from the padding Y axis minimum.
     *
     * @default null
     * @since 2.0
     * @product highcharts
     */
    threshold?: ColumnSeriesOptions['threshold'];
    tooltip?: BoxPlotSeriesTooltipOptions;
    /**
     * The length of a BoxPlot point's upper whisker. Overrides
     * [whiskerLength](#boxplot.options.whiskerLength), overridden by
     * [upperWhiskerLength](#boxplot.point.upperWhiskerLength).
     *
     * @sample {highcharts} highcharts/series-boxplot/whisker-length
     *         Configuring whisker length
     *
     * @product highcharts
     */
    upperWhiskerLength?: (number | string);
    /**
     * The color of the whiskers, the horizontal lines marking low and high
     * values. When `undefined`, the general series color is used.
     *
     * In styled mode, the whisker stroke can be set with the
     * `.highcharts-boxplot-whisker` class.
     *
     * @sample {highcharts} highcharts/plotoptions/box-plot-styling/
     *         Box plot styling
     *
     * @sample {highcharts} highcharts/css/boxplot/
     *         Box plot in styled mode
     *
     * @type {Highcharts.ColorType}
     *
     * @since 3.0
     *
     * @product highcharts
     */
    whiskerColor?: ColorType;
    /**
     * The dash style of the whiskers.
     *
     * @sample {highcharts} highcharts/plotoptions/box-plot-styling/
     *         Box plot styling
     *
     * @sample {highcharts} highcharts/css/boxplot/
     *         Box plot in styled mode
     *
     * @default Solid
     *
     * @since 8.1.0
     *
     * @product highcharts
     */
    whiskerDashStyle?: DashStyleValue;
    /**
     * The length of the whiskers, the horizontal lines marking low and
     * high values. It can be a numerical pixel value, or a percentage
     * value of the box width. Set `0` to disable whiskers.
     *
     * Individual lengths for upper and lower whiskers can be defined on the
     * boxplot series and on specific boxplot points. Whisker lengths defined
     * on points override whisker lengths defined on a boxplot series.
     *
     * Overridden by [whiskerLength](#boxplot.point.whiskerLength),
     * [upperWhiskerLength](#boxplot.point.upperWhiskerLength), and
     * [lowerWhiskerLength](#boxplot.point.lowerWhiskerLength)
     *
     * @sample {highcharts} highcharts/plotoptions/box-plot-styling/
     *         Box plot styling
     *
     * @sample {highcharts} highcharts/series-boxplot/whisker-length
     *         Configuring whisker lengths
     *
     * @since 3.0
     *
     * @product highcharts
     */
    whiskerLength?: (number | string);
    /**
     * The line width of the whiskers, the horizontal lines marking low and
     * high values. When `undefined`, the general
     * [lineWidth](#plotOptions.boxplot.lineWidth) applies.
     *
     * In styled mode, the whisker stroke width can be set with the
     * `.highcharts-boxplot-whisker` class.
     *
     * @sample {highcharts} highcharts/plotoptions/box-plot-styling/
     *         Box plot styling
     *
     * @sample {highcharts} highcharts/css/boxplot/
     *         Box plot in styled mode
     *
     * @since 3.0
     *
     * @product highcharts
     */
    whiskerWidth?: number;
}
export interface BoxPlotSeriesTooltipOptions extends ColumnSeriesTooltipOptions {
    /**
     * @default '<span style="color:{point.color}">\u25CF</span> <b>{series.name}</b><br/>Maximum: {point.high}<br/>Upper quartile: {point.q3}<br/>Median: {point.median}<br/>Lower quartile: {point.q1}<br/>Minimum: {point.low}<br/>'
     */
    pointFormat?: ColumnSeriesTooltipOptions['pointFormat'];
}
export default BoxPlotSeriesOptions;