-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlayout-schema.json
10943 lines (10943 loc) · 456 KB
/
layout-schema.json
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"layout": {
"layoutAttributes": {
"_deprecated": {
"title": {
"description": "Value of `title` is no longer a simple *string* but a set of sub-attributes. To set the contents of the title, please use `title.text` now.",
"editType": "layoutstyle",
"valType": "string"
},
"titlefont": {
"color": {
"editType": "layoutstyle",
"valType": "color"
},
"description": "Former `titlefont` is now the sub-attribute `font` of `title`. To customize title font properties, please use `title.font` now.",
"editType": "layoutstyle",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*,, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
"editType": "layoutstyle",
"noBlank": true,
"strict": true,
"valType": "string"
},
"size": {
"editType": "layoutstyle",
"min": 1,
"valType": "number"
}
}
},
"activeshape": {
"editType": "none",
"fillcolor": {
"description": "Sets the color filling the active shape' interior.",
"dflt": "rgb(255,0,255)",
"editType": "none",
"valType": "color"
},
"opacity": {
"description": "Sets the opacity of the active shape.",
"dflt": 0.5,
"editType": "none",
"max": 1,
"min": 0,
"valType": "number"
},
"role": "object"
},
"annotations": {
"items": {
"annotation": {
"_deprecated": {
"ref": {
"description": "Obsolete. Set `xref` and `yref` separately instead.",
"editType": "calc",
"valType": "string"
}
},
"align": {
"description": "Sets the horizontal alignment of the `text` within the box. Has an effect only if `text` spans two or more lines (i.e. `text` contains one or more <br> HTML tags) or if an explicit width is set to override the text width.",
"dflt": "center",
"editType": "arraydraw",
"valType": "enumerated",
"values": [
"left",
"center",
"right"
]
},
"arrowcolor": {
"description": "Sets the color of the annotation arrow.",
"editType": "arraydraw",
"valType": "color"
},
"arrowhead": {
"description": "Sets the end annotation arrow head style.",
"dflt": 1,
"editType": "arraydraw",
"max": 8,
"min": 0,
"valType": "integer"
},
"arrowside": {
"description": "Sets the annotation arrow head position.",
"dflt": "end",
"editType": "arraydraw",
"extras": [
"none"
],
"flags": [
"end",
"start"
],
"valType": "flaglist"
},
"arrowsize": {
"description": "Sets the size of the end annotation arrow head, relative to `arrowwidth`. A value of 1 (default) gives a head about 3x as wide as the line.",
"dflt": 1,
"editType": "calc+arraydraw",
"min": 0.3,
"valType": "number"
},
"arrowwidth": {
"description": "Sets the width (in px) of annotation arrow line.",
"editType": "calc+arraydraw",
"min": 0.1,
"valType": "number"
},
"ax": {
"description": "Sets the x component of the arrow tail about the arrow head. If `axref` is `pixel`, a positive (negative) component corresponds to an arrow pointing from right to left (left to right). If `axref` is not `pixel` and is exactly the same as `xref`, this is an absolute value on that axis, like `x`, specified in the same coordinates as `xref`.",
"editType": "calc+arraydraw",
"valType": "any"
},
"axref": {
"description": "Indicates in what coordinates the tail of the annotation (ax,ay) is specified. If set to a ax axis id (e.g. *ax* or *ax2*), the `ax` position refers to a ax coordinate. If set to *paper*, the `ax` position refers to the distance from the left of the plotting area in normalized coordinates where *0* (*1*) corresponds to the left (right). If set to a ax axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., *ax2 domain* refers to the domain of the second ax axis and a ax position of 0.5 refers to the point between the left and the right of the domain of the second ax axis. In order for absolute positioning of the arrow to work, *axref* must be exactly the same as *xref*, otherwise *axref* will revert to *pixel* (explained next). For relative positioning, *axref* can be set to *pixel*, in which case the *ax* value is specified in pixels relative to *x*. Absolute positioning is useful for trendline annotations which should continue to indicate the correct trend when zoomed. Relative positioning is useful for specifying the text offset for an annotated point.",
"dflt": "pixel",
"editType": "calc",
"valType": "enumerated",
"values": [
"pixel",
"/^x([2-9]|[1-9][0-9]+)?( domain)?$/"
]
},
"ay": {
"description": "Sets the y component of the arrow tail about the arrow head. If `ayref` is `pixel`, a positive (negative) component corresponds to an arrow pointing from bottom to top (top to bottom). If `ayref` is not `pixel` and is exactly the same as `yref`, this is an absolute value on that axis, like `y`, specified in the same coordinates as `yref`.",
"editType": "calc+arraydraw",
"valType": "any"
},
"ayref": {
"description": "Indicates in what coordinates the tail of the annotation (ax,ay) is specified. If set to a ay axis id (e.g. *ay* or *ay2*), the `ay` position refers to a ay coordinate. If set to *paper*, the `ay` position refers to the distance from the bottom of the plotting area in normalized coordinates where *0* (*1*) corresponds to the bottom (top). If set to a ay axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., *ay2 domain* refers to the domain of the second ay axis and a ay position of 0.5 refers to the point between the bottom and the top of the domain of the second ay axis. In order for absolute positioning of the arrow to work, *ayref* must be exactly the same as *yref*, otherwise *ayref* will revert to *pixel* (explained next). For relative positioning, *ayref* can be set to *pixel*, in which case the *ay* value is specified in pixels relative to *y*. Absolute positioning is useful for trendline annotations which should continue to indicate the correct trend when zoomed. Relative positioning is useful for specifying the text offset for an annotated point.",
"dflt": "pixel",
"editType": "calc",
"valType": "enumerated",
"values": [
"pixel",
"/^y([2-9]|[1-9][0-9]+)?( domain)?$/"
]
},
"bgcolor": {
"description": "Sets the background color of the annotation.",
"dflt": "rgba(0,0,0,0)",
"editType": "arraydraw",
"valType": "color"
},
"bordercolor": {
"description": "Sets the color of the border enclosing the annotation `text`.",
"dflt": "rgba(0,0,0,0)",
"editType": "arraydraw",
"valType": "color"
},
"borderpad": {
"description": "Sets the padding (in px) between the `text` and the enclosing border.",
"dflt": 1,
"editType": "calc+arraydraw",
"min": 0,
"valType": "number"
},
"borderwidth": {
"description": "Sets the width (in px) of the border enclosing the annotation `text`.",
"dflt": 1,
"editType": "calc+arraydraw",
"min": 0,
"valType": "number"
},
"captureevents": {
"description": "Determines whether the annotation text box captures mouse move and click events, or allows those events to pass through to data points in the plot that may be behind the annotation. By default `captureevents` is *false* unless `hovertext` is provided. If you use the event `plotly_clickannotation` without `hovertext` you must explicitly enable `captureevents`.",
"editType": "arraydraw",
"valType": "boolean"
},
"clicktoshow": {
"description": "Makes this annotation respond to clicks on the plot. If you click a data point that exactly matches the `x` and `y` values of this annotation, and it is hidden (visible: false), it will appear. In *onoff* mode, you must click the same point again to make it disappear, so if you click multiple points, you can show multiple annotations. In *onout* mode, a click anywhere else in the plot (on another data point or not) will hide this annotation. If you need to show/hide this annotation in response to different `x` or `y` values, you can set `xclick` and/or `yclick`. This is useful for example to label the side of a bar. To label markers though, `standoff` is preferred over `xclick` and `yclick`.",
"dflt": false,
"editType": "arraydraw",
"valType": "enumerated",
"values": [
false,
"onoff",
"onout"
]
},
"editType": "calc",
"font": {
"color": {
"editType": "arraydraw",
"valType": "color"
},
"description": "Sets the annotation text font.",
"editType": "calc+arraydraw",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*,, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
"editType": "calc+arraydraw",
"noBlank": true,
"strict": true,
"valType": "string"
},
"role": "object",
"size": {
"editType": "calc+arraydraw",
"min": 1,
"valType": "number"
}
},
"height": {
"description": "Sets an explicit height for the text box. null (default) lets the text set the box height. Taller text will be clipped.",
"dflt": null,
"editType": "calc+arraydraw",
"min": 1,
"valType": "number"
},
"hoverlabel": {
"bgcolor": {
"description": "Sets the background color of the hover label. By default uses the annotation's `bgcolor` made opaque, or white if it was transparent.",
"editType": "arraydraw",
"valType": "color"
},
"bordercolor": {
"description": "Sets the border color of the hover label. By default uses either dark grey or white, for maximum contrast with `hoverlabel.bgcolor`.",
"editType": "arraydraw",
"valType": "color"
},
"editType": "arraydraw",
"font": {
"color": {
"editType": "arraydraw",
"valType": "color"
},
"description": "Sets the hover label text font. By default uses the global hover font and size, with color from `hoverlabel.bordercolor`.",
"editType": "arraydraw",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*,, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
"editType": "arraydraw",
"noBlank": true,
"strict": true,
"valType": "string"
},
"role": "object",
"size": {
"editType": "arraydraw",
"min": 1,
"valType": "number"
}
},
"role": "object"
},
"hovertext": {
"description": "Sets text to appear when hovering over this annotation. If omitted or blank, no hover label will appear.",
"editType": "arraydraw",
"valType": "string"
},
"name": {
"description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
"editType": "none",
"valType": "string"
},
"opacity": {
"description": "Sets the opacity of the annotation (text + arrow).",
"dflt": 1,
"editType": "arraydraw",
"max": 1,
"min": 0,
"valType": "number"
},
"role": "object",
"showarrow": {
"description": "Determines whether or not the annotation is drawn with an arrow. If *true*, `text` is placed near the arrow's tail. If *false*, `text` lines up with the `x` and `y` provided.",
"dflt": true,
"editType": "calc+arraydraw",
"valType": "boolean"
},
"standoff": {
"description": "Sets a distance, in pixels, to move the end arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom. Note that this shortens the arrow from the `ax` / `ay` vector, in contrast to `xshift` / `yshift` which moves everything by this amount.",
"dflt": 0,
"editType": "calc+arraydraw",
"min": 0,
"valType": "number"
},
"startarrowhead": {
"description": "Sets the start annotation arrow head style.",
"dflt": 1,
"editType": "arraydraw",
"max": 8,
"min": 0,
"valType": "integer"
},
"startarrowsize": {
"description": "Sets the size of the start annotation arrow head, relative to `arrowwidth`. A value of 1 (default) gives a head about 3x as wide as the line.",
"dflt": 1,
"editType": "calc+arraydraw",
"min": 0.3,
"valType": "number"
},
"startstandoff": {
"description": "Sets a distance, in pixels, to move the start arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom. Note that this shortens the arrow from the `ax` / `ay` vector, in contrast to `xshift` / `yshift` which moves everything by this amount.",
"dflt": 0,
"editType": "calc+arraydraw",
"min": 0,
"valType": "number"
},
"templateitemname": {
"description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
"editType": "calc",
"valType": "string"
},
"text": {
"description": "Sets the text associated with this annotation. Plotly uses a subset of HTML tags to do things like newline (<br>), bold (<b></b>), italics (<i></i>), hyperlinks (<a href='...'></a>). Tags <em>, <sup>, <sub> <span> are also supported.",
"editType": "calc+arraydraw",
"valType": "string"
},
"textangle": {
"description": "Sets the angle at which the `text` is drawn with respect to the horizontal.",
"dflt": 0,
"editType": "calc+arraydraw",
"valType": "angle"
},
"valign": {
"description": "Sets the vertical alignment of the `text` within the box. Has an effect only if an explicit height is set to override the text height.",
"dflt": "middle",
"editType": "arraydraw",
"valType": "enumerated",
"values": [
"top",
"middle",
"bottom"
]
},
"visible": {
"description": "Determines whether or not this annotation is visible.",
"dflt": true,
"editType": "calc+arraydraw",
"valType": "boolean"
},
"width": {
"description": "Sets an explicit width for the text box. null (default) lets the text set the box width. Wider text will be clipped. There is no automatic wrapping; use <br> to start a new line.",
"dflt": null,
"editType": "calc+arraydraw",
"min": 1,
"valType": "number"
},
"x": {
"description": "Sets the annotation's x position. If the axis `type` is *log*, then you must take the log of your desired range. If the axis `type` is *date*, it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is *category*, it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.",
"editType": "calc+arraydraw",
"valType": "any"
},
"xanchor": {
"description": "Sets the text box's horizontal position anchor This anchor binds the `x` position to the *left*, *center* or *right* of the annotation. For example, if `x` is set to 1, `xref` to *paper* and `xanchor` to *right* then the right-most portion of the annotation lines up with the right-most edge of the plotting area. If *auto*, the anchor is equivalent to *center* for data-referenced annotations or if there is an arrow, whereas for paper-referenced with no arrow, the anchor picked corresponds to the closest side.",
"dflt": "auto",
"editType": "calc+arraydraw",
"valType": "enumerated",
"values": [
"auto",
"left",
"center",
"right"
]
},
"xclick": {
"description": "Toggle this annotation when clicking a data point whose `x` value is `xclick` rather than the annotation's `x` value.",
"editType": "arraydraw",
"valType": "any"
},
"xref": {
"description": "Sets the annotation's x coordinate axis. If set to a x axis id (e.g. *x* or *x2*), the `x` position refers to a x coordinate. If set to *paper*, the `x` position refers to the distance from the left of the plotting area in normalized coordinates where *0* (*1*) corresponds to the left (right). If set to a x axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., *x2 domain* refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis.",
"editType": "calc",
"valType": "enumerated",
"values": [
"paper",
"/^x([2-9]|[1-9][0-9]+)?( domain)?$/"
]
},
"xshift": {
"description": "Shifts the position of the whole annotation and arrow to the right (positive) or left (negative) by this many pixels.",
"dflt": 0,
"editType": "calc+arraydraw",
"valType": "number"
},
"y": {
"description": "Sets the annotation's y position. If the axis `type` is *log*, then you must take the log of your desired range. If the axis `type` is *date*, it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis `type` is *category*, it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.",
"editType": "calc+arraydraw",
"valType": "any"
},
"yanchor": {
"description": "Sets the text box's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the annotation. For example, if `y` is set to 1, `yref` to *paper* and `yanchor` to *top* then the top-most portion of the annotation lines up with the top-most edge of the plotting area. If *auto*, the anchor is equivalent to *middle* for data-referenced annotations or if there is an arrow, whereas for paper-referenced with no arrow, the anchor picked corresponds to the closest side.",
"dflt": "auto",
"editType": "calc+arraydraw",
"valType": "enumerated",
"values": [
"auto",
"top",
"middle",
"bottom"
]
},
"yclick": {
"description": "Toggle this annotation when clicking a data point whose `y` value is `yclick` rather than the annotation's `y` value.",
"editType": "arraydraw",
"valType": "any"
},
"yref": {
"description": "Sets the annotation's y coordinate axis. If set to a y axis id (e.g. *y* or *y2*), the `y` position refers to a y coordinate. If set to *paper*, the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where *0* (*1*) corresponds to the bottom (top). If set to a y axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., *y2 domain* refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis.",
"editType": "calc",
"valType": "enumerated",
"values": [
"paper",
"/^y([2-9]|[1-9][0-9]+)?( domain)?$/"
]
},
"yshift": {
"description": "Shifts the position of the whole annotation and arrow up (positive) or down (negative) by this many pixels.",
"dflt": 0,
"editType": "calc+arraydraw",
"valType": "number"
}
}
},
"role": "object"
},
"autosize": {
"description": "Determines whether or not a layout width or height that has been left undefined by the user is initialized on each relayout. Note that, regardless of this attribute, an undefined layout width or height is always initialized on the first call to plot.",
"dflt": false,
"editType": "none",
"valType": "boolean"
},
"autotypenumbers": {
"description": "Using *strict* a numeric string in trace data is not converted to a number. Using *convert types* a numeric string in trace data may be treated as a number during automatic axis `type` detection. This is the default value; however it could be overridden for individual axes.",
"dflt": "convert types",
"editType": "calc",
"valType": "enumerated",
"values": [
"convert types",
"strict"
]
},
"calendar": {
"description": "Sets the default calendar system to use for interpreting and displaying dates throughout the plot.",
"dflt": "gregorian",
"editType": "calc",
"valType": "enumerated",
"values": [
"chinese",
"coptic",
"discworld",
"ethiopian",
"gregorian",
"hebrew",
"islamic",
"jalali",
"julian",
"mayan",
"nanakshahi",
"nepali",
"persian",
"taiwan",
"thai",
"ummalqura"
]
},
"clickmode": {
"description": "Determines the mode of single click interactions. *event* is the default value and emits the `plotly_click` event. In addition this mode emits the `plotly_selected` event in drag modes *lasso* and *select*, but with no event data attached (kept for compatibility reasons). The *select* flag enables selecting single data points via click. This mode also supports persistent selections, meaning that pressing Shift while clicking, adds to / subtracts from an existing selection. *select* with `hovermode`: *x* can be confusing, consider explicitly setting `hovermode`: *closest* when using this feature. Selection events are sent accordingly as long as *event* flag is set as well. When the *event* flag is missing, `plotly_click` and `plotly_selected` events are not fired.",
"dflt": "event",
"editType": "plot",
"extras": [
"none"
],
"flags": [
"event",
"select"
],
"valType": "flaglist"
},
"coloraxis": {
"_isSubplotObj": true,
"autocolorscale": {
"description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
"dflt": true,
"editType": "calc",
"impliedEdits": {},
"valType": "boolean"
},
"cauto": {
"description": "Determines whether or not the color domain is computed with respect to the input data (here corresponding trace color array(s)) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.",
"dflt": true,
"editType": "calc",
"impliedEdits": {},
"valType": "boolean"
},
"cmax": {
"description": "Sets the upper bound of the color domain. Value should have the same units as corresponding trace color array(s) and if set, `cmin` must be set as well.",
"dflt": null,
"editType": "plot",
"impliedEdits": {
"cauto": false
},
"valType": "number"
},
"cmid": {
"description": "Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as corresponding trace color array(s). Has no effect when `cauto` is `false`.",
"dflt": null,
"editType": "calc",
"impliedEdits": {},
"valType": "number"
},
"cmin": {
"description": "Sets the lower bound of the color domain. Value should have the same units as corresponding trace color array(s) and if set, `cmax` must be set as well.",
"dflt": null,
"editType": "plot",
"impliedEdits": {
"cauto": false
},
"valType": "number"
},
"colorbar": {
"_deprecated": {
"title": {
"description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
"editType": "colorbars",
"valType": "string"
},
"titlefont": {
"color": {
"editType": "colorbars",
"valType": "color"
},
"description": "Deprecated in favor of color bar's `title.font`.",
"editType": "colorbars",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*,, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
"editType": "colorbars",
"noBlank": true,
"strict": true,
"valType": "string"
},
"size": {
"editType": "colorbars",
"min": 1,
"valType": "number"
}
},
"titleside": {
"description": "Deprecated in favor of color bar's `title.side`.",
"dflt": "top",
"editType": "colorbars",
"valType": "enumerated",
"values": [
"right",
"top",
"bottom"
]
}
},
"bgcolor": {
"description": "Sets the color of padded area.",
"dflt": "rgba(0,0,0,0)",
"editType": "colorbars",
"valType": "color"
},
"bordercolor": {
"description": "Sets the axis line color.",
"dflt": "#444",
"editType": "colorbars",
"valType": "color"
},
"borderwidth": {
"description": "Sets the width (in px) or the border enclosing this color bar.",
"dflt": 0,
"editType": "colorbars",
"min": 0,
"valType": "number"
},
"dtick": {
"description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L<f>*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M<n>* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
"editType": "colorbars",
"impliedEdits": {
"tickmode": "linear"
},
"valType": "any"
},
"editType": "colorbars",
"exponentformat": {
"description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
"dflt": "B",
"editType": "colorbars",
"valType": "enumerated",
"values": [
"none",
"e",
"E",
"power",
"SI",
"B"
]
},
"len": {
"description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
"dflt": 1,
"editType": "colorbars",
"min": 0,
"valType": "number"
},
"lenmode": {
"description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
"dflt": "fraction",
"editType": "colorbars",
"valType": "enumerated",
"values": [
"fraction",
"pixels"
]
},
"minexponent": {
"description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
"dflt": 3,
"editType": "colorbars",
"min": 0,
"valType": "number"
},
"nticks": {
"description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
"dflt": 0,
"editType": "colorbars",
"min": 0,
"valType": "integer"
},
"orientation": {
"description": "Sets the orientation of the colorbar.",
"dflt": "v",
"editType": "colorbars",
"valType": "enumerated",
"values": [
"h",
"v"
]
},
"outlinecolor": {
"description": "Sets the axis line color.",
"dflt": "#444",
"editType": "colorbars",
"valType": "color"
},
"outlinewidth": {
"description": "Sets the width (in px) of the axis line.",
"dflt": 1,
"editType": "colorbars",
"min": 0,
"valType": "number"
},
"role": "object",
"separatethousands": {
"description": "If \"true\", even 4-digit integers are separated",
"dflt": false,
"editType": "colorbars",
"valType": "boolean"
},
"showexponent": {
"description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
"dflt": "all",
"editType": "colorbars",
"valType": "enumerated",
"values": [
"all",
"first",
"last",
"none"
]
},
"showticklabels": {
"description": "Determines whether or not the tick labels are drawn.",
"dflt": true,
"editType": "colorbars",
"valType": "boolean"
},
"showtickprefix": {
"description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
"dflt": "all",
"editType": "colorbars",
"valType": "enumerated",
"values": [
"all",
"first",
"last",
"none"
]
},
"showticksuffix": {
"description": "Same as `showtickprefix` but for tick suffixes.",
"dflt": "all",
"editType": "colorbars",
"valType": "enumerated",
"values": [
"all",
"first",
"last",
"none"
]
},
"thickness": {
"description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
"dflt": 30,
"editType": "colorbars",
"min": 0,
"valType": "number"
},
"thicknessmode": {
"description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
"dflt": "pixels",
"editType": "colorbars",
"valType": "enumerated",
"values": [
"fraction",
"pixels"
]
},
"tick0": {
"description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L<f>* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
"editType": "colorbars",
"impliedEdits": {
"tickmode": "linear"
},
"valType": "any"
},
"tickangle": {
"description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
"dflt": "auto",
"editType": "colorbars",
"valType": "angle"
},
"tickcolor": {
"description": "Sets the tick color.",
"dflt": "#444",
"editType": "colorbars",
"valType": "color"
},
"tickfont": {
"color": {
"editType": "colorbars",
"valType": "color"
},
"description": "Sets the color bar's tick label font",
"editType": "colorbars",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*,, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
"editType": "colorbars",
"noBlank": true,
"strict": true,
"valType": "string"
},
"role": "object",
"size": {
"editType": "colorbars",
"min": 1,
"valType": "number"
}
},
"tickformat": {
"description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
"dflt": "",
"editType": "colorbars",
"valType": "string"
},
"tickformatstops": {
"items": {
"tickformatstop": {
"dtickrange": {
"description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
"editType": "colorbars",
"items": [
{
"editType": "colorbars",
"valType": "any"
},
{
"editType": "colorbars",
"valType": "any"
}
],
"valType": "info_array"
},
"editType": "colorbars",
"enabled": {
"description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
"dflt": true,
"editType": "colorbars",
"valType": "boolean"
},
"name": {
"description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
"editType": "colorbars",
"valType": "string"
},
"role": "object",
"templateitemname": {
"description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
"editType": "colorbars",
"valType": "string"
},
"value": {
"description": "string - dtickformat for described zoom level, the same as *tickformat*",
"dflt": "",
"editType": "colorbars",
"valType": "string"
}
}
},
"role": "object"
},
"ticklabeloverflow": {
"description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
"allow",
"hide past div",
"hide past domain"
]
},
"ticklabelposition": {
"description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
"dflt": "outside",
"editType": "colorbars",
"valType": "enumerated",
"values": [
"outside",
"inside",
"outside top",
"inside top",
"outside left",
"inside left",
"outside right",
"inside right",
"outside bottom",
"inside bottom"
]
},
"ticklabelstep": {
"description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
"dflt": 1,
"editType": "colorbars",
"min": 1,
"valType": "integer"
},
"ticklen": {
"description": "Sets the tick length (in px).",
"dflt": 5,
"editType": "colorbars",
"min": 0,
"valType": "number"
},
"tickmode": {
"description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
"editType": "colorbars",
"impliedEdits": {},
"valType": "enumerated",
"values": [
"auto",
"linear",
"array"
]
},
"tickprefix": {
"description": "Sets a tick label prefix.",
"dflt": "",
"editType": "colorbars",
"valType": "string"
},
"ticks": {
"description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
"dflt": "",
"editType": "colorbars",
"valType": "enumerated",
"values": [
"outside",
"inside",
""
]
},
"ticksuffix": {
"description": "Sets a tick label suffix.",
"dflt": "",
"editType": "colorbars",
"valType": "string"
},
"ticktext": {
"description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
"editType": "colorbars",
"valType": "data_array"
},
"ticktextsrc": {
"description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
"editType": "none",
"valType": "string"
},
"tickvals": {
"description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
"editType": "colorbars",
"valType": "data_array"
},
"tickvalssrc": {
"description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
"editType": "none",
"valType": "string"
},
"tickwidth": {
"description": "Sets the tick width (in px).",
"dflt": 1,
"editType": "colorbars",
"min": 0,
"valType": "number"
},
"title": {
"editType": "colorbars",
"font": {
"color": {
"editType": "colorbars",
"valType": "color"
},
"description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
"editType": "colorbars",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*,, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
"editType": "colorbars",
"noBlank": true,
"strict": true,
"valType": "string"
},
"role": "object",
"size": {
"editType": "colorbars",
"min": 1,
"valType": "number"
}
},
"role": "object",
"side": {
"description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
"right",
"top",
"bottom"
]
},
"text": {
"description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
"editType": "colorbars",
"valType": "string"
}
},
"x": {
"description": "Sets the x position of the color bar (in plot fraction). Defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*.",
"editType": "colorbars",
"max": 3,
"min": -2,
"valType": "number"
},
"xanchor": {
"description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
"left",
"center",
"right"
]
},
"xpad": {
"description": "Sets the amount of padding (in px) along the x direction.",
"dflt": 10,
"editType": "colorbars",
"min": 0,
"valType": "number"
},
"y": {
"description": "Sets the y position of the color bar (in plot fraction). Defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*.",
"editType": "colorbars",
"max": 3,
"min": -2,
"valType": "number"
},
"yanchor": {
"description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
"top",
"middle",
"bottom"
]
},
"ypad": {
"description": "Sets the amount of padding (in px) along the y direction.",
"dflt": 10,
"editType": "colorbars",
"min": 0,
"valType": "number"
}
},
"colorscale": {
"description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
"dflt": null,
"editType": "calc",