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