/* *
 *
 *  (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 DataLabelOptions from '../../Core/Series/DataLabelOptions';
import type GaugeSeriesOptions from '../Gauge/GaugeSeriesOptions';
import type SolidGaugePointOptions from './SolidGaugePointOptions';
import type { SeriesStatesOptions } from '../../Core/Series/SeriesOptions';

/* *
 *
 *  Declarations
 *
 * */


/**
 * A solid gauge is a circular gauge where the value is indicated by a filled
 * arc, and the color of the arc may variate with the value.
 *
 * A `solidgauge` series. If the [type](#series.solidgauge.type) option is not
 * specified, it is inherited from [chart.type](#chart.type).
 *
 * @sample highcharts/demo/gauge-solid/
 *         Solid gauges
 *
 * @extends plotOptions.gauge
 *
 * @extends series,plotOptions.solidgauge
 *
 * @excluding dial, pivot, wrap
 *
 * @excluding animationLimit, boostThreshold, connectEnds, connectNulls,
 *            cropThreshold, dashStyle, dataParser, dataURL, dial,
 *            findNearestPointBy, getExtremesFromAll, marker, negativeColor,
 *            pointPlacement, pivot, shadow, softThreshold, stack, stacking,
 *            states, step, threshold, turboThreshold, wrap, zoneAxis, zones,
 *            dataSorting, boostBlending
 *
 * @product highcharts
 *
 * @requires modules/solid-gauge
 */
export interface SolidGaugeSeriesOptions extends GaugeSeriesOptions {

    /**
     * The corner radius of the border surrounding solid gauge. A number
     * signifies pixels and percentage string, like for example `50%`,
     * signifies a relative size.
     *
     * @sample highcharts/series-solidgauge/pane-borderradius
     *         Solid gauge with rounded border.
     */
    borderRadius?: number | string;

    /**
     * Whether to give each point an individual color.
     */
    colorByPoint?: boolean;

    /**
     * An array of data points for the series. For the `solidgauge` 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.solidgauge.turboThreshold), this option is
     *  not
     *    available.
     *    ```js
     *    data: [{
     *        y: 5,
     *        name: "Point2",
     *        color: "#00FF00"
     *    }, {
     *        y: 7,
     *        name: "Point1",
     *        color: "#FF00FF"
     *    }]
     *    ```
     *
     * The typical gauge only contains a single data value.
     *
     * @sample {highcharts} highcharts/chart/reflow-true/
     *         Numerical values
     *
     * @sample {highcharts} highcharts/series/data-array-of-objects/
     *         Config objects
     *
     * @type {Array<number|null|*>}
     *
     * @extends series.gauge.data
     *
     * @product highcharts
     *
     * @apioption series.solidgauge.data
     */
    data?: Array<(number|null|SolidGaugePointOptions)>;

    dataLabels?: Partial<DataLabelOptions>;

    /**
     * The inner radius for points in a solid gauge. Can be given either as a
     * pixel value (number), or as a percentage string, like `"50%"`. Defaults
     * to match the `pane.innerSize`.
     *
     * @sample {highcharts} highcharts/plotoptions/solidgauge-radius/
     *         Individual radius and innerRadius
     *
     * @default undefined
     *
     * @since 4.1.6
     *
     * @product highcharts
     */
    innerRadius?: string;

    /**
     * Whether the strokes of the solid gauge should be `round` or `square`.
     *
     * @sample {highcharts} highcharts/demo/gauge-multiple-kpi/
     *         Rounded gauge
     *
     * @default round
     *
     * @since 4.2.2
     *
     * @product highcharts
     */
    linecap?: ('butt'|'round'|'square');

    /**
     * Allow the gauge to overshoot the end of the perimeter axis by this
     * many degrees. Say if the gauge axis goes from 0 to 60, a value of
     * 100, or 1000, will show 5 degrees beyond the end of the axis when this
     * option is set to 5.
     *
     * @default 0
     *
     * @since 3.0.10
     *
     * @product highcharts
     */
    overshoot?: number;

    /**
     * The outer radius for points in a solid gauge. Can be given either as a
     * pixel value (number), or as a percentage string, like `"100%"`. Defaults
     * to match the `pane.size`.
     *
     * @sample {highcharts} highcharts/plotoptions/solidgauge-radius/
     *         Individual radius and innerRadius
     *
     * @default undefined
     *
     * @since 4.1.6
     *
     * @product highcharts
     */
    radius?: string;

    /**
     * Whether to draw rounded edges on the gauge. This options adds the radius
     * of the rounding to the ends of the arc, so it extends past the actual
     * values. When `borderRadius` is set, it takes precedence over `rounded`. A
     * `borderRadius` of 50% behaves like `rounded`, except the shape is not
     * extended past its value.
     *
     * @sample {highcharts} highcharts/demo/gauge-multiple-kpi/
     *         Gauge showing multiple KPIs
     *
     * @default false
     *
     * @since 5.0.8
     *
     * @product highcharts
     */
    rounded?: boolean;

    states?: SeriesStatesOptions<SolidGaugeSeriesOptions>;

    /**
     * The threshold or base level for the gauge.
     *
     * @sample {highcharts} highcharts/plotoptions/solidgauge-threshold/
     *         Zero threshold with negative and positive values
     *
     * @since 5.0.3
     *
     * @product highcharts
     */
    threshold?: number;

}

/* *
 *
 *  Default Export
 *
 * */

export default SolidGaugeSeriesOptions;