pyramid3d.src.js 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122
  1. /* *
  2. *
  3. * Highcharts pyramid3d series module
  4. *
  5. * (c) 2010-2019 Highsoft AS
  6. * Author: Kacper Madej
  7. *
  8. * License: www.highcharts.com/license
  9. *
  10. * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
  11. *
  12. * */
  13. 'use strict';
  14. import H from '../parts/Globals.js';
  15. import '../parts/Utilities.js';
  16. import '../parts/ColumnSeries.js';
  17. import '../parts/SvgRenderer.js';
  18. var seriesType = H.seriesType;
  19. /**
  20. * The pyramid3d series type.
  21. *
  22. * @constructor seriesTypes.pyramid3d
  23. * @augments seriesTypes.funnel3d
  24. * @requires highcharts-3d
  25. * @requires modules/cylinder
  26. * @requires modules/funnel3d
  27. * @requires modules/pyramid3d
  28. */
  29. seriesType('pyramid3d', 'funnel3d',
  30. /**
  31. * A pyramid3d is a 3d version of pyramid series type. Pyramid charts are
  32. * a type of chart often used to visualize stages in a sales project,
  33. * where the top are the initial stages with the most clients.
  34. *
  35. * @sample highcharts/demo/pyramid3d/
  36. * Pyramid3d
  37. *
  38. * @extends plotOptions.funnel3d
  39. * @excluding neckHeight, neckWidth
  40. * @product highcharts
  41. * @since 7.1.0
  42. * @requires highcharts-3d
  43. * @requires modules/cylinder
  44. * @requires modules/funnel3d
  45. * @requires modules/pyramid3d
  46. * @optionparent plotOptions.pyramid3d
  47. */
  48. {
  49. /**
  50. * A reversed pyramid3d is funnel3d, but the latter supports neck
  51. * related options: neckHeight and neckWidth
  52. *
  53. * @product highcharts
  54. */
  55. reversed: true,
  56. neckHeight: 0,
  57. neckWidth: 0,
  58. dataLabels: {
  59. verticalAlign: 'top'
  60. }
  61. });
  62. /**
  63. * A `pyramid3d` series. If the [type](#series.pyramid3d.type) option is
  64. * not specified, it is inherited from [chart.type](#chart.type).
  65. *
  66. * @since 7.1.0
  67. * @extends series,plotOptions.pyramid3d
  68. * @excluding allAreas,boostThreshold,colorAxis,compare,compareBase
  69. * @product highcharts
  70. * @sample {highcharts} highcharts/demo/pyramid3d/ Pyramid3d
  71. * @requires modules/pyramid3d
  72. * @apioption series.pyramid3d
  73. */
  74. /**
  75. * An array of data points for the series. For the `pyramid3d` series
  76. * type, points can be given in the following ways:
  77. *
  78. * 1. An array of numerical values. In this case, the numerical values
  79. * will be interpreted as `y` options. The `x` values will be automatically
  80. * calculated, either starting at 0 and incremented by 1, or from `pointStart`
  81. * and `pointInterval` given in the series options. If the axis has
  82. * categories, these will be used. Example:
  83. *
  84. * ```js
  85. * data: [0, 5, 3, 5]
  86. * ```
  87. *
  88. * 2. An array of objects with named values. The following snippet shows only a
  89. * few settings, see the complete options set below. If the total number of data
  90. * points exceeds the series'
  91. * [turboThreshold](#series.pyramid3d.turboThreshold),
  92. * this option is not available.
  93. *
  94. * ```js
  95. * data: [{
  96. * y: 2,
  97. * name: "Point2",
  98. * color: "#00FF00"
  99. * }, {
  100. * y: 4,
  101. * name: "Point1",
  102. * color: "#FF00FF"
  103. * }]
  104. * ```
  105. *
  106. * @sample {highcharts} highcharts/chart/reflow-true/
  107. * Numerical values
  108. * @sample {highcharts} highcharts/series/data-array-of-arrays/
  109. * Arrays of numeric x and y
  110. * @sample {highcharts} highcharts/series/data-array-of-arrays-datetime/
  111. * Arrays of datetime x and y
  112. * @sample {highcharts} highcharts/series/data-array-of-name-value/
  113. * Arrays of point.name and y
  114. * @sample {highcharts} highcharts/series/data-array-of-objects/
  115. * Config objects
  116. *
  117. * @type {Array<number|Array<number>|*>}
  118. * @extends series.funnel3d.data
  119. * @product highcharts
  120. * @apioption series.pyramid3d.data
  121. */
  122. ''; // adds doclets above to the transpiled file