Skip to content

Commit 7c38a4a

Browse files
committed
clean up restyle/relayout flag names
1 parent b9826c8 commit 7c38a4a

File tree

75 files changed

+697
-712
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+697
-712
lines changed

src/components/annotations/attributes.js

+43-43
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ module.exports = {
2020
valType: 'boolean',
2121
role: 'info',
2222
dflt: true,
23-
editType: 'docalcAutorange',
23+
editType: 'calcIfAutorange',
2424
description: [
2525
'Determines whether or not this annotation is visible.'
2626
].join(' ')
@@ -29,7 +29,7 @@ module.exports = {
2929
text: {
3030
valType: 'string',
3131
role: 'info',
32-
editType: 'docalcAutorange',
32+
editType: 'calcIfAutorange',
3333
description: [
3434
'Sets the text associated with this annotation.',
3535
'Plotly uses a subset of HTML tags to do things like',
@@ -42,23 +42,23 @@ module.exports = {
4242
valType: 'angle',
4343
dflt: 0,
4444
role: 'style',
45-
editType: 'docalcAutorange',
45+
editType: 'calcIfAutorange',
4646
description: [
4747
'Sets the angle at which the `text` is drawn',
4848
'with respect to the horizontal.'
4949
].join(' ')
5050
},
5151
font: fontAttrs({
52-
editType: 'docalcAutorange',
53-
colorEditType: 'doarraydraw',
52+
editType: 'calcIfAutorange',
53+
colorEditType: 'arraydraw',
5454
description: 'Sets the annotation text font.'
5555
}),
5656
width: {
5757
valType: 'number',
5858
min: 1,
5959
dflt: null,
6060
role: 'style',
61-
editType: 'docalcAutorange',
61+
editType: 'calcIfAutorange',
6262
description: [
6363
'Sets an explicit width for the text box. null (default) lets the',
6464
'text set the box width. Wider text will be clipped.',
@@ -70,7 +70,7 @@ module.exports = {
7070
min: 1,
7171
dflt: null,
7272
role: 'style',
73-
editType: 'docalcAutorange',
73+
editType: 'calcIfAutorange',
7474
description: [
7575
'Sets an explicit height for the text box. null (default) lets the',
7676
'text set the box height. Taller text will be clipped.'
@@ -82,15 +82,15 @@ module.exports = {
8282
max: 1,
8383
dflt: 1,
8484
role: 'style',
85-
editType: 'doarraydraw',
85+
editType: 'arraydraw',
8686
description: 'Sets the opacity of the annotation (text + arrow).'
8787
},
8888
align: {
8989
valType: 'enumerated',
9090
values: ['left', 'center', 'right'],
9191
dflt: 'center',
9292
role: 'style',
93-
editType: 'doarraydraw',
93+
editType: 'arraydraw',
9494
description: [
9595
'Sets the horizontal alignment of the `text` within the box.',
9696
'Has an effect only if `text` spans more two or more lines',
@@ -103,7 +103,7 @@ module.exports = {
103103
values: ['top', 'middle', 'bottom'],
104104
dflt: 'middle',
105105
role: 'style',
106-
editType: 'doarraydraw',
106+
editType: 'arraydraw',
107107
description: [
108108
'Sets the vertical alignment of the `text` within the box.',
109109
'Has an effect only if an explicit height is set to override',
@@ -114,14 +114,14 @@ module.exports = {
114114
valType: 'color',
115115
dflt: 'rgba(0,0,0,0)',
116116
role: 'style',
117-
editType: 'doarraydraw',
117+
editType: 'arraydraw',
118118
description: 'Sets the background color of the annotation.'
119119
},
120120
bordercolor: {
121121
valType: 'color',
122122
dflt: 'rgba(0,0,0,0)',
123123
role: 'style',
124-
editType: 'doarraydraw',
124+
editType: 'arraydraw',
125125
description: [
126126
'Sets the color of the border enclosing the annotation `text`.'
127127
].join(' ')
@@ -131,7 +131,7 @@ module.exports = {
131131
min: 0,
132132
dflt: 1,
133133
role: 'style',
134-
editType: 'docalcAutorange',
134+
editType: 'calcIfAutorange',
135135
description: [
136136
'Sets the padding (in px) between the `text`',
137137
'and the enclosing border.'
@@ -142,7 +142,7 @@ module.exports = {
142142
min: 0,
143143
dflt: 1,
144144
role: 'style',
145-
editType: 'docalcAutorange',
145+
editType: 'calcIfAutorange',
146146
description: [
147147
'Sets the width (in px) of the border enclosing',
148148
'the annotation `text`.'
@@ -153,7 +153,7 @@ module.exports = {
153153
valType: 'boolean',
154154
dflt: true,
155155
role: 'style',
156-
editType: 'docalcAutorange',
156+
editType: 'calcIfAutorange',
157157
description: [
158158
'Determines whether or not the annotation is drawn with an arrow.',
159159
'If *true*, `text` is placed near the arrow\'s tail.',
@@ -163,7 +163,7 @@ module.exports = {
163163
arrowcolor: {
164164
valType: 'color',
165165
role: 'style',
166-
editType: 'doarraydraw',
166+
editType: 'arraydraw',
167167
description: 'Sets the color of the annotation arrow.'
168168
},
169169
arrowhead: {
@@ -172,15 +172,15 @@ module.exports = {
172172
max: ARROWPATHS.length,
173173
dflt: 1,
174174
role: 'style',
175-
editType: 'doarraydraw',
175+
editType: 'arraydraw',
176176
description: 'Sets the annotation arrow head style.'
177177
},
178178
arrowsize: {
179179
valType: 'number',
180180
min: 0.3,
181181
dflt: 1,
182182
role: 'style',
183-
editType: 'docalcAutorange',
183+
editType: 'calcIfAutorange',
184184
description: [
185185
'Sets the size of the annotation arrow head, relative to `arrowwidth`.',
186186
'A value of 1 (default) gives a head about 3x as wide as the line.'
@@ -190,15 +190,15 @@ module.exports = {
190190
valType: 'number',
191191
min: 0.1,
192192
role: 'style',
193-
editType: 'docalcAutorange',
193+
editType: 'calcIfAutorange',
194194
description: 'Sets the width (in px) of annotation arrow line.'
195195
},
196196
standoff: {
197197
valType: 'number',
198198
min: 0,
199199
dflt: 0,
200200
role: 'style',
201-
editType: 'docalcAutorange',
201+
editType: 'calcIfAutorange',
202202
description: [
203203
'Sets a distance, in pixels, to move the arrowhead away from the',
204204
'position it is pointing at, for example to point at the edge of',
@@ -210,7 +210,7 @@ module.exports = {
210210
ax: {
211211
valType: 'any',
212212
role: 'info',
213-
editType: 'docalcAutorange',
213+
editType: 'calcIfAutorange',
214214
description: [
215215
'Sets the x component of the arrow tail about the arrow head.',
216216
'If `axref` is `pixel`, a positive (negative) ',
@@ -223,7 +223,7 @@ module.exports = {
223223
ay: {
224224
valType: 'any',
225225
role: 'info',
226-
editType: 'docalcAutorange',
226+
editType: 'calcIfAutorange',
227227
description: [
228228
'Sets the y component of the arrow tail about the arrow head.',
229229
'If `ayref` is `pixel`, a positive (negative) ',
@@ -241,7 +241,7 @@ module.exports = {
241241
cartesianConstants.idRegex.x.toString()
242242
],
243243
role: 'info',
244-
editType: 'docalc',
244+
editType: 'calc',
245245
description: [
246246
'Indicates in what terms the tail of the annotation (ax,ay) ',
247247
'is specified. If `pixel`, `ax` is a relative offset in pixels ',
@@ -259,7 +259,7 @@ module.exports = {
259259
cartesianConstants.idRegex.y.toString()
260260
],
261261
role: 'info',
262-
editType: 'docalc',
262+
editType: 'calc',
263263
description: [
264264
'Indicates in what terms the tail of the annotation (ax,ay) ',
265265
'is specified. If `pixel`, `ay` is a relative offset in pixels ',
@@ -277,7 +277,7 @@ module.exports = {
277277
cartesianConstants.idRegex.x.toString()
278278
],
279279
role: 'info',
280-
editType: 'docalc',
280+
editType: 'calc',
281281
description: [
282282
'Sets the annotation\'s x coordinate axis.',
283283
'If set to an x axis id (e.g. *x* or *x2*), the `x` position',
@@ -290,7 +290,7 @@ module.exports = {
290290
x: {
291291
valType: 'any',
292292
role: 'info',
293-
editType: 'docalcAutorange',
293+
editType: 'calcIfAutorange',
294294
description: [
295295
'Sets the annotation\'s x position.',
296296
'If the axis `type` is *log*, then you must take the',
@@ -308,7 +308,7 @@ module.exports = {
308308
values: ['auto', 'left', 'center', 'right'],
309309
dflt: 'auto',
310310
role: 'info',
311-
editType: 'docalcAutorange',
311+
editType: 'calcIfAutorange',
312312
description: [
313313
'Sets the text box\'s horizontal position anchor',
314314
'This anchor binds the `x` position to the *left*, *center*',
@@ -327,7 +327,7 @@ module.exports = {
327327
valType: 'number',
328328
dflt: 0,
329329
role: 'style',
330-
editType: 'docalcAutorange',
330+
editType: 'calcIfAutorange',
331331
description: [
332332
'Shifts the position of the whole annotation and arrow to the',
333333
'right (positive) or left (negative) by this many pixels.'
@@ -340,7 +340,7 @@ module.exports = {
340340
cartesianConstants.idRegex.y.toString()
341341
],
342342
role: 'info',
343-
editType: 'docalc',
343+
editType: 'calc',
344344
description: [
345345
'Sets the annotation\'s y coordinate axis.',
346346
'If set to an y axis id (e.g. *y* or *y2*), the `y` position',
@@ -353,7 +353,7 @@ module.exports = {
353353
y: {
354354
valType: 'any',
355355
role: 'info',
356-
editType: 'docalcAutorange',
356+
editType: 'calcIfAutorange',
357357
description: [
358358
'Sets the annotation\'s y position.',
359359
'If the axis `type` is *log*, then you must take the',
@@ -371,7 +371,7 @@ module.exports = {
371371
values: ['auto', 'top', 'middle', 'bottom'],
372372
dflt: 'auto',
373373
role: 'info',
374-
editType: 'docalcAutorange',
374+
editType: 'calcIfAutorange',
375375
description: [
376376
'Sets the text box\'s vertical position anchor',
377377
'This anchor binds the `y` position to the *top*, *middle*',
@@ -390,7 +390,7 @@ module.exports = {
390390
valType: 'number',
391391
dflt: 0,
392392
role: 'style',
393-
editType: 'docalcAutorange',
393+
editType: 'calcIfAutorange',
394394
description: [
395395
'Shifts the position of the whole annotation and arrow up',
396396
'(positive) or down (negative) by this many pixels.'
@@ -401,7 +401,7 @@ module.exports = {
401401
values: [false, 'onoff', 'onout'],
402402
dflt: false,
403403
role: 'style',
404-
editType: 'doarraydraw',
404+
editType: 'arraydraw',
405405
description: [
406406
'Makes this annotation respond to clicks on the plot.',
407407
'If you click a data point that exactly matches the `x` and `y`',
@@ -420,7 +420,7 @@ module.exports = {
420420
xclick: {
421421
valType: 'any',
422422
role: 'info',
423-
editType: 'doarraydraw',
423+
editType: 'arraydraw',
424424
description: [
425425
'Toggle this annotation when clicking a data point whose `x` value',
426426
'is `xclick` rather than the annotation\'s `x` value.'
@@ -429,7 +429,7 @@ module.exports = {
429429
yclick: {
430430
valType: 'any',
431431
role: 'info',
432-
editType: 'doarraydraw',
432+
editType: 'arraydraw',
433433
description: [
434434
'Toggle this annotation when clicking a data point whose `y` value',
435435
'is `yclick` rather than the annotation\'s `y` value.'
@@ -438,7 +438,7 @@ module.exports = {
438438
hovertext: {
439439
valType: 'string',
440440
role: 'info',
441-
editType: 'doarraydraw',
441+
editType: 'arraydraw',
442442
description: [
443443
'Sets text to appear when hovering over this annotation.',
444444
'If omitted or blank, no hover label will appear.'
@@ -448,7 +448,7 @@ module.exports = {
448448
bgcolor: {
449449
valType: 'color',
450450
role: 'style',
451-
editType: 'doarraydraw',
451+
editType: 'arraydraw',
452452
description: [
453453
'Sets the background color of the hover label.',
454454
'By default uses the annotation\'s `bgcolor` made opaque,',
@@ -458,27 +458,27 @@ module.exports = {
458458
bordercolor: {
459459
valType: 'color',
460460
role: 'style',
461-
editType: 'doarraydraw',
461+
editType: 'arraydraw',
462462
description: [
463463
'Sets the border color of the hover label.',
464464
'By default uses either dark grey or white, for maximum',
465465
'contrast with `hoverlabel.bgcolor`.'
466466
].join(' ')
467467
},
468468
font: fontAttrs({
469-
editType: 'doarraydraw',
469+
editType: 'arraydraw',
470470
description: [
471471
'Sets the hover label text font.',
472472
'By default uses the global hover font and size,',
473473
'with color from `hoverlabel.bordercolor`.'
474474
].join(' ')
475475
}),
476-
editType: 'doarraydraw'
476+
editType: 'arraydraw'
477477
},
478478
captureevents: {
479479
valType: 'boolean',
480480
role: 'info',
481-
editType: 'doarraydraw',
481+
editType: 'arraydraw',
482482
description: [
483483
'Determines whether the annotation text box captures mouse move',
484484
'and click events, or allows those events to pass through to data',
@@ -488,13 +488,13 @@ module.exports = {
488488
'you must explicitly enable `captureevents`.'
489489
].join(' ')
490490
},
491-
editType: 'docalc',
491+
editType: 'calc',
492492

493493
_deprecated: {
494494
ref: {
495495
valType: 'string',
496496
role: 'info',
497-
editType: 'docalc',
497+
editType: 'calc',
498498
description: [
499499
'Obsolete. Set `xref` and `yref` separately instead.'
500500
].join(' ')

src/components/annotations3d/attributes.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,4 +90,4 @@ module.exports = overrideAll({
9090
// xref: 'x'
9191
// yref: 'y
9292
// zref: 'z'
93-
}, 'docalc', 'from-root');
93+
}, 'calc', 'from-root');

src/components/calendars/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ var attributes = {
2020
valType: 'enumerated',
2121
values: Object.keys(calendars.calendars),
2222
role: 'info',
23-
editType: 'docalc',
23+
editType: 'calc',
2424
dflt: 'gregorian'
2525
};
2626

src/components/colorbar/attributes.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -192,4 +192,4 @@ module.exports = overrideAll({
192192
'with respect to the color bar.'
193193
].join(' ')
194194
}
195-
}, 'docolorbars', 'from-root');
195+
}, 'colorbars', 'from-root');

0 commit comments

Comments
 (0)