@@ -13,6 +13,11 @@ var axesAttrs = require('../../cartesian/layout_attributes');
13
13
var extendFlat = require ( '../../../lib/extend' ) . extendFlat ;
14
14
var overrideAll = require ( '../../../plot_api/edit_types' ) . overrideAll ;
15
15
16
+ var deprecationWarning = [
17
+ 'Legacy polar charts are deprecated!' ,
18
+ 'Please switch to *polar* subplots.'
19
+ ] . join ( ' ' ) ;
20
+
16
21
var domainAttr = extendFlat ( { } , axesAttrs . domain , {
17
22
description : [
18
23
'Polar chart subplots are not supported yet.' ,
@@ -26,6 +31,7 @@ function mergeAttrs(axisName, nonCommonAttrs) {
26
31
valType : 'boolean' ,
27
32
role : 'style' ,
28
33
description : [
34
+ deprecationWarning ,
29
35
'Determines whether or not the line bounding this' ,
30
36
axisName , 'axis' ,
31
37
'will be shown on the figure.'
@@ -35,6 +41,7 @@ function mergeAttrs(axisName, nonCommonAttrs) {
35
41
valType : 'boolean' ,
36
42
role : 'style' ,
37
43
description : [
44
+ deprecationWarning ,
38
45
'Determines whether or not the' ,
39
46
axisName , 'axis ticks' ,
40
47
'will feature tick labels.'
@@ -45,6 +52,7 @@ function mergeAttrs(axisName, nonCommonAttrs) {
45
52
values : [ 'horizontal' , 'vertical' ] ,
46
53
role : 'style' ,
47
54
description : [
55
+ deprecationWarning ,
48
56
'Sets the orientation (from the paper perspective)' ,
49
57
'of the' , axisName , 'axis tick labels.'
50
58
] . join ( ' ' )
@@ -54,31 +62,36 @@ function mergeAttrs(axisName, nonCommonAttrs) {
54
62
min : 0 ,
55
63
role : 'style' ,
56
64
description : [
65
+ deprecationWarning ,
57
66
'Sets the length of the tick lines on this' , axisName , 'axis.'
58
67
] . join ( ' ' )
59
68
} ,
60
69
tickcolor : {
61
70
valType : 'color' ,
62
71
role : 'style' ,
63
72
description : [
73
+ deprecationWarning ,
64
74
'Sets the color of the tick lines on this' , axisName , 'axis.'
65
75
] . join ( ' ' )
66
76
} ,
67
77
ticksuffix : {
68
78
valType : 'string' ,
69
79
role : 'style' ,
70
80
description : [
81
+ deprecationWarning ,
71
82
'Sets the length of the tick lines on this' , axisName , 'axis.'
72
83
] . join ( ' ' )
73
84
} ,
74
85
endpadding : {
75
86
valType : 'number' ,
76
- role : 'style'
87
+ role : 'style' ,
88
+ description : deprecationWarning ,
77
89
} ,
78
90
visible : {
79
91
valType : 'boolean' ,
80
92
role : 'info' ,
81
93
description : [
94
+ deprecationWarning ,
82
95
'Determines whether or not this axis will be visible.'
83
96
] . join ( ' ' )
84
97
}
@@ -97,6 +110,7 @@ module.exports = overrideAll({
97
110
{ valType : 'number' }
98
111
] ,
99
112
description : [
113
+ deprecationWarning ,
100
114
'Defines the start and end point of this radial axis.'
101
115
] . join ( ' ' )
102
116
} ,
@@ -105,6 +119,7 @@ module.exports = overrideAll({
105
119
valType : 'number' ,
106
120
role : 'style' ,
107
121
description : [
122
+ deprecationWarning ,
108
123
'Sets the orientation (an angle with respect to the origin)' ,
109
124
'of the radial axis.'
110
125
] . join ( ' ' )
@@ -120,6 +135,7 @@ module.exports = overrideAll({
120
135
{ valType : 'number' , dflt : 360 }
121
136
] ,
122
137
description : [
138
+ deprecationWarning ,
123
139
'Defines the start and end point of this angular axis.'
124
140
] . join ( ' ' )
125
141
} ,
@@ -133,16 +149,18 @@ module.exports = overrideAll({
133
149
values : [ 'clockwise' , 'counterclockwise' ] ,
134
150
role : 'info' ,
135
151
description : [
136
- 'For polar plots only.' ,
137
- 'Sets the direction corresponding to positive angles.'
152
+ deprecationWarning ,
153
+ 'Sets the direction corresponding to positive angles' ,
154
+ 'in legacy polar charts.'
138
155
] . join ( ' ' )
139
156
} ,
140
157
orientation : {
141
158
valType : 'angle' ,
142
159
role : 'info' ,
143
160
description : [
144
- 'For polar plots only.' ,
145
- 'Rotates the entire polar by the given angle.'
161
+ deprecationWarning ,
162
+ 'Rotates the entire polar by the given angle' ,
163
+ 'in legacy polar charts.'
146
164
] . join ( ' ' )
147
165
}
148
166
}
0 commit comments