highcharts
Version:
JavaScript charting framework
149 lines (148 loc) • 4.46 kB
JavaScript
/* *
*
* (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
*
*
* */
;
/* *
*
* API Options
*
* */
/**
* The column range is a cartesian series type with higher and lower
* Y values along an X axis. To display horizontal bars, set
* [chart.inverted](#chart.inverted) to `true`.
*
* @sample {highcharts|highstock} highcharts/demo/columnrange/
* Inverted column range
*
* @extends plotOptions.column
* @since 2.3.0
* @excluding negativeColor, stacking, softThreshold, threshold
* @product highcharts highstock
* @requires highcharts-more
* @optionparent plotOptions.columnrange
*/
const ColumnRangeSeriesDefaults = {
borderRadius: {
where: 'all'
},
/**
* Extended data labels for range series types. Range series data labels
* have no `x` and `y` options. Instead, they have `xLow`, `xHigh`,
* `yLow` and `yHigh` options to allow the higher and lower data label
* sets individually.
*
* @declare Highcharts.SeriesAreaRangeDataLabelsOptionsObject
* @extends plotOptions.arearange.dataLabels
* @since 2.3.0
* @product highcharts highstock
* @apioption plotOptions.columnrange.dataLabels
*/
pointRange: null,
legendSymbol: 'rectangle',
/** @ignore-option */
marker: null,
states: {
hover: {
/** @ignore-option */
halo: false
}
}
};
/**
* A `columnrange` series. If the [type](#series.columnrange.type)
* option is not specified, it is inherited from
* [chart.type](#chart.type).
*
* @extends series,plotOptions.columnrange
* @excluding dataParser, dataURL, stack, stacking
* @product highcharts highstock
* @requires highcharts-more
* @apioption series.columnrange
*/
/**
* An array of data points for the series. For the `columnrange` series
* type, points can be given in the following ways:
*
* 1. An array of arrays with 3 or 2 values. In this case, the values correspond
* to `x,low,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 2\. 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, 4, 2],
* [1, 2, 1],
* [2, 9, 10]
* ]
* ```
*
* 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.columnrange.turboThreshold), this option is not
* available.
* ```js
* data: [{
* x: 1,
* low: 0,
* high: 4,
* name: "Point2",
* color: "#00FF00"
* }, {
* x: 1,
* low: 5,
* high: 3,
* 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
*
* @basic
* @type {Array<Array<(number|string),number>|Array<(number|string),number,number>|*>}
* @extends series.arearange.data
* @excluding marker
* @product highcharts highstock
* @apioption series.columnrange.data
*/
/**
* @extends series.columnrange.dataLabels
* @product highcharts highstock
* @apioption series.columnrange.data.dataLabels
*/
/**
* @excluding halo, lineWidth, lineWidthPlus, marker
* @product highcharts highstock
* @apioption series.columnrange.states.hover
*/
/**
* @excluding halo, lineWidth, lineWidthPlus, marker
* @product highcharts highstock
* @apioption series.columnrange.states.select
*/
''; // Adds doclets above into transpiled
/* *
*
* Default Export
*
* */
export default ColumnRangeSeriesDefaults;