forked from plotly/plotly.py
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathgraph_objs_meta.json
More file actions
3271 lines (3271 loc) · 156 KB
/
graph_objs_meta.json
File metadata and controls
3271 lines (3271 loc) · 156 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
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
{
"scatter": {
"x": {
"val_types": "array-like of numbers, strings, datetimes",
"required": " when 'y','r' and 't' are unset",
"type": "data",
"description": "The x coordinates of the points of this scatter trace. If 'x' is linked to an list or array of strings, then the x coordinates are integers [0,1,2,3, ...] labeled on the x-axis by the list or array of strings linked to 'x'.",
"streamable": true
},
"y": {
"val_types": "array-like of numbers, strings, datetimes",
"required": " when 'x','r' and 't' are unset",
"type": "data",
"description": "The y coordinates of the points of this scatter trace. If 'y' is linked to an list or array of strings, then the y coordinates are integers [0,1,2,3, ...] labeled on the y-axis by the list or array of strings linked to 'y'.",
"streamable": true
},
"r": {
"val_types": "array-like of numbers, strings, datetimes",
"required": " when 'x' and 'y' are unset",
"type": "data",
"description": "For Polar charts only. The radial coordinates of the points in this polar scatter trace.",
"streamable": true
},
"t": {
"val_types": "array-like of numbers, strings, datetimes",
"required": " when 'x' and 'y' are unset",
"type": "data",
"description": "For Polar charts only. The angular coordinates of the points in this polar scatter trace.",
"streamable": true
},
"mode": {
"val_types": "'lines' | 'markers' | 'text' | 'lines+markers' | 'lines+text' | 'markers+text' | 'lines+markers+text'",
"required": false,
"type": "plot_info",
"description": "Plotting mode (or style) for the scatter plot. If the mode includes 'text' then the 'text' will appear at the (x,y) points, otherwise it will appear on hover."
},
"name": {
"val_types": "string",
"required": false,
"type": "data",
"description": "The label associated with this trace. This name will appear in the legend, on hover and in the column header in the online spreadsheet."
},
"text": {
"val_types": "array-like of strings",
"required": false,
"type": "data",
"description": "The text elements associated with each (x,y) pair in this scatter trace. If the scatter 'mode' does not include 'text' then text elements will appear on hover only. In contrast, if 'text' is included in 'mode', the entries in 'text' will be rendered on the plot at the locations specified in part by their corresponding (x,y) coordinate pair and the 'textposition' key.",
"streamable": true
},
"error_y": {
"val_types": "dictionary-like",
"required": false,
"type": "object",
"description": "A dictionary-like object describing the vetical error bars (i.e. along the y-axis) that can be drawn from the (x, y) coordinates.",
"streamable": true
},
"error_x": {
"val_types": "dictionary-like",
"required": false,
"type": "object",
"description": "A dictionary-like object describing the horizontal error bars (i.e. along the x-axis) that can be drawn from the (x, y) coordinates.",
"streamable": true
},
"marker": {
"val_types": "dictionary-like",
"required": false,
"type": "object",
"description": "A dictionary-like object containing marker style parameters for this scatter trace. Has an effect only if 'mode' contains 'markers'.",
"streamable": true
},
"line": {
"val_types": "dictionary-like",
"required": false,
"type": "object",
"description": "A dictionary-like object containing line style parameters for this scatter trace. Has an effect only if 'mode' contains 'lines'.",
"streamable": true
},
"textposition": {
"val_types": "'top left' | 'top' (or 'top center')| 'top right' | 'left' (or 'middle left') | '' (or 'middle center') |'right' (or 'middle right') |'bottom left' | 'bottom' (or 'bottom center') |'bottom right'",
"required": false,
"type": "style",
"description": "Sets the position of the text elements in the 'text' key with respect to the data points. By default, the text elements are plotted directly at the (x,y) coordinates."
},
"textfont": {
"val_types": "dictionary-like",
"required": false,
"type": "object",
"description": "A dictionary-like object describing the font style of this scatter trace's text elements. Has only an effect if 'mode' is set and includes 'text'."
},
"connectgaps": {
"val_types": "boolean: True | False",
"required": false,
"type": "plot_info",
"description": "Toggle whether or not missing data points (i.e. '' or NaNs) linked to 'x' and/or 'y', are added in by Plotly using linear interpolation."
},
"fill": {
"val_types": "'none' | 'tozeroy' | 'tonexty' | 'tozerox' | 'tonextx",
"required": false,
"type": "style",
"description": "Use to make area-style charts. Determines which area to fill with a solid color.By default, the area will appear in a more-transparent shape of the line color (or of the marker color if 'mode' does not contains 'lines')."
},
"fillcolor": {
"val_types": "string describing color",
"required": false,
"type": "style",
"description": "Sets the color that will appear in the specified fill area (set in 'fill'). Has no effect if 'fill' is set to 'none'.",
"examples": [
"'green'",
"'rgb(0, 255, 0)'",
"'rgba(0, 255, 0, 0.3)'",
"'hsl(120,100%,50%)'",
"'hsla(120,100%,50%,0.3)'"
]
},
"opacity": {
"val_types": "number: x in [0, 1]",
"required": false,
"type": "style",
"description": "Sets the opacity, or transparency, of the entire object, also known as the alpha channel of colors. If the object's color is given in terms of 'rgba' color model, 'opacity' is redundant."
},
"xaxis": {
"val_types": "'x1' | 'x2' | 'x3' | etc.",
"required": false,
"type": "plot_info",
"description": "This key determines which x-axis the x-coordinates of this trace will reference in the figure. Values 'x1' and 'x' reference to layout['xaxis'], 'x2' references layout['xaxis2'], and so on. Note that 'x1' will always refer to layout['xaxis'] or layout['xaxis1'], they are the same."
},
"yaxis": {
"val_types": "'y1' | 'y2' | 'y3' | etc.",
"required": false,
"type": "plot_info",
"description": "This key determines which y-axis the y-coordinates of this trace will reference in the figure. Values 'y1' and 'y' reference to layout['yaxis'], 'y2' references layout['yaxis2'], and so on. Note that 'y1' will always refer to layout['yaxis'] or layout['yaxis1'], they are the same."
},
"showlegend": {
"val_types": "boolean: True | False",
"required": false,
"type": "style",
"description": "Toggle whether or not this trace will be labeled in the legend."
},
"stream": {
"val_types": "dictionary-like",
"required": false,
"type": "plot_info",
"description": "The stream dictionary-like object that initializes traces as writable-streams, for use with the real-time streaming API. Learn more here:\nhttps://plot.ly/python/streaming/"
},
"visible": {
"val_types": "boolean: True | False",
"required": false,
"type": "plot_info",
"description": "Toggles whether or not this object will actually be visible in the rendered figure."
},
"type": {
"val_types": "scatter",
"required": false,
"type": "plot_info",
"description": "Plotly identifier for this data's trace type. This defines how this data dictionary will be handled. For example, 'scatter' type expects x and y data-arrays corresponding to (x, y) coordinates whereas a 'histogram' only requires a single x or y array and a 'heatmap' type requires a z matrix."
}
},
"bar": {
"x": {
"val_types": "array-like of numbers, strings, datetimes",
"required": " when 'y','r' and 't' are unset",
"type": "data",
"description": "The x coordinates of the bars. If 'x' is linked to an list or array of strings, then the x coordinates are integers [0,1,2,3, ...] labeled on the x-axis by the list or array of strings linked to 'x'. If 'y' is not set, the bars are plotted horizontally, with their length determined by the list or array linked to 'x'.",
"streamable": true
},
"y": {
"val_types": "array-like of numbers, strings, datetimes",
"required": " when 'x','r' and 't' are unset",
"type": "data",
"description": "The y coordinates of the bars. If 'y' is linked to an list or array of strings, then the y coordinates are integers [0,1,2,3, ...] labeled on the y-axis by the list or array of strings linked to 'y'. If 'x' is not set, the bars are plotted vertically, with their length determined by the list or array linked to 'y'.",
"streamable": true
},
"r": {
"val_types": "array-like of numbers, strings, datetimes",
"required": " when 'x' and 'y' are unset",
"type": "data",
"description": "For Polar charts only. The radial coordinates of the bars in this polar bar trace",
"streamable": true
},
"t": {
"val_types": "array-like of numbers, strings, datetimes",
"required": " when 'x' and 'y' are unset",
"type": "data",
"description": "For Polar charts only. The angular coordinates of the bars in this polar bar trace.",
"streamable": true
},
"name": {
"val_types": "string",
"required": false,
"type": "data",
"description": "The label associated with this trace. This name will appear in the legend, on hover and in the column header in the online spreadsheet."
},
"orientation": {
"val_types": "array-like of numbers, strings, datetimes",
"required": false,
"type": "style",
"description": "This defines the direction of the bars. If set to 'v', the length of each bar will run vertically. If set to 'h', the length of each bar will run horizontally"
},
"text": {
"val_types": "array-like of strings",
"required": false,
"type": "data",
"description": "The text elements associated with each bar in this trace. The entries in 'text' will appear on hover only, in a text box located at the top of each bar.",
"streamable": true
},
"error_y": {
"val_types": "dictionary-like",
"required": false,
"type": "object",
"description": "A dictionary-like object describing the vetical error bars (i.e. along the y-axis) that can be drawn from bar tops.",
"streamable": true
},
"error_x": {
"val_types": "dictionary-like",
"required": false,
"type": "object",
"description": "A dictionary-like object describing the horizontal error bars (i.e. along the x-axis) that can be drawn from bar tops.",
"streamable": true
},
"marker": {
"val_types": "dictionary-like",
"required": false,
"type": "object",
"description": "A dictionary-like object containing marker style parameters for this bar trace, for example, the bars' fill color, border width and border color.",
"streamable": true
},
"opacity": {
"val_types": "number: x in [0, 1]",
"required": false,
"type": "style",
"description": "Sets the opacity, or transparency, of the entire object, also known as the alpha channel of colors. If the object's color is given in terms of 'rgba' color model, 'opacity' is redundant."
},
"xaxis": {
"val_types": "'x1' | 'x2' | 'x3' | etc.",
"required": false,
"type": "plot_info",
"description": "This key determines which x-axis the x-coordinates of this trace will reference in the figure. Values 'x1' and 'x' reference to layout['xaxis'], 'x2' references layout['xaxis2'], and so on. Note that 'x1' will always refer to layout['xaxis'] or layout['xaxis1'], they are the same."
},
"yaxis": {
"val_types": "'y1' | 'y2' | 'y3' | etc.",
"required": false,
"type": "plot_info",
"description": "This key determines which y-axis the y-coordinates of this trace will reference in the figure. Values 'y1' and 'y' reference to layout['yaxis'], 'y2' references layout['yaxis2'], and so on. Note that 'y1' will always refer to layout['yaxis'] or layout['yaxis1'], they are the same."
},
"showlegend": {
"val_types": "boolean: True | False",
"required": false,
"type": "style",
"description": "Toggle whether or not this trace will be labeled in the legend."
},
"stream": {
"val_types": "dictionary-like",
"required": false,
"type": "plot_info",
"description": "The stream dictionary-like object that initializes traces as writable-streams, for use with the real-time streaming API. Learn more here:\nhttps://plot.ly/python/streaming/"
},
"visible": {
"val_types": "boolean: True | False",
"required": false,
"type": "plot_info",
"description": "Toggles whether or not this object will actually be visible in the rendered figure."
},
"type": {
"val_types": "bar",
"required": false,
"type": "plot_info",
"description": "Plotly identifier for this data's trace type. This defines how this data dictionary will be handled. For example, 'scatter' type expects x and y data-arrays corresponding to (x, y) coordinates whereas a 'histogram' only requires a single x or y array and a 'heatmap' type requires a z matrix."
},
"line": {
"val_types": "dictionary-like",
"required": false,
"type": "object",
"description": "Artifact. Has no effect.",
"streamable": true
},
"textfont": {
"val_types": "dictionary-like",
"required": false,
"type": "object",
"description": "Not currently supported, has no effect."
}
},
"histogram": {
"x": {
"val_types": "array-like of numbers, strings, datetimes",
"required": " when 'y','r' and 't' are unset",
"type": "data",
"description": "The data sample to be binned (done by Plotly) on the x-axis and plotted as vertical bars.",
"streamable": true
},
"y": {
"val_types": "array-like of numbers, strings, datetimes",
"required": " when 'x','r' and 't' are unset",
"type": "data",
"description": "The data sample to be binned (done by Plotly) on the y-axis and plotted as horizontal bars.",
"streamable": true
},
"histnorm": {
"val_types": "'' (or 'count') | 'percent' | 'probability' | 'density' | 'probability density'",
"required": false,
"type": "plot_info",
"description": "If histnorm is not specified, or histnorm='' (empty string), the height of each bar displays the frequency of occurrence, i.e., the number of times this value was found in the corresponding bin. If histnorm='percent', the height of each bar displays the percentage of total occurrences found within the corresponding bin. If histnorm='probability', the height of each bar displays the probability that an event will fall into the corresponding bin. If histnorm='density', the height of each bar is equal to the number of occurrences in a bin divided by the size of the bin interval such that summing the area of all bins will yield the total number of occurrences. If histnorm='probability density', the height of each bar is equal to the number of probability that an event will fall into the corresponding bin divided by the size of the bin interval such that summing the area of all bins will yield 1, i.e. an event must fall into one of the bins."
},
"name": {
"val_types": "string",
"required": false,
"type": "data",
"description": "The label associated with this trace. This name will appear in the legend, on hover and in the column header in the online spreadsheet."
},
"autobinx": {
"val_types": "boolean: True | False",
"required": false,
"type": "plot_info",
"description": "Toggle whether or not the x-axis bin parameters are picked automatically by Plotly. Once 'autobinx' is set to False, the x-axis bins parameters can be declared in the XBins object."
},
"nbinsx": {
"val_types": "number: x > 0",
"required": false,
"type": "style",
"description": "Specifies the number of x-axis bins. No need to set 'autobinx' to False for 'nbinsx' to apply."
},
"xbins": {
"val_types": "dictionary-like",
"required": false,
"type": "object",
"description": "A dictionary-like object defining the parameters of x-axis bins of this trace, for example, the bin width and the bins' starting and ending value. Has an effect only if 'autobinx'=False."
},
"autobiny": {
"val_types": "boolean: True | False",
"required": false,
"type": "plot_info",
"description": "Toggle whether or not the y-axis bin parameters are picked automatically by Plotly. Once 'autobiny' is set to False, the y-axis bins parameters can be declared in the YBins object."
},
"nbinsy": {
"val_types": "number: x > 0",
"required": false,
"type": "style",
"description": "Specifies the number of y-axis bins. No need to set 'autobiny' to False for 'nbinsy' to apply."
},
"ybins": {
"val_types": "dictionary-like",
"required": false,
"type": "object",
"description": "A dictionary-like object defining the parameters of y-axis bins of this trace, for example, the bin width and the bins' starting and ending value. Has an effect only if 'autobiny'=False."
},
"text": {
"val_types": "array-like of strings",
"required": false,
"type": "data",
"description": "The text elements associated with each bar in this trace. The entries in 'text' will appear on hover only, in a text box located at the top of each bar.",
"streamable": true
},
"error_y": {
"val_types": "dictionary-like",
"required": false,
"type": "object",
"description": "A dictionary-like object describing the vetical error bars (i.e. along the y-axis) that can be drawn from bar tops.",
"streamable": true
},
"error_x": {
"val_types": "dictionary-like",
"required": false,
"type": "object",
"description": "A dictionary-like object describing the horizontal error bars (i.e. along the x-axis) that can be drawn from bar tops.",
"streamable": true
},
"marker": {
"val_types": "dictionary-like",
"required": false,
"type": "object",
"description": "A dictionary-like object containing marker style parameters for this bar trace, for example, the bars' fill color, border width and border color.",
"streamable": true
},
"opacity": {
"val_types": "number: x in [0, 1]",
"required": false,
"type": "style",
"description": "Sets the opacity, or transparency, of the entire object, also known as the alpha channel of colors. If the object's color is given in terms of 'rgba' color model, 'opacity' is redundant."
},
"xaxis": {
"val_types": "'x1' | 'x2' | 'x3' | etc.",
"required": false,
"type": "plot_info",
"description": "This key determines which x-axis the x-coordinates of this trace will reference in the figure. Values 'x1' and 'x' reference to layout['xaxis'], 'x2' references layout['xaxis2'], and so on. Note that 'x1' will always refer to layout['xaxis'] or layout['xaxis1'], they are the same."
},
"yaxis": {
"val_types": "'y1' | 'y2' | 'y3' | etc.",
"required": false,
"type": "plot_info",
"description": "This key determines which y-axis the y-coordinates of this trace will reference in the figure. Values 'y1' and 'y' reference to layout['yaxis'], 'y2' references layout['yaxis2'], and so on. Note that 'y1' will always refer to layout['yaxis'] or layout['yaxis1'], they are the same."
},
"showlegend": {
"val_types": "boolean: True | False",
"required": false,
"type": "style",
"description": "Toggle whether or not this trace will be labeled in the legend."
},
"stream": {
"val_types": "dictionary-like",
"required": false,
"type": "plot_info",
"description": "The stream dictionary-like object that initializes traces as writable-streams, for use with the real-time streaming API. Learn more here:\nhttps://plot.ly/python/streaming/"
},
"visible": {
"val_types": "boolean: True | False",
"required": false,
"type": "plot_info",
"description": "Toggles whether or not this object will actually be visible in the rendered figure."
},
"type": {
"val_types": "histogram",
"required": false,
"type": "plot_info",
"description": "Plotly identifier for this data's trace type. This defines how this data dictionary will be handled. For example, 'scatter' type expects x and y data-arrays corresponding to (x, y) coordinates whereas a 'histogram' only requires a single x or y array and a 'heatmap' type requires a z matrix."
},
"line": {
"val_types": "dictionary-like",
"required": false,
"type": "object",
"description": "Artifact. Has no effect.",
"streamable": true
},
"orientation": {
"val_types": "array-like of numbers, strings, datetimes",
"required": false,
"type": "style",
"description": "Web GUI Artifact. Histogram orientation is determined by which of 'x' or 'y' the data sample is linked to."
}
},
"box": {
"y": {
"val_types": "array-like of numbers, strings, datetimes",
"required": true,
"type": "data",
"description": "This array is used to define an individual box plot, or, a concatenation of multiple boxplots. Statistics from these numbers define the bounds of the box, the length of the whiskers, etc. For details on defining multiple boxes with locations see 'x'.",
"streamable": true
},
"x0": {
"val_types": "number",
"required": false,
"type": "plot_info",
"description": "The location of this box. When 'y' defines a single box, 'x0' can be used to set where this box is centered on the x-axis. If many boxes are set to appear at the same 'x0' location, they will form a box group."
},
"x": {
"val_types": "array-like of numbers, strings, datetimes",
"code": ">>> y0 = [1,2,3,1,1]>>> y1 = [3,2,1,2,3]>>> y = y0+y1 # N.B. list not numpy arrays here>>> x = [0,0,0,0,0,1,1,1,1,1] # len(x) == len(y)>>> Box(y=y, x=x, name='two boxes SHARE this name.')",
"description": "Usually, you do not need to set this value as plotly will handle box locations for you. However this allows you to have fine control over the location data for the box. Unlike making a bar, a box plot is made of many y values. Therefore, to give location data to the values you place in 'y', the length of 'x' must equal the length of 'y'. when making multiple box plots, you can concatenate the data sets for each box into a single 'y' array. then, the entries in 'x' define which box plot each entry in 'y' belongs to. When making a single box plot, you must set each entry in 'x' to the same value, see 'x0' for a more practical way to handle this case. If you don't include 'x', the box will simply be assigned a location.",
"required": false,
"streamable": true,
"type": "data"
},
"name": {
"val_types": "string",
"required": false,
"type": "data",
"description": "The label associated with this trace. This name will appear in the legend, on hover and in the column header in the online spreadsheet."
},
"boxpoints": {
"val_types": "'all' | 'outliers' | 'suspectedoutliers' | False",
"required": false,
"type": "plot_info",
"description": "If 'all' then the 'y' points are shown with the box. If 'outliers' then only the 'outliers' of the 'y' points are shown. If False then no points are shown."
},
"boxmean": {
"val_types": "False | True | 'sd'",
"required": false,
"type": "style",
"description": "If True then the mean of the y-points is shown as a dashed line in the box. If 'sd', then the standard deviation is also shown. If False, then no line shown."
},
"jitter": {
"val_types": "number in [0, 1]",
"required": false,
"type": "style",
"description": "Width of the jittered scatter. If 0, then the boxpoints are aligned vertically, if 1 then the points are randomly jittered horizontally up to the width of the box."
},
"pointpos": {
"val_types": "number: x in [-2, 2]",
"required": false,
"type": "style",
"description": "Horizontal position of the center of the boxpoints relative to the center and width of the box."
},
"whiskerwidth": {
"val_types": "number: x in [0, 1]",
"required": false,
"type": "style",
"description": "Width of the whisker of the box relative to the box' width (in normalized coordinates, e.g. if 'whiskerwidth' set 1, then the whiskers are as wide as the box."
},
"fillcolor": {
"val_types": "string describing color",
"required": false,
"type": "style",
"description": "Sets the color of the box interior.",
"examples": [
"'green'",
"'rgb(0, 255, 0)'",
"'rgba(0, 255, 0, 0.3)'",
"'hsl(120,100%,50%)'",
"'hsla(120,100%,50%,0.3)'"
]
},
"marker": {
"val_types": "dictionary-like",
"required": false,
"type": "object",
"description": "A dictionary-like object containing marker style parameters for this the box points of box trace. Has an effect only 'boxpoints' is set to 'outliers' or 'all'.",
"streamable": true
},
"line": {
"val_types": "dictionary-like",
"required": false,
"type": "object",
"description": "A dictionary-like object containing line style parameters for the border of this box trace (including the whiskers).",
"streamable": true
},
"opacity": {
"val_types": "number: x in [0, 1]",
"required": false,
"type": "style",
"description": "Sets the opacity, or transparency, of the entire object, also known as the alpha channel of colors. If the object's color is given in terms of 'rgba' color model, 'opacity' is redundant."
},
"xaxis": {
"val_types": "'x1' | 'x2' | 'x3' | etc.",
"required": false,
"type": "plot_info",
"description": "This key determines which x-axis the x-coordinates of this trace will reference in the figure. Values 'x1' and 'x' reference to layout['xaxis'], 'x2' references layout['xaxis2'], and so on. Note that 'x1' will always refer to layout['xaxis'] or layout['xaxis1'], they are the same."
},
"yaxis": {
"val_types": "'y1' | 'y2' | 'y3' | etc.",
"required": false,
"type": "plot_info",
"description": "This key determines which y-axis the y-coordinates of this trace will reference in the figure. Values 'y1' and 'y' reference to layout['yaxis'], 'y2' references layout['yaxis2'], and so on. Note that 'y1' will always refer to layout['yaxis'] or layout['yaxis1'], they are the same."
},
"showlegend": {
"val_types": "boolean: True | False",
"required": false,
"type": "style",
"description": "Toggle whether or not this trace will be labeled in the legend."
},
"stream": {
"val_types": "dictionary-like",
"required": false,
"type": "plot_info",
"description": "The stream dictionary-like object that initializes traces as writable-streams, for use with the real-time streaming API. Learn more here:\nhttps://plot.ly/python/streaming/"
},
"visible": {
"val_types": "boolean: True | False",
"required": false,
"type": "plot_info",
"description": "Toggles whether or not this object will actually be visible in the rendered figure."
},
"type": {
"val_types": "box",
"required": false,
"type": "plot_info",
"description": "Plotly identifier for this data's trace type. This defines how this data dictionary will be handled. For example, 'scatter' type expects x and y data-arrays corresponding to (x, y) coordinates whereas a 'histogram' only requires a single x or y array and a 'heatmap' type requires a z matrix."
}
},
"heatmap": {
"z": {
"val_types": "matrix-like: list of lists, numpy.matrix",
"required": false,
"type": "data",
"description": "The data that describes the mapping. The dimensions of the 'z' matrix are (n x m) where there are 'n' ROWS defining the number of partitions along the y-axis; this is equal to the length of the 'y' array. There are 'm' COLUMNS defining the number of partitions along the x-axis; this is equal to the length of the 'x' array. Therefore, the color of the cell z[i][j] is mapped to the ith partition of the y-axis (starting from the bottom of the plot) and the jth partition of the x-axis (starting from the left of the plot). In Python, a (non-numpy) matrix is best thought of as a list of lists (of lists, of lists, etc.). Therefore, running len(z) will give you the number of ROWS and running len(z[0]) will give you the number of COLUMNS. If you ARE using numpy, then running z.shape will give you the tuple, (n, m), e.g., (3, 5).",
"streamable": true
},
"x": {
"val_types": "array-like of numbers, strings, datetimes",
"required": false,
"type": "data",
"description": "This array-like value contains the horizontal coordinates referring to the columns of the 'z' matrix. if strings, the x-labels are spaced evenly.if the dimensions of z are (n x m), the length of the 'x' array should be 'm'.",
"streamable": true
},
"y": {
"val_types": "array-like of numbers, strings, datetimes",
"required": false,
"type": "data",
"description": "This array-like value contains the vertical coordinates referring to the rows of the 'z' matrix. If strings, the y-labels are spaced evenly.If the dimensions of z are (n x m), the length of the 'y' array should be 'n'.",
"streamable": true
},
"name": {
"val_types": "string",
"required": false,
"type": "data",
"description": "The label associated with this trace. This name will appear in the legend, on hover and in the column header in the online spreadsheet."
},
"zauto": {
"val_types": "boolean: True | False",
"required": false,
"type": "style",
"description": "Toggle whether or not the default values of 'zmax' and 'zmax' can be overwritten."
},
"zmin": {
"val_types": "number",
"required": false,
"type": "style",
"description": "The value used as the minimum in the color scale normalization in 'scl'. The default value is the minimum of the 'z' data values."
},
"zmax": {
"val_types": "number",
"required": false,
"type": "style",
"description": "The value used as the maximum in the color scale normalization in 'scl'. The default value is the maximum of the 'z' data values."
},
"scl": {
"val_types": "array_like of value-color pairs | 'Greys' | 'Greens' | 'Bluered' | 'Hot' | 'Picnic' | 'Portland' | 'Jet' | 'RdBu' | 'Blackbody' | 'Earth' | 'Electric' | 'YIOrRd' | 'YIGnBu'",
"required": false,
"type": "style",
"examples": [
"Greys",
[
[
0,
"rgb(0,0,0)"
],
[
0.5,
"rgb(65, 182, 196)"
],
[
1,
"rgb(255,255,255)"
]
]
],
"description": "The color scale. The strings are pre-defined color scales. For custom color scales, define a list of color-value pairs, where the first element of the pair corresponds to a normalized value of z from 0-1, i.e. (z-zmin)/ (zmax-zmin), and the second element of pair corresponds to a color."
},
"reversescl": {
"val_types": "boolean: True | False",
"required": false,
"type": "style",
"description": "Toggle whether or not the color scale will be reversed."
},
"showscale": {
"val_types": "boolean: True | False",
"required": false,
"type": "style",
"description": "Toggle whether or not the color scale associated with this mapping will be shown alongside the figure."
},
"colorbar": {
"val_types": "dictionary-like",
"required": false,
"type": "object",
"description": "A dictionary-like object defining the parameters of the color bar associated with this trace (including its title, length and width)."
},
"zsmooth": {
"val_types": " False | 'best' | 'fast' ",
"required": false,
"type": "style",
"description": "Choose between algorithms ('best' or 'fast') to smooth data linked to 'z'. The default value is False corresponding to no smoothing."
},
"opacity": {
"val_types": "number: x in [0, 1]",
"required": false,
"type": "style",
"description": "Sets the opacity, or transparency, of the entire object, also known as the alpha channel of colors. If the object's color is given in terms of 'rgba' color model, 'opacity' is redundant."
},
"xaxis": {
"val_types": "'x1' | 'x2' | 'x3' | etc.",
"required": false,
"type": "plot_info",
"description": "This key determines which x-axis the x-coordinates of this trace will reference in the figure. Values 'x1' and 'x' reference to layout['xaxis'], 'x2' references layout['xaxis2'], and so on. Note that 'x1' will always refer to layout['xaxis'] or layout['xaxis1'], they are the same."
},
"yaxis": {
"val_types": "'y1' | 'y2' | 'y3' | etc.",
"required": false,
"type": "plot_info",
"description": "This key determines which y-axis the y-coordinates of this trace will reference in the figure. Values 'y1' and 'y' reference to layout['yaxis'], 'y2' references layout['yaxis2'], and so on. Note that 'y1' will always refer to layout['yaxis'] or layout['yaxis1'], they are the same."
},
"showlegend": {
"val_types": "boolean: True | False",
"required": false,
"type": "style",
"description": "Toggle whether or not this trace will be labeled in the legend."
},
"stream": {
"val_types": "dictionary-like",
"required": false,
"type": "plot_info",
"description": "The stream dictionary-like object that initializes traces as writable-streams, for use with the real-time streaming API. Learn more here:\nhttps://plot.ly/python/streaming/"
},
"visible": {
"val_types": "boolean: True | False",
"required": false,
"type": "plot_info",
"description": "Toggles whether or not this object will actually be visible in the rendered figure."
},
"x0": {
"val_types": "number",
"required": false,
"type": "plot_info",
"description": "The location of the first coordinate of the x-axis. Use with 'dx' an alternative to an 'x' list/array. Has no effect if 'x' is set."
},
"dx": {
"val_types": "number",
"required": false,
"type": "plot_info",
"description": "Spacing between x-axis coordinates. Use with 'x0' an alternative to an 'x' list/array. Has no effect if 'x' is set."
},
"y0": {
"val_types": "number",
"required": false,
"type": "plot_info",
"description": "The location of the first coordinate of the y-axis. Use with 'dy' an alternative to an 'y' list/array. Has no effect if 'y' is set."
},
"dy": {
"val_types": "number",
"required": false,
"type": "plot_info",
"description": "Spacing between y-axis coordinates. Use with 'y0' an alternative to an 'y' list/array. Has no effect if 'y' is set."
},
"xtype": {
"val_types": [
"'array' | 'scaled'"
],
"required": false,
"type": "data",
"description": "If set to 'scaled' and 'x' is linked to a list/array, then the horizontal labels are scaled to a list of integers of unit step starting from 0."
},
"ytype": {
"val_types": [
"'array' | 'scaled'"
],
"required": false,
"type": "data",
"description": "If set to 'scaled' and 'y' is linked to a list/array, then the vertical labels are scaled to a list of integers of unit step starting from 0."
},
"type": {
"val_types": "heatmap",
"required": false,
"type": "plot_info",
"description": "Plotly identifier for this data's trace type. This defines how this data dictionary will be handled. For example, 'scatter' type expects x and y data-arrays corresponding to (x, y) coordinates whereas a 'histogram' only requires a single x or y array and a 'heatmap' type requires a z matrix."
}
},
"contour": {
"z": {
"val_types": "matrix-like: list of lists, numpy.matrix",
"required": false,
"type": "data",
"description": "The data that describes the mapping. The dimensions of the 'z' matrix are (n x m) where there are 'n' ROWS defining the number of partitions along the y-axis; this is equal to the length of the 'y' array. There are 'm' COLUMNS defining the number of partitions along the x-axis; this is equal to the length of the 'x' array. Therefore, the color of the cell z[i][j] is mapped to the ith partition of the y-axis (starting from the bottom of the plot) and the jth partition of the x-axis (starting from the left of the plot). In Python, a (non-numpy) matrix is best thought of as a list of lists (of lists, of lists, etc.). Therefore, running len(z) will give you the number of ROWS and running len(z[0]) will give you the number of COLUMNS. If you ARE using numpy, then running z.shape will give you the tuple, (n, m), e.g., (3, 5).",
"streamable": true
},
"x": {
"val_types": "array-like of numbers, strings, datetimes",
"required": false,
"type": "data",
"description": "This array-like value contains the horizontal coordinates referring to the columns of the 'z' matrix. if strings, the x-labels are spaced evenly.if the dimensions of z are (n x m), the length of the 'x' array should be 'm'.",
"streamable": true
},
"y": {
"val_types": "array-like of numbers, strings, datetimes",
"required": false,
"type": "data",
"description": "This array-like value contains the vertical coordinates referring to the rows of the 'z' matrix. If strings, the y-labels are spaced evenly.If the dimensions of z are (n x m), the length of the 'y' array should be 'n'.",
"streamable": true
},
"name": {
"val_types": "string",
"required": false,
"type": "data",
"description": "The label associated with this trace. This name will appear in the legend, on hover and in the column header in the online spreadsheet."
},
"zauto": {
"val_types": "boolean: True | False",
"required": false,
"type": "style",
"description": "Toggle whether or not the default values of 'zmax' and 'zmax' can be overwritten."
},
"zmin": {
"val_types": "number",
"required": false,
"type": "style",
"description": "The value used as the minimum in the color scale normalization in 'scl'. The default value is the minimum of the 'z' data values."
},
"zmax": {
"val_types": "number",
"required": false,
"type": "style",
"description": "The value used as the maximum in the color scale normalization in 'scl'. The default value is the maximum of the 'z' data values."
},
"autocontour": {
"val_types": "boolean: True | False",
"required": false,
"type": "style",
"description": "Toggle whether or not the contour parameters are picked automatically by Plotly. If False, declare the contours parameters in the Contours object."
},
"ncontours": {
"val_types": "number: x > 1",
"required": false,
"type": "style",
"description": "Specifies the number of contours lines in the contour plot. No need to set 'autocontour' to False for 'ncontours' to apply."
},
"contours": {
"val_types": "dictionary-like",
"required": false,
"type": "object",
"description": "A dictionary-like object defining the parameters of the contours of this trace."
},
"line": {
"val_types": "dictionary-like",
"required": false,
"type": "object",
"description": "A dictionary-like object containing line style parameters for contour lines of this contour trace (including line width, dash, color and smoothing level). Has no an effect if 'showlines' is set to False in Contours.",
"streamable": true
},
"scl": {
"val_types": "array_like of value-color pairs | 'Greys' | 'Greens' | 'Bluered' | 'Hot' | 'Picnic' | 'Portland' | 'Jet' | 'RdBu' | 'Blackbody' | 'Earth' | 'Electric' | 'YIOrRd' | 'YIGnBu'",
"required": false,
"type": "style",
"examples": [
"Greys",
[
[
0,
"rgb(0,0,0)"
],
[
0.5,
"rgb(65, 182, 196)"
],
[
1,
"rgb(255,255,255)"
]
]
],
"description": "The color scale. The strings are pre-defined color scales. For custom color scales, define a list of color-value pairs, where the first element of the pair corresponds to a normalized value of z from 0-1, i.e. (z-zmin)/ (zmax-zmin), and the second element of pair corresponds to a color."
},
"reversescl": {
"val_types": "boolean: True | False",
"required": false,
"type": "style",
"description": "Toggle whether or not the color scale will be reversed."
},
"showscale": {
"val_types": "boolean: True | False",
"required": false,
"type": "style",
"description": "Toggle whether or not the color scale associated with this mapping will be shown alongside the figure."
},
"colorbar": {
"val_types": "dictionary-like",
"required": false,
"type": "object",
"description": "A dictionary-like object defining the parameters of the color bar associated with this trace (including its title, length and width)."
},
"opacity": {
"val_types": "number: x in [0, 1]",
"required": false,
"type": "style",
"description": "Sets the opacity, or transparency, of the entire object, also known as the alpha channel of colors. If the object's color is given in terms of 'rgba' color model, 'opacity' is redundant."
},
"xaxis": {
"val_types": "'x1' | 'x2' | 'x3' | etc.",
"required": false,
"type": "plot_info",
"description": "This key determines which x-axis the x-coordinates of this trace will reference in the figure. Values 'x1' and 'x' reference to layout['xaxis'], 'x2' references layout['xaxis2'], and so on. Note that 'x1' will always refer to layout['xaxis'] or layout['xaxis1'], they are the same."
},
"yaxis": {
"val_types": "'y1' | 'y2' | 'y3' | etc.",
"required": false,
"type": "plot_info",
"description": "This key determines which y-axis the y-coordinates of this trace will reference in the figure. Values 'y1' and 'y' reference to layout['yaxis'], 'y2' references layout['yaxis2'], and so on. Note that 'y1' will always refer to layout['yaxis'] or layout['yaxis1'], they are the same."
},
"showlegend": {
"val_types": "boolean: True | False",
"required": false,
"type": "style",
"description": "Toggle whether or not this trace will be labeled in the legend."
},
"stream": {
"val_types": "dictionary-like",
"required": false,
"type": "plot_info",
"description": "The stream dictionary-like object that initializes traces as writable-streams, for use with the real-time streaming API. Learn more here:\nhttps://plot.ly/python/streaming/"
},
"visible": {
"val_types": "boolean: True | False",
"required": false,
"type": "plot_info",
"description": "Toggles whether or not this object will actually be visible in the rendered figure."
},
"x0": {
"val_types": "number",
"required": false,
"type": "plot_info",
"description": "The location of the first coordinate of the x-axis. Use with 'dx' an alternative to an 'x' list/array. Has no effect if 'x' is set."
},
"dx": {
"val_types": "number",
"required": false,
"type": "plot_info",
"description": "Spacing between x-axis coordinates. Use with 'x0' an alternative to an 'x' list/array. Has no effect if 'x' is set."
},
"y0": {
"val_types": "number",
"required": false,
"type": "plot_info",
"description": "The location of the first coordinate of the y-axis. Use with 'dy' an alternative to an 'y' list/array. Has no effect if 'y' is set."
},
"dy": {
"val_types": "number",
"required": false,
"type": "plot_info",
"description": "Spacing between y-axis coordinates. Use with 'y0' an alternative to an 'y' list/array. Has no effect if 'y' is set."
},
"xtype": {
"val_types": [
"'array' | 'scaled'"
],
"required": false,
"type": "data",
"description": "If set to 'scaled' and 'x' is linked to a list/array, then the horizontal labels are scaled to a list of integers of unit step starting from 0."
},
"ytype": {
"val_types": [
"'array' | 'scaled'"
],
"required": false,
"type": "data",
"description": "If set to 'scaled' and 'y' is linked to a list/array, then the vertical labels are scaled to a list of integers of unit step starting from 0."
},
"type": {
"val_types": "contour",
"required": false,
"type": "plot_info",
"description": "Plotly identifier for this data's trace type. This defines how this data dictionary will be handled. For example, 'scatter' type expects x and y data-arrays corresponding to (x, y) coordinates whereas a 'histogram' only requires a single x or y array and a 'heatmap' type requires a z matrix."
}
},
"histogram2d": {
"x": {
"val_types": "array-like of numbers, strings, datetimes",
"required": true,
"type": "data",
"description": "The data sample to be binned on the x-axis and whose distribution (computed by Plotly) will correspond to the x-coordinates of this 2D histogram trace.",
"streamable": true
},
"y": {
"val_types": "array-like of numbers, strings, datetimes",
"required": true,
"type": "data",
"description": "The data sample to be binned on the y-axis and whose distribution (computed by Plotly) will correspond to the y-coordinates of this 2D histogram trace.",
"streamable": true
},
"histnorm": {
"val_types": "'' (or 'count') | 'percent' | 'probability' | 'density' | 'probability density'",
"required": false,
"type": "plot_info",
"description": "If histnorm is not specified, or histnorm='' (empty string), the height of each bar displays the frequency of occurrence, i.e., the number of times this value was found in the corresponding bin. If histnorm='percent', the height of each bar displays the percentage of total occurrences found within the corresponding bin. If histnorm='probability', the height of each bar displays the probability that an event will fall into the corresponding bin. If histnorm='density', the height of each bar is equal to the number of occurrences in a bin divided by the size of the bin interval such that summing the area of all bins will yield the total number of occurrences. If histnorm='probability density', the height of each bar is equal to the number of probability that an event will fall into the corresponding bin divided by the size of the bin interval such that summing the area of all bins will yield 1, i.e. an event must fall into one of the bins."
},
"name": {
"val_types": "string",
"required": false,
"type": "data",
"description": "The label associated with this trace. This name will appear in the legend, on hover and in the column header in the online spreadsheet."
},
"autobinx": {
"val_types": "boolean: True | False",
"required": false,
"type": "plot_info",
"description": "Toggle whether or not the x-axis bin parameters are picked automatically by Plotly. Once 'autobinx' is set to False, the x-axis bins parameters can be declared in the XBins object."
},
"nbinsx": {
"val_types": "number: x > 0",
"required": false,
"type": "style",
"description": "Specifies the number of x-axis bins. No need to set 'autobinx' to False for 'nbinsx' to apply."
},
"xbins": {
"val_types": "dictionary-like",
"required": false,
"type": "object",
"description": "A dictionary-like object defining the parameters of x-axis bins of this trace, for example, the bin width and the bins' starting and ending value. Has an effect only if 'autobinx'=False."
},
"autobiny": {
"val_types": "boolean: True | False",
"required": false,
"type": "plot_info",
"description": "Toggle whether or not the y-axis bin parameters are picked automatically by Plotly. Once 'autobiny' is set to False, the y-axis bins parameters can be declared in the YBins object."
},
"nbinsy": {
"val_types": "number: x > 0",
"required": false,
"type": "style",
"description": "Specifies the number of y-axis bins. No need to set 'autobiny' to False for 'nbinsy' to apply."
},
"ybins": {
"val_types": "dictionary-like",
"required": false,
"type": "object",
"description": "A dictionary-like object defining the parameters of y-axis bins of this trace, for example, the bin width and the bins' starting and ending value. Has an effect only if 'autobiny'=False."
},
"scl": {
"val_types": "array_like of value-color pairs | 'Greys' | 'Greens' | 'Bluered' | 'Hot' | 'Picnic' | 'Portland' | 'Jet' | 'RdBu' | 'Blackbody' | 'Earth' | 'Electric' | 'YIOrRd' | 'YIGnBu'",
"required": false,
"type": "style",
"examples": [
"Greys",
[
[
0,