AreaSplineRangeSeries.js 3.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. /* *
  2. *
  3. * (c) 2010-2020 Torstein Honsi
  4. *
  5. * License: www.highcharts.com/license
  6. *
  7. * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
  8. *
  9. * */
  10. 'use strict';
  11. import H from '../Core/Globals.js';
  12. import U from '../Core/Utilities.js';
  13. var seriesType = U.seriesType;
  14. import '../Core/Options.js';
  15. var seriesTypes = H.seriesTypes;
  16. /**
  17. * The area spline range is a cartesian series type with higher and
  18. * lower Y values along an X axis. The area inside the range is colored, and
  19. * the graph outlining the area is a smoothed spline.
  20. *
  21. * @sample {highstock|highstock} stock/demo/areasplinerange/
  22. * Area spline range
  23. *
  24. * @extends plotOptions.arearange
  25. * @since 2.3.0
  26. * @excluding step, boostThreshold, boostBlending
  27. * @product highcharts highstock
  28. * @requires highcharts-more
  29. * @apioption plotOptions.areasplinerange
  30. */
  31. seriesType('areasplinerange', 'arearange', null, {
  32. getPointSpline: seriesTypes.spline.prototype.getPointSpline
  33. });
  34. /**
  35. * A `areasplinerange` series. If the [type](#series.areasplinerange.type)
  36. * option is not specified, it is inherited from [chart.type](#chart.type).
  37. *
  38. * @extends series,plotOptions.areasplinerange
  39. * @excluding dataParser, dataURL, stack, step, boostThreshold, boostBlending
  40. * @product highcharts highstock
  41. * @requires highcharts-more
  42. * @apioption series.areasplinerange
  43. */
  44. /**
  45. * An array of data points for the series. For the `areasplinerange`
  46. * series type, points can be given in the following ways:
  47. *
  48. * 1. An array of arrays with 3 or 2 values. In this case, the values correspond
  49. * to `x,low,high`. If the first value is a string, it is applied as the name
  50. * of the point, and the `x` value is inferred. The `x` value can also be
  51. * omitted, in which case the inner arrays should be of length 2\. Then the
  52. * `x` value is automatically calculated, either starting at 0 and
  53. * incremented by 1, or from `pointStart` and `pointInterval` given in the
  54. * series options.
  55. * ```js
  56. * data: [
  57. * [0, 0, 5],
  58. * [1, 9, 1],
  59. * [2, 5, 2]
  60. * ]
  61. * ```
  62. *
  63. * 2. An array of objects with named values. The following snippet shows only a
  64. * few settings, see the complete options set below. If the total number of
  65. * data points exceeds the series'
  66. * [turboThreshold](#series.areasplinerange.turboThreshold), this option is
  67. * not available.
  68. * ```js
  69. * data: [{
  70. * x: 1,
  71. * low: 5,
  72. * high: 0,
  73. * name: "Point2",
  74. * color: "#00FF00"
  75. * }, {
  76. * x: 1,
  77. * low: 4,
  78. * high: 1,
  79. * name: "Point1",
  80. * color: "#FF00FF"
  81. * }]
  82. * ```
  83. *
  84. * @sample {highcharts} highcharts/series/data-array-of-arrays/
  85. * Arrays of numeric x and y
  86. * @sample {highcharts} highcharts/series/data-array-of-arrays-datetime/
  87. * Arrays of datetime x and y
  88. * @sample {highcharts} highcharts/series/data-array-of-name-value/
  89. * Arrays of point.name and y
  90. * @sample {highcharts} highcharts/series/data-array-of-objects/
  91. * Config objects
  92. *
  93. * @type {Array<Array<(number|string),number>|Array<(number|string),number,number>|*>}
  94. * @extends series.arearange.data
  95. * @product highcharts highstock
  96. * @apioption series.areasplinerange.data
  97. */
  98. ''; // adds doclets above to transpiled file