highcharts
Version:
JavaScript charting framework
200 lines (199 loc) • 6.31 kB
JavaScript
/* *
*
* (c) 2010-2021 Torstein Honsi
*
* License: www.highcharts.com/license
*
* !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
*
* */
;
var __extends = (this && this.__extends) || (function () {
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
import AreaRangeSeries from '../AreaRange/AreaRangeSeries.js';
import SeriesRegistry from '../../Core/Series/SeriesRegistry.js';
var SplineSeries = SeriesRegistry.seriesTypes.spline;
import U from '../../Core/Utilities.js';
var merge = U.merge, extend = U.extend;
/* *
*
* Class
*
* */
/**
* The areasplinerange series type.
*
* @private
* @class
* @name Highcharts.seriesTypes.areasplinerange
*
* @augments Highcharts.Series
*/
var AreaSplineRangeSeries = /** @class */ (function (_super) {
__extends(AreaSplineRangeSeries, _super);
function AreaSplineRangeSeries() {
/* *
*
* Static properties
*
* */
var _this = _super !== null && _super.apply(this, arguments) || this;
/* *
*
* Properties
*
* */
_this.options = void 0;
_this.data = void 0;
_this.points = void 0;
return _this;
}
/**
* The area spline range is a cartesian series type with higher and
* lower Y values along an X axis. The area inside the range is colored, and
* the graph outlining the area is a smoothed spline.
*
* @sample {highstock|highstock} stock/demo/areasplinerange/
* Area spline range
*
* @extends plotOptions.arearange
* @since 2.3.0
* @excluding step, boostThreshold, boostBlending
* @product highcharts highstock
* @requires highcharts-more
* @apioption plotOptions.areasplinerange
*/
/**
* @see [fillColor](#plotOptions.areasplinerange.fillColor)
* @see [fillOpacity](#plotOptions.areasplinerange.fillOpacity)
*
* @apioption plotOptions.areasplinerange.color
*/
/**
* @see [color](#plotOptions.areasplinerange.color)
* @see [fillOpacity](#plotOptions.areasplinerange.fillOpacity)
*
* @apioption plotOptions.areasplinerange.fillColor
*/
/**
* @see [color](#plotOptions.areasplinerange.color)
* @see [fillColor](#plotOptions.areasplinerange.fillColor)
*
* @default {highcharts} 0.75
* @default {highstock} 0.75
* @apioption plotOptions.areasplinerange.fillOpacity
*/
AreaSplineRangeSeries.defaultOptions = merge(AreaRangeSeries.defaultOptions);
return AreaSplineRangeSeries;
}(AreaRangeSeries));
extend(AreaSplineRangeSeries.prototype, {
getPointSpline: SplineSeries.prototype.getPointSpline
});
SeriesRegistry.registerSeriesType('areasplinerange', AreaSplineRangeSeries);
/* *
*
* Default export
*
* */
export default AreaSplineRangeSeries;
/* *
*
* API options
*
* */
/**
* A `areasplinerange` series. If the [type](#series.areasplinerange.type)
* option is not specified, it is inherited from [chart.type](#chart.type).
*
* @extends series,plotOptions.areasplinerange
* @excluding dataParser, dataURL, stack, step, boostThreshold, boostBlending
* @product highcharts highstock
* @requires highcharts-more
* @apioption series.areasplinerange
*/
/**
* @see [fillColor](#series.areasplinerange.fillColor)
* @see [fillOpacity](#series.areasplinerange.fillOpacity)
*
* @apioption series.areasplinerange.color
*/
/**
* An array of data points for the series. For the `areasplinerange`
* 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, 0, 5],
* [1, 9, 1],
* [2, 5, 2]
* ]
* ```
*
* 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.areasplinerange.turboThreshold), this option is
* not available.
* ```js
* data: [{
* x: 1,
* low: 5,
* high: 0,
* name: "Point2",
* color: "#00FF00"
* }, {
* x: 1,
* low: 4,
* high: 1,
* 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
*
* @type {Array<Array<(number|string),number>|Array<(number|string),number,number>|*>}
* @extends series.arearange.data
* @product highcharts highstock
* @apioption series.areasplinerange.data
*/
/**
* @see [color](#series.areasplinerange.color)
* @see [fillOpacity](#series.areasplinerange.fillOpacity)
*
* @apioption series.areasplinerange.fillColor
*/
/**
* @see [color](#series.areasplinerange.color)
* @see [fillColor](#series.areasplinerange.fillColor)
*
* @default {highcharts} 0.75
* @default {highstock} 0.75
* @apioption series.areasplinerange.fillOpacity
*/
''; // adds doclets above to transpiled file