-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathplotly.graph_objects.Bar.html
More file actions
3070 lines (2909 loc) · 222 KB
/
plotly.graph_objects.Bar.html
File metadata and controls
3070 lines (2909 loc) · 222 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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>plotly.graph_objects.Bar — 6.6.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/plotly-style.css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="plotly.graph_objects.Pie" href="plotly.graph_objects.Pie.html" />
<link rel="prev" title="plotly.graph_objects.Scattergl" href="plotly.graph_objects.Scattergl.html" />
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
<script type="text/javascript" src="../_static/js/jquery-1.12.4.min.js"></script>
<script type="text/javascript" src="../_static/js/jquery-fix.js"></script>
<script type="text/javascript" src="../_static/bootstrap-3.4.1/js/bootstrap.min.js"></script>
<script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script>
</head><body>
<div id="navbar" class="navbar navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html"><span><img src="../_static/logo.png"></span>
</a>
<span class="navbar-text navbar-version pull-left"><b></b></span>
</div>
<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
<li class="dropdown globaltoc-container">
<a role="button"
id="dLabelGlobalToc"
data-toggle="dropdown"
data-target="#"
href="../index.html">Site <b class="caret"></b></a>
<ul class="dropdown-menu globaltoc"
role="menu"
aria-labelledby="dLabelGlobalToc"><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../plotly.express.html"><code class="docutils literal notranslate"><span class="pre">plotly.express</span></code>: high-level interface for data visualization</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../plotly.graph_objects.html"><code class="docutils literal notranslate"><span class="pre">plotly.graph_objects</span></code>: low-level interface to figures, traces and layout</a></li>
<li class="toctree-l1"><a class="reference internal" href="../plotly.subplots.html"><code class="docutils literal notranslate"><span class="pre">plotly.subplots</span></code>: helper function for laying out multi-plot figures</a></li>
<li class="toctree-l1"><a class="reference internal" href="../plotly.figure_factory.html"><code class="docutils literal notranslate"><span class="pre">plotly.figure_factory</span></code>: helper methods for building specific complex charts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../plotly.io.html"><code class="docutils literal notranslate"><span class="pre">plotly.io</span></code>: low-level interface for displaying, reading and writing figures</a></li>
</ul>
</ul>
</li>
<li class="dropdown">
<a role="button"
id="dLabelLocalToc"
data-toggle="dropdown"
data-target="#"
href="#">Page <b class="caret"></b></a>
<ul class="dropdown-menu localtoc"
role="menu"
aria-labelledby="dLabelLocalToc"><ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">plotly.graph_objects</span></code>.Bar</a></li>
<li><a class="reference internal" href="#id5"><code class="xref py py-mod docutils literal notranslate"><span class="pre">plotly.graph_objects</span></code>.bar</a></li>
</ul>
</ul>
</li>
<li>
<a href="plotly.graph_objects.Scattergl.html" title="Previous Chapter: plotly.graph_objects.Scattergl"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« plotly.graph_...</span>
</a>
</li>
<li>
<a href="plotly.graph_objects.Pie.html" title="Next Chapter: plotly.graph_objects.Pie"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">plotly.graph_objects.Pie »</span>
</a>
</li>
</ul>
<form class="navbar-form navbar-right" action="../search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="body col-md-12 content" role="main">
<div class="section" id="plotly-graph-objs-bar">
<h1><a class="reference internal" href="plotly.graph_objects.html#module-plotly.graph_objects" title="plotly.graph_objects"><code class="xref py py-mod docutils literal notranslate"><span class="pre">plotly.graph_objects</span></code></a>.Bar<a class="headerlink" href="#plotly-graph-objs-bar" title="Permalink to this headline">¶</a></h1>
<dl class="py class">
<dt id="plotly.graph_objects.Bar">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">plotly.graph_objects.</span></code><code class="sig-name descname"><span class="pre">Bar</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alignmentgroup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">base</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">basesrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cliponaxis</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">constraintext</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customdata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customdatasrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_x</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_y</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hoverinfo</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hoverinfosrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hoverlabel</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hovertemplate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hovertemplatefallback</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hovertemplatesrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hovertext</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hovertextsrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ids</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idssrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">insidetextanchor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">insidetextfont</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">legend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">legendgroup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">legendgrouptitle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">legendrank</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">legendwidth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">marker</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">meta</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metasrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offsetgroup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offsetsrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">opacity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">orientation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outsidetextfont</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">selected</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">selectedpoints</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">showlegend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stream</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">textangle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">textfont</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">textposition</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">textpositionsrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">textsrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">texttemplate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">texttemplatefallback</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">texttemplatesrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uirevision</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unselected</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visible</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">widthsrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xaxis</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xcalendar</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xhoverformat</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xperiod</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xperiod0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xperiodalignment</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xsrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yaxis</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ycalendar</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yhoverformat</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yperiod</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yperiod0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yperiodalignment</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ysrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">zorder</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#plotly.graph_objects.Bar" title="Permalink to this definition">¶</a></dt>
<dd><dl class="py method">
<dt id="plotly.graph_objects.Bar.__init__">
<code class="sig-name descname"><span class="pre">__init__</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alignmentgroup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">base</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">basesrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cliponaxis</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">constraintext</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customdata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customdatasrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_x</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_y</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hoverinfo</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hoverinfosrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hoverlabel</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hovertemplate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hovertemplatefallback</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hovertemplatesrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hovertext</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hovertextsrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ids</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idssrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">insidetextanchor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">insidetextfont</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">legend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">legendgroup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">legendgrouptitle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">legendrank</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">legendwidth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">marker</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">meta</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metasrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offsetgroup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offsetsrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">opacity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">orientation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outsidetextfont</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">selected</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">selectedpoints</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">showlegend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stream</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">textangle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">textfont</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">textposition</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">textpositionsrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">textsrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">texttemplate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">texttemplatefallback</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">texttemplatesrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uirevision</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unselected</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visible</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">widthsrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xaxis</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xcalendar</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xhoverformat</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xperiod</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xperiod0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xperiodalignment</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xsrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yaxis</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ycalendar</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yhoverformat</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yperiod</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yperiod0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yperiodalignment</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ysrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">zorder</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#plotly.graph_objects.Bar.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Construct a new Bar object</p>
<p>The data visualized by the span of the bars is set in <code class="docutils literal notranslate"><span class="pre">y</span></code> if
<code class="docutils literal notranslate"><span class="pre">orientation</span></code> is set to “v” (the default) and the labels are
set in <code class="docutils literal notranslate"><span class="pre">x</span></code>. By setting <code class="docutils literal notranslate"><span class="pre">orientation</span></code> to “h”, the roles are
interchanged.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>arg</strong> – dict of properties compatible with this constructor or
an instance of <a class="reference internal" href="#plotly.graph_objects.Bar" title="plotly.graph_objects.Bar"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.Bar</span></code></a></p></li>
<li><p><strong>alignmentgroup</strong> – Set several traces linked to the same position axis or
matching axes to the same alignmentgroup. This controls
whether bars compute their positional range dependently
or independently.</p></li>
<li><p><strong>base</strong> – Sets where the bar base is drawn (in position axis
units). In “stack” or “relative” barmode, traces that
set “base” will be excluded and drawn in “overlay” mode
instead.</p></li>
<li><p><strong>basesrc</strong> – Sets the source reference on Chart Studio Cloud for
<code class="docutils literal notranslate"><span class="pre">base</span></code>.</p></li>
<li><p><strong>cliponaxis</strong> – Determines whether the text nodes are clipped about the
subplot axes. To show the text nodes above axis lines
and tick labels, make sure to set <code class="docutils literal notranslate"><span class="pre">xaxis.layer</span></code> and
<code class="docutils literal notranslate"><span class="pre">yaxis.layer</span></code> to <em>below traces</em>.</p></li>
<li><p><strong>constraintext</strong> – Constrain the size of text inside or outside a bar to
be no larger than the bar itself.</p></li>
<li><p><strong>customdata</strong> – Assigns extra data each datum. This may be useful when
listening to hover, click and selection events. Note
that, “scatter” traces also appends customdata items in
the markers DOM elements</p></li>
<li><p><strong>customdatasrc</strong> – Sets the source reference on Chart Studio Cloud for
<code class="docutils literal notranslate"><span class="pre">customdata</span></code>.</p></li>
<li><p><strong>dx</strong> – Sets the x coordinate step. See <code class="docutils literal notranslate"><span class="pre">x0</span></code> for more info.</p></li>
<li><p><strong>dy</strong> – Sets the y coordinate step. See <code class="docutils literal notranslate"><span class="pre">y0</span></code> for more info.</p></li>
<li><p><strong>error_x</strong> – <a class="reference internal" href="plotly.graph_objects.bar.html#plotly.graph_objects.bar.ErrorX" title="plotly.graph_objects.bar.ErrorX"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.bar.ErrorX</span></code></a> instance or
dict with compatible properties</p></li>
<li><p><strong>error_y</strong> – <a class="reference internal" href="plotly.graph_objects.bar.html#plotly.graph_objects.bar.ErrorY" title="plotly.graph_objects.bar.ErrorY"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.bar.ErrorY</span></code></a> instance or
dict with compatible properties</p></li>
<li><p><strong>hoverinfo</strong> – Determines which trace information appear on hover. If
<code class="docutils literal notranslate"><span class="pre">none</span></code> or <code class="docutils literal notranslate"><span class="pre">skip</span></code> are set, no information is displayed
upon hovering. But, if <code class="docutils literal notranslate"><span class="pre">none</span></code> is set, click and hover
events are still fired.</p></li>
<li><p><strong>hoverinfosrc</strong> – Sets the source reference on Chart Studio Cloud for
<code class="docutils literal notranslate"><span class="pre">hoverinfo</span></code>.</p></li>
<li><p><strong>hoverlabel</strong> – <a class="reference internal" href="plotly.graph_objects.bar.html#plotly.graph_objects.bar.Hoverlabel" title="plotly.graph_objects.bar.Hoverlabel"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.bar.Hoverlabel</span></code></a> instance
or dict with compatible properties</p></li>
<li><p><strong>hovertemplate</strong> – Template string used for rendering the information that
appear on hover box. Note that this will override
<code class="docutils literal notranslate"><span class="pre">hoverinfo</span></code>. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Variables that can’t be found
will be replaced with the specifier. For example, a
template of “data: %{x}, %{y}” will result in a value
of “data: 1, %{y}” if x is 1 and y is missing.
Variables with an undefined value will be replaced with
the fallback value. The variables available in
<code class="docutils literal notranslate"><span class="pre">hovertemplate</span></code> are the ones emitted as event data
described at this link
<a class="reference external" href="https://plotly.com/javascript/plotlyjs-events/#event">https://plotly.com/javascript/plotlyjs-events/#event</a>-
data. Additionally, all attributes that can be
specified per-point (the ones that are <code class="docutils literal notranslate"><span class="pre">arrayOk:</span> <span class="pre">true</span></code>)
are available. Finally, the template string has access
to variables <code class="docutils literal notranslate"><span class="pre">value</span></code> and <code class="docutils literal notranslate"><span class="pre">label</span></code>. Anything contained in
tag <code class="docutils literal notranslate"><span class="pre"><extra></span></code> is displayed in the secondary box, for
example <code class="docutils literal notranslate"><span class="pre"><extra>%{fullData.name}</extra></span></code>. To hide the
secondary box completely, use an empty tag
<code class="docutils literal notranslate"><span class="pre"><extra></extra></span></code>.</p></li>
<li><p><strong>hovertemplatefallback</strong> – Fallback string that’s displayed when a variable
referenced in a template is missing. If the boolean
value ‘false’ is passed in, the specifier with the
missing variable will be displayed.</p></li>
<li><p><strong>hovertemplatesrc</strong> – Sets the source reference on Chart Studio Cloud for
<code class="docutils literal notranslate"><span class="pre">hovertemplate</span></code>.</p></li>
<li><p><strong>hovertext</strong> – Sets hover text elements associated with each (x,y)
pair. If a single string, the same string appears over
all the data points. If an array of string, the items
are mapped in order to the this trace’s (x,y)
coordinates. To be seen, trace <code class="docutils literal notranslate"><span class="pre">hoverinfo</span></code> must contain
a “text” flag.</p></li>
<li><p><strong>hovertextsrc</strong> – Sets the source reference on Chart Studio Cloud for
<code class="docutils literal notranslate"><span class="pre">hovertext</span></code>.</p></li>
<li><p><strong>ids</strong> – Assigns id labels to each datum. These ids for object
constancy of data points during animation. Should be an
array of strings, not numbers or any other type.</p></li>
<li><p><strong>idssrc</strong> – Sets the source reference on Chart Studio Cloud for
<code class="docutils literal notranslate"><span class="pre">ids</span></code>.</p></li>
<li><p><strong>insidetextanchor</strong> – Determines if texts are kept at center or start/end
points in <code class="docutils literal notranslate"><span class="pre">textposition</span></code> “inside” mode.</p></li>
<li><p><strong>insidetextfont</strong> – Sets the font used for <code class="docutils literal notranslate"><span class="pre">text</span></code> lying inside the bar.</p></li>
<li><p><strong>legend</strong> – Sets the reference to a legend to show this trace in.
References to these legends are “legend”, “legend2”,
“legend3”, etc. Settings for these legends are set in
the layout, under <code class="docutils literal notranslate"><span class="pre">layout.legend</span></code>, <code class="docutils literal notranslate"><span class="pre">layout.legend2</span></code>,
etc.</p></li>
<li><p><strong>legendgroup</strong> – Sets the legend group for this trace. Traces and shapes
part of the same legend group hide/show at the same
time when toggling legend items.</p></li>
<li><p><strong>legendgrouptitle</strong> – <a class="reference internal" href="plotly.graph_objects.bar.html#plotly.graph_objects.bar.Legendgrouptitle" title="plotly.graph_objects.bar.Legendgrouptitle"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.bar.Legendgrouptitle</span></code></a>
instance or dict with compatible properties</p></li>
<li><p><strong>legendrank</strong> – Sets the legend rank for this trace. Items and groups
with smaller ranks are presented on top/left side while
with “reversed” <code class="docutils literal notranslate"><span class="pre">legend.traceorder</span></code> they are on
bottom/right side. The default legendrank is 1000, so
that you can use ranks less than 1000 to place certain
items before all unranked items, and ranks greater than
1000 to go after all unranked items. When having
unranked or equal rank items shapes would be displayed
after traces i.e. according to their order in data and
layout.</p></li>
<li><p><strong>legendwidth</strong> – Sets the width (in px or fraction) of the legend for
this trace.</p></li>
<li><p><strong>marker</strong> – <a class="reference internal" href="plotly.graph_objects.bar.html#plotly.graph_objects.bar.Marker" title="plotly.graph_objects.bar.Marker"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.bar.Marker</span></code></a> instance or
dict with compatible properties</p></li>
<li><p><strong>meta</strong> – Assigns extra meta information associated with this
trace that can be used in various text attributes.
Attributes such as trace <code class="docutils literal notranslate"><span class="pre">name</span></code>, graph, axis and
colorbar <code class="docutils literal notranslate"><span class="pre">title.text</span></code>, annotation <code class="docutils literal notranslate"><span class="pre">text</span></code>
<code class="docutils literal notranslate"><span class="pre">rangeselector</span></code>, <code class="docutils literal notranslate"><span class="pre">updatemenues</span></code> and <code class="docutils literal notranslate"><span class="pre">sliders</span></code> <code class="docutils literal notranslate"><span class="pre">label</span></code>
text all support <code class="docutils literal notranslate"><span class="pre">meta</span></code>. To access the trace <code class="docutils literal notranslate"><span class="pre">meta</span></code>
values in an attribute in the same trace, simply use
<code class="docutils literal notranslate"><span class="pre">%{meta[i]}</span></code> where <code class="docutils literal notranslate"><span class="pre">i</span></code> is the index or key of the
<code class="docutils literal notranslate"><span class="pre">meta</span></code> item in question. To access trace <code class="docutils literal notranslate"><span class="pre">meta</span></code> in
layout attributes, use <code class="docutils literal notranslate"><span class="pre">%{data[n[.meta[i]}</span></code> where <code class="docutils literal notranslate"><span class="pre">i</span></code>
is the index or key of the <code class="docutils literal notranslate"><span class="pre">meta</span></code> and <code class="docutils literal notranslate"><span class="pre">n</span></code> is the trace
index.</p></li>
<li><p><strong>metasrc</strong> – Sets the source reference on Chart Studio Cloud for
<code class="docutils literal notranslate"><span class="pre">meta</span></code>.</p></li>
<li><p><strong>name</strong> – Sets the trace name. The trace name appears as the
legend item and on hover.</p></li>
<li><p><strong>offset</strong> – Shifts the position where the bar is drawn (in position
axis units). In “group” barmode, traces that set
“offset” will be excluded and drawn in “overlay” mode
instead.</p></li>
<li><p><strong>offsetgroup</strong> – Set several traces linked to the same position axis or
matching axes to the same offsetgroup where bars of the
same position coordinate will line up.</p></li>
<li><p><strong>offsetsrc</strong> – Sets the source reference on Chart Studio Cloud for
<code class="docutils literal notranslate"><span class="pre">offset</span></code>.</p></li>
<li><p><strong>opacity</strong> – Sets the opacity of the trace.</p></li>
<li><p><strong>orientation</strong> – Sets the orientation of the bars. With “v” (“h”), the
value of the each bar spans along the vertical
(horizontal).</p></li>
<li><p><strong>outsidetextfont</strong> – Sets the font used for <code class="docutils literal notranslate"><span class="pre">text</span></code> lying outside the bar.</p></li>
<li><p><strong>selected</strong> – <a class="reference internal" href="plotly.graph_objects.bar.html#plotly.graph_objects.bar.Selected" title="plotly.graph_objects.bar.Selected"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.bar.Selected</span></code></a> instance or
dict with compatible properties</p></li>
<li><p><strong>selectedpoints</strong> – Array containing integer indices of selected points.
Has an effect only for traces that support selections.
Note that an empty array means an empty selection where
the <code class="docutils literal notranslate"><span class="pre">unselected</span></code> are turned on for all points, whereas,
any other non-array values means no selection all where
the <code class="docutils literal notranslate"><span class="pre">selected</span></code> and <code class="docutils literal notranslate"><span class="pre">unselected</span></code> styles have no effect.</p></li>
<li><p><strong>showlegend</strong> – Determines whether or not an item corresponding to this
trace is shown in the legend.</p></li>
<li><p><strong>stream</strong> – <a class="reference internal" href="plotly.graph_objects.bar.html#plotly.graph_objects.bar.Stream" title="plotly.graph_objects.bar.Stream"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.bar.Stream</span></code></a> instance or
dict with compatible properties</p></li>
<li><p><strong>text</strong> – Sets text elements associated with each (x,y) pair. If
a single string, the same string appears over all the
data points. If an array of string, the items are
mapped in order to the this trace’s (x,y) coordinates.
If trace <code class="docutils literal notranslate"><span class="pre">hoverinfo</span></code> contains a “text” flag and
“hovertext” is not set, these elements will be seen in
the hover labels.</p></li>
<li><p><strong>textangle</strong> – Sets the angle of the tick labels with respect to the
bar. For example, a <code class="docutils literal notranslate"><span class="pre">tickangle</span></code> of -90 draws the tick
labels vertically. With “auto” the texts may
automatically be rotated to fit with the maximum size
in bars.</p></li>
<li><p><strong>textfont</strong> – Sets the font used for <code class="docutils literal notranslate"><span class="pre">text</span></code>.</p></li>
<li><p><strong>textposition</strong> – Specifies the location of the <code class="docutils literal notranslate"><span class="pre">text</span></code>. “inside”
positions <code class="docutils literal notranslate"><span class="pre">text</span></code> inside, next to the bar end (rotated
and scaled if needed). “outside” positions <code class="docutils literal notranslate"><span class="pre">text</span></code>
outside, next to the bar end (scaled if needed), unless
there is another bar stacked on this one, then the text
gets pushed inside. “auto” tries to position <code class="docutils literal notranslate"><span class="pre">text</span></code>
inside the bar, but if the bar is too small and no bar
is stacked on this one the text is moved outside. If
“none”, no text appears.</p></li>
<li><p><strong>textpositionsrc</strong> – Sets the source reference on Chart Studio Cloud for
<code class="docutils literal notranslate"><span class="pre">textposition</span></code>.</p></li>
<li><p><strong>textsrc</strong> – Sets the source reference on Chart Studio Cloud for
<code class="docutils literal notranslate"><span class="pre">text</span></code>.</p></li>
<li><p><strong>texttemplate</strong> – Template string used for rendering the information text
that appears on points. Note that this will override
<code class="docutils literal notranslate"><span class="pre">textinfo</span></code>. Variables are inserted using %{variable},
for example “y: %{y}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. Variables that can’t be found
will be replaced with the specifier. For example, a
template of “data: %{x}, %{y}” will result in a value
of “data: 1, %{y}” if x is 1 and y is missing.
Variables with an undefined value will be replaced with
the fallback value. All attributes that can be
specified per-point (the ones that are <code class="docutils literal notranslate"><span class="pre">arrayOk:</span> <span class="pre">true</span></code>)
are available. Finally, the template string has access
to variables <code class="docutils literal notranslate"><span class="pre">value</span></code> and <code class="docutils literal notranslate"><span class="pre">label</span></code>.</p></li>
<li><p><strong>texttemplatefallback</strong> – Fallback string that’s displayed when a variable
referenced in a template is missing. If the boolean
value ‘false’ is passed in, the specifier with the
missing variable will be displayed.</p></li>
<li><p><strong>texttemplatesrc</strong> – Sets the source reference on Chart Studio Cloud for
<code class="docutils literal notranslate"><span class="pre">texttemplate</span></code>.</p></li>
<li><p><strong>uid</strong> – Assign an id to this trace, Use this to provide object
constancy between traces during animations and
transitions.</p></li>
<li><p><strong>uirevision</strong> – Controls persistence of some user-driven changes to the
trace: <code class="docutils literal notranslate"><span class="pre">constraintrange</span></code> in <code class="docutils literal notranslate"><span class="pre">parcoords</span></code> traces, as well
as some <code class="docutils literal notranslate"><span class="pre">editable:</span> <span class="pre">true</span></code> modifications such as <code class="docutils literal notranslate"><span class="pre">name</span></code>
and <code class="docutils literal notranslate"><span class="pre">colorbar.title</span></code>. Defaults to <code class="docutils literal notranslate"><span class="pre">layout.uirevision</span></code>.
Note that other user-driven trace attribute changes are
controlled by <code class="docutils literal notranslate"><span class="pre">layout</span></code> attributes: <code class="docutils literal notranslate"><span class="pre">trace.visible</span></code> is
controlled by <code class="docutils literal notranslate"><span class="pre">layout.legend.uirevision</span></code>,
<code class="docutils literal notranslate"><span class="pre">selectedpoints</span></code> is controlled by
<code class="docutils literal notranslate"><span class="pre">layout.selectionrevision</span></code>, and <code class="docutils literal notranslate"><span class="pre">colorbar.(x|y)</span></code>
(accessible with <code class="docutils literal notranslate"><span class="pre">config:</span> <span class="pre">{editable:</span> <span class="pre">true}</span></code>) is
controlled by <code class="docutils literal notranslate"><span class="pre">layout.editrevision</span></code>. Trace changes are
tracked by <code class="docutils literal notranslate"><span class="pre">uid</span></code>, which only falls back on trace index
if no <code class="docutils literal notranslate"><span class="pre">uid</span></code> is provided. So if your app can add/remove
traces before the end of the <code class="docutils literal notranslate"><span class="pre">data</span></code> array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
<code class="docutils literal notranslate"><span class="pre">uid</span></code> that stays with it as it moves.</p></li>
<li><p><strong>unselected</strong> – <a class="reference internal" href="plotly.graph_objects.bar.html#plotly.graph_objects.bar.Unselected" title="plotly.graph_objects.bar.Unselected"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.bar.Unselected</span></code></a> instance
or dict with compatible properties</p></li>
<li><p><strong>visible</strong> – Determines whether or not this trace is visible. If
“legendonly”, the trace is not drawn, but can appear as
a legend item (provided that the legend itself is
visible).</p></li>
<li><p><strong>width</strong> – Sets the bar width (in position axis units).</p></li>
<li><p><strong>widthsrc</strong> – Sets the source reference on Chart Studio Cloud for
<code class="docutils literal notranslate"><span class="pre">width</span></code>.</p></li>
<li><p><strong>x</strong> – Sets the x coordinates.</p></li>
<li><p><strong>x0</strong> – Alternate to <code class="docutils literal notranslate"><span class="pre">x</span></code>. Builds a linear space of x
coordinates. Use with <code class="docutils literal notranslate"><span class="pre">dx</span></code> where <code class="docutils literal notranslate"><span class="pre">x0</span></code> is the starting
coordinate and <code class="docutils literal notranslate"><span class="pre">dx</span></code> the step.</p></li>
<li><p><strong>xaxis</strong> – Sets a reference between this trace’s x coordinates and
a 2D cartesian x axis. If “x” (the default value), the
x coordinates refer to <code class="docutils literal notranslate"><span class="pre">layout.xaxis</span></code>. If “x2”, the x
coordinates refer to <code class="docutils literal notranslate"><span class="pre">layout.xaxis2</span></code>, and so on.</p></li>
<li><p><strong>xcalendar</strong> – Sets the calendar system to use with <code class="docutils literal notranslate"><span class="pre">x</span></code> date data.</p></li>
<li><p><strong>xhoverformat</strong> – Sets the hover text formatting rulefor <code class="docutils literal notranslate"><span class="pre">x</span></code> using d3
formatting mini-languages which are very similar to
those in Python. For numbers, see:
<a class="reference external" href="https://github.com/d3/d3-format/tree/v1.4.5#d3-format">https://github.com/d3/d3-format/tree/v1.4.5#d3-format</a>.
And for dates see: <a class="reference external" href="https://github.com/d3/d3-time">https://github.com/d3/d3-time</a>-
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, <em>2016-10-13
09:15:23.456</em> with tickformat “%H~%M~%S.%2f” would
display <a href="#id1"><span class="problematic" id="id2">*</span></a>09~15~23.46*By default the values are
formatted using <code class="docutils literal notranslate"><span class="pre">xaxis.hoverformat</span></code>.</p></li>
<li><p><strong>xperiod</strong> – Only relevant when the axis <code class="docutils literal notranslate"><span class="pre">type</span></code> is “date”. Sets the
period positioning in milliseconds or “M<n>” on the x
axis. Special values in the form of “M<n>” could be
used to declare the number of months. In this case <code class="docutils literal notranslate"><span class="pre">n</span></code>
must be a positive integer.</p></li>
<li><p><strong>xperiod0</strong> – Only relevant when the axis <code class="docutils literal notranslate"><span class="pre">type</span></code> is “date”. Sets the
base for period positioning in milliseconds or date
string on the x0 axis. When <code class="docutils literal notranslate"><span class="pre">x0period</span></code> is round number
of weeks, the <code class="docutils literal notranslate"><span class="pre">x0period0</span></code> by default would be on a
Sunday i.e. 2000-01-02, otherwise it would be at
2000-01-01.</p></li>
<li><p><strong>xperiodalignment</strong> – Only relevant when the axis <code class="docutils literal notranslate"><span class="pre">type</span></code> is “date”. Sets the
alignment of data points on the x axis.</p></li>
<li><p><strong>xsrc</strong> – Sets the source reference on Chart Studio Cloud for
<code class="docutils literal notranslate"><span class="pre">x</span></code>.</p></li>
<li><p><strong>y</strong> – Sets the y coordinates.</p></li>
<li><p><strong>y0</strong> – Alternate to <code class="docutils literal notranslate"><span class="pre">y</span></code>. Builds a linear space of y
coordinates. Use with <code class="docutils literal notranslate"><span class="pre">dy</span></code> where <code class="docutils literal notranslate"><span class="pre">y0</span></code> is the starting
coordinate and <code class="docutils literal notranslate"><span class="pre">dy</span></code> the step.</p></li>
<li><p><strong>yaxis</strong> – Sets a reference between this trace’s y coordinates and
a 2D cartesian y axis. If “y” (the default value), the
y coordinates refer to <code class="docutils literal notranslate"><span class="pre">layout.yaxis</span></code>. If “y2”, the y
coordinates refer to <code class="docutils literal notranslate"><span class="pre">layout.yaxis2</span></code>, and so on.</p></li>
<li><p><strong>ycalendar</strong> – Sets the calendar system to use with <code class="docutils literal notranslate"><span class="pre">y</span></code> date data.</p></li>
<li><p><strong>yhoverformat</strong> – Sets the hover text formatting rulefor <code class="docutils literal notranslate"><span class="pre">y</span></code> using d3
formatting mini-languages which are very similar to
those in Python. For numbers, see:
<a class="reference external" href="https://github.com/d3/d3-format/tree/v1.4.5#d3-format">https://github.com/d3/d3-format/tree/v1.4.5#d3-format</a>.
And for dates see: <a class="reference external" href="https://github.com/d3/d3-time">https://github.com/d3/d3-time</a>-
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, <em>2016-10-13
09:15:23.456</em> with tickformat “%H~%M~%S.%2f” would
display <a href="#id3"><span class="problematic" id="id4">*</span></a>09~15~23.46*By default the values are
formatted using <code class="docutils literal notranslate"><span class="pre">yaxis.hoverformat</span></code>.</p></li>
<li><p><strong>yperiod</strong> – Only relevant when the axis <code class="docutils literal notranslate"><span class="pre">type</span></code> is “date”. Sets the
period positioning in milliseconds or “M<n>” on the y
axis. Special values in the form of “M<n>” could be
used to declare the number of months. In this case <code class="docutils literal notranslate"><span class="pre">n</span></code>
must be a positive integer.</p></li>
<li><p><strong>yperiod0</strong> – Only relevant when the axis <code class="docutils literal notranslate"><span class="pre">type</span></code> is “date”. Sets the
base for period positioning in milliseconds or date
string on the y0 axis. When <code class="docutils literal notranslate"><span class="pre">y0period</span></code> is round number
of weeks, the <code class="docutils literal notranslate"><span class="pre">y0period0</span></code> by default would be on a
Sunday i.e. 2000-01-02, otherwise it would be at
2000-01-01.</p></li>
<li><p><strong>yperiodalignment</strong> – Only relevant when the axis <code class="docutils literal notranslate"><span class="pre">type</span></code> is “date”. Sets the
alignment of data points on the y axis.</p></li>
<li><p><strong>ysrc</strong> – Sets the source reference on Chart Studio Cloud for
<code class="docutils literal notranslate"><span class="pre">y</span></code>.</p></li>
<li><p><strong>zorder</strong> – Sets the layer on which this trace is displayed,
relative to other SVG traces on the same subplot. SVG
traces with higher <code class="docutils literal notranslate"><span class="pre">zorder</span></code> appear in front of those
with lower <code class="docutils literal notranslate"><span class="pre">zorder</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p></p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#plotly.graph_objects.Bar" title="plotly.graph_objects.Bar">Bar</a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="id5">
<h1><a class="reference internal" href="plotly.graph_objects.html#module-plotly.graph_objects" title="plotly.graph_objects"><code class="xref py py-mod docutils literal notranslate"><span class="pre">plotly.graph_objects</span></code></a>.bar<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h1>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="plotly.graph_objects.bar.html#module-plotly.graph_objects.bar" title="plotly.graph_objects.bar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plotly.graph_objects.bar</span></code></a></p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
<span class="target" id="module-plotly.graph_objects.bar"></span><dl class="py class">
<dt id="plotly.graph_objects.bar.ErrorX">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">plotly.graph_objects.bar.</span></code><code class="sig-name descname"><span class="pre">ErrorX</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">array</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arrayminus</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arrayminussrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arraysrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">copy_ystyle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">symmetric</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">thickness</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">traceref</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tracerefminus</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">valueminus</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visible</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#plotly.graph_objects.bar.ErrorX" title="Permalink to this definition">¶</a></dt>
<dd><dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorX.array">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">array</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorX.array" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the data corresponding the length of each error bar.
Values are plotted relative to the underlying data.</p>
<p>The ‘array’ property is an array that may be specified as a tuple,
list, numpy array, or pandas Series</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>numpy.ndarray</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorX.arrayminus">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">arrayminus</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorX.arrayminus" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the data corresponding the length of each error bar in the
bottom (left) direction for vertical (horizontal) bars Values
are plotted relative to the underlying data.</p>
<p>The ‘arrayminus’ property is an array that may be specified as a tuple,
list, numpy array, or pandas Series</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>numpy.ndarray</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorX.arrayminussrc">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">arrayminussrc</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorX.arrayminussrc" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the source reference on Chart Studio Cloud for
<code class="docutils literal notranslate"><span class="pre">arrayminus</span></code>.</p>
<p>The ‘arrayminussrc’ property must be specified as a string or
as a plotly.grid_objs.Column object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">str</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorX.arraysrc">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">arraysrc</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorX.arraysrc" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the source reference on Chart Studio Cloud for <code class="docutils literal notranslate"><span class="pre">array</span></code>.</p>
<p>The ‘arraysrc’ property must be specified as a string or
as a plotly.grid_objs.Column object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">str</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorX.color">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">color</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorX.color" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the stroke color of the error bars.</p>
<dl class="simple">
<dt>The ‘color’ property is a color and may be specified as:</dt><dd><ul class="simple">
<li><p>A hex string (e.g. ‘#ff0000’)</p></li>
<li><p>An rgb/rgba string (e.g. ‘rgb(255,0,0)’)</p></li>
<li><p>An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)</p></li>
<li><p>An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)</p></li>
<li><p>A named CSS color: see <a class="reference external" href="https://plotly.com/python/css-colors/">https://plotly.com/python/css-colors/</a> for a list</p></li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">str</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorX.copy_ystyle">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">copy_ystyle</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorX.copy_ystyle" title="Permalink to this definition">¶</a></dt>
<dd><dl class="simple">
<dt>The ‘copy_ystyle’ property is a boolean and must be specified as:</dt><dd><ul class="simple">
<li><p>A boolean value: True or False</p></li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)">bool</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorX.symmetric">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">symmetric</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorX.symmetric" title="Permalink to this definition">¶</a></dt>
<dd><p>Determines whether or not the error bars have the same length
in both direction (top/bottom for vertical bars, left/right for
horizontal bars.</p>
<dl class="simple">
<dt>The ‘symmetric’ property is a boolean and must be specified as:</dt><dd><ul class="simple">
<li><p>A boolean value: True or False</p></li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)">bool</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorX.thickness">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">thickness</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorX.thickness" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the thickness (in px) of the error bars.</p>
<dl class="simple">
<dt>The ‘thickness’ property is a number and may be specified as:</dt><dd><ul class="simple">
<li><p>An int or float in the interval [0, inf]</p></li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>int|float</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorX.traceref">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">traceref</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorX.traceref" title="Permalink to this definition">¶</a></dt>
<dd><dl class="simple">
<dt>The ‘traceref’ property is a integer and may be specified as:</dt><dd><ul class="simple">
<li><p>An int (or float that will be cast to an int)
in the interval [0, 9223372036854775807]</p></li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorX.tracerefminus">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">tracerefminus</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorX.tracerefminus" title="Permalink to this definition">¶</a></dt>
<dd><dl class="simple">
<dt>The ‘tracerefminus’ property is a integer and may be specified as:</dt><dd><ul class="simple">
<li><p>An int (or float that will be cast to an int)
in the interval [0, 9223372036854775807]</p></li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorX.type">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">type</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorX.type" title="Permalink to this definition">¶</a></dt>
<dd><p>Determines the rule used to generate the error bars. If
“constant”, the bar lengths are of a constant value. Set this
constant in <code class="docutils literal notranslate"><span class="pre">value</span></code>. If “percent”, the bar lengths correspond
to a percentage of underlying data. Set this percentage in
<code class="docutils literal notranslate"><span class="pre">value</span></code>. If “sqrt”, the bar lengths correspond to the square of
the underlying data. If “data”, the bar lengths are set with
data set <code class="docutils literal notranslate"><span class="pre">array</span></code>.</p>
<dl class="simple">
<dt>The ‘type’ property is an enumeration that may be specified as:</dt><dd><ul class="simple">
<li><dl class="simple">
<dt>One of the following enumeration values:</dt><dd><p>[‘percent’, ‘constant’, ‘sqrt’, ‘data’]</p>
</dd>
</dl>
</li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Any</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorX.value">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">value</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorX.value" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the value of either the percentage (if <code class="docutils literal notranslate"><span class="pre">type</span></code> is set to
“percent”) or the constant (if <code class="docutils literal notranslate"><span class="pre">type</span></code> is set to “constant”)
corresponding to the lengths of the error bars.</p>
<dl class="simple">
<dt>The ‘value’ property is a number and may be specified as:</dt><dd><ul class="simple">
<li><p>An int or float in the interval [0, inf]</p></li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>int|float</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorX.valueminus">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">valueminus</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorX.valueminus" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the value of either the percentage (if <code class="docutils literal notranslate"><span class="pre">type</span></code> is set to
“percent”) or the constant (if <code class="docutils literal notranslate"><span class="pre">type</span></code> is set to “constant”)
corresponding to the lengths of the error bars in the bottom
(left) direction for vertical (horizontal) bars</p>
<dl class="simple">
<dt>The ‘valueminus’ property is a number and may be specified as:</dt><dd><ul class="simple">
<li><p>An int or float in the interval [0, inf]</p></li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>int|float</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorX.visible">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">visible</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorX.visible" title="Permalink to this definition">¶</a></dt>
<dd><p>Determines whether or not this set of error bars is visible.</p>
<dl class="simple">
<dt>The ‘visible’ property is a boolean and must be specified as:</dt><dd><ul class="simple">
<li><p>A boolean value: True or False</p></li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)">bool</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorX.width">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">width</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorX.width" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the width (in px) of the cross-bar at both ends of the
error bars.</p>
<dl class="simple">
<dt>The ‘width’ property is a number and may be specified as:</dt><dd><ul class="simple">
<li><p>An int or float in the interval [0, inf]</p></li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>int|float</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="plotly.graph_objects.bar.ErrorY">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">plotly.graph_objects.bar.</span></code><code class="sig-name descname"><span class="pre">ErrorY</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">array</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arrayminus</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arrayminussrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arraysrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">symmetric</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">thickness</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">traceref</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tracerefminus</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">valueminus</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visible</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#plotly.graph_objects.bar.ErrorY" title="Permalink to this definition">¶</a></dt>
<dd><dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorY.array">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">array</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorY.array" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the data corresponding the length of each error bar.
Values are plotted relative to the underlying data.</p>
<p>The ‘array’ property is an array that may be specified as a tuple,
list, numpy array, or pandas Series</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>numpy.ndarray</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorY.arrayminus">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">arrayminus</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorY.arrayminus" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the data corresponding the length of each error bar in the
bottom (left) direction for vertical (horizontal) bars Values
are plotted relative to the underlying data.</p>
<p>The ‘arrayminus’ property is an array that may be specified as a tuple,
list, numpy array, or pandas Series</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>numpy.ndarray</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorY.arrayminussrc">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">arrayminussrc</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorY.arrayminussrc" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the source reference on Chart Studio Cloud for
<code class="docutils literal notranslate"><span class="pre">arrayminus</span></code>.</p>
<p>The ‘arrayminussrc’ property must be specified as a string or
as a plotly.grid_objs.Column object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">str</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorY.arraysrc">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">arraysrc</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorY.arraysrc" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the source reference on Chart Studio Cloud for <code class="docutils literal notranslate"><span class="pre">array</span></code>.</p>
<p>The ‘arraysrc’ property must be specified as a string or
as a plotly.grid_objs.Column object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">str</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorY.color">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">color</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorY.color" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the stroke color of the error bars.</p>
<dl class="simple">
<dt>The ‘color’ property is a color and may be specified as:</dt><dd><ul class="simple">
<li><p>A hex string (e.g. ‘#ff0000’)</p></li>
<li><p>An rgb/rgba string (e.g. ‘rgb(255,0,0)’)</p></li>
<li><p>An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)</p></li>
<li><p>An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)</p></li>
<li><p>A named CSS color: see <a class="reference external" href="https://plotly.com/python/css-colors/">https://plotly.com/python/css-colors/</a> for a list</p></li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">str</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorY.symmetric">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">symmetric</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorY.symmetric" title="Permalink to this definition">¶</a></dt>
<dd><p>Determines whether or not the error bars have the same length
in both direction (top/bottom for vertical bars, left/right for
horizontal bars.</p>
<dl class="simple">
<dt>The ‘symmetric’ property is a boolean and must be specified as:</dt><dd><ul class="simple">
<li><p>A boolean value: True or False</p></li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)">bool</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorY.thickness">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">thickness</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorY.thickness" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the thickness (in px) of the error bars.</p>
<dl class="simple">
<dt>The ‘thickness’ property is a number and may be specified as:</dt><dd><ul class="simple">
<li><p>An int or float in the interval [0, inf]</p></li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>int|float</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorY.traceref">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">traceref</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorY.traceref" title="Permalink to this definition">¶</a></dt>
<dd><dl class="simple">
<dt>The ‘traceref’ property is a integer and may be specified as:</dt><dd><ul class="simple">
<li><p>An int (or float that will be cast to an int)
in the interval [0, 9223372036854775807]</p></li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorY.tracerefminus">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">tracerefminus</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorY.tracerefminus" title="Permalink to this definition">¶</a></dt>
<dd><dl class="simple">
<dt>The ‘tracerefminus’ property is a integer and may be specified as:</dt><dd><ul class="simple">
<li><p>An int (or float that will be cast to an int)
in the interval [0, 9223372036854775807]</p></li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.bar.ErrorY.type">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">type</span></code><a class="headerlink" href="#plotly.graph_objects.bar.ErrorY.type" title="Permalink to this definition">¶</a></dt>
<dd><p>Determines the rule used to generate the error bars. If
“constant”, the bar lengths are of a constant value. Set this
constant in <code class="docutils literal notranslate"><span class="pre">value</span></code>. If “percent”, the bar lengths correspond
to a percentage of underlying data. Set this percentage in
<code class="docutils literal notranslate"><span class="pre">value</span></code>. If “sqrt”, the bar lengths correspond to the square of
the underlying data. If “data”, the bar lengths are set with
data set <code class="docutils literal notranslate"><span class="pre">array</span></code>.</p>
<dl class="simple">
<dt>The ‘type’ property is an enumeration that may be specified as:</dt><dd><ul class="simple">
<li><dl class="simple">
<dt>One of the following enumeration values:</dt><dd><p>[‘percent’, ‘constant’, ‘sqrt’, ‘data’]</p>
</dd>
</dl>
</li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Any</p>
</dd>
</dl>
</dd></dl>