/* *
 *
 *  Highcharts funnel module
 *
 *  (c) 2010-2026 Highsoft AS
 *  Author: Torstein Hønsi
 *
 *  Integration of this software requires a license.
 *  - For commercial use, see www.highcharts.com/license
 *  - For non-commercial, see www.highcharts.com/license-eula
 *
 *
 * */

/* *
 *
 *  Imports
 *
 * */

import type FunnelSeriesOptions from '../Funnel/FunnelSeriesOptions';
import type PyramidPointOptions from './PyramidPointOptions';
import type { SeriesStatesOptions } from '../../Core/Series/SeriesOptions';

/* *
 *
 *  Declarations
 *
 * */

/**
 * A `pyramid` series. If the [type](#series.pyramid.type) option is
 * not specified, it is inherited from [chart.type](#chart.type).
 *
 * @extends series,plotOptions.pyramid
 *
 * @excluding boostThreshold, boostBlending, dataParser, dataSorting, dataURL,
 *            legendSymbolColor, stack, xAxis, yAxis
 * @product highcharts
 *
 * @requires modules/funnel
 */
export interface PyramidSeriesOptions extends FunnelSeriesOptions {

    /**
     * An array of data points for the series. For the `pyramid` series
     * type, points can be given in the following ways:
     *
     * 1. An array of numerical values. In this case, the numerical values will
     *  be
     *    interpreted as `y` options. Example:
     *    ```js
     *    data: [0, 5, 3, 5]
     *    ```
     *
     * 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.pyramid.turboThreshold), this option is not
     *    available.
     *    ```js
     *    data: [{
     *        y: 9,
     *        name: "Point2",
     *        color: "#00FF00"
     *    }, {
     *        y: 6,
     *        name: "Point1",
     *        color: "#FF00FF"
     *    }]
     *    ```
     *
     * @sample {highcharts} highcharts/chart/reflow-true/
     *         Numerical values
     *
     * @sample {highcharts} highcharts/series/data-array-of-objects/
     *         Config objects
     *
     * @type {Array<number|null|*>}
     *
     * @extends series.pie.data
     *
     * @excluding sliced
     *
     * @product highcharts
     *
     * @apioption series.pyramid.data
     */
    data?: Array<(number|null|PyramidPointOptions)>;

    /**
     * The pyramid neck height is zero by default, as opposed to the funnel,
     * which shares the same layout logic.
     *
     * @since 3.0.10
     */
    neckHeight?: (number|string);

    /**
     * The pyramid neck width is zero by default, as opposed to the funnel,
     * which shares the same layout logic.
     *
     * @since 3.0.10
     */
    neckWidth?: (number|string);

    /**
     * The pyramid is reversed by default, as opposed to the funnel, which
     * shares the layout engine, and is not reversed.
     *
     * @since 3.0.10
     */
    reversed?: boolean;

    states?: SeriesStatesOptions<PyramidSeriesOptions>;

}

/* *
 *
 *  Default Export
 *
 * */

export default PyramidSeriesOptions;