-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathplotly.graph_objects.Treemap.html
More file actions
2207 lines (2109 loc) · 119 KB
/
plotly.graph_objects.Treemap.html
File metadata and controls
2207 lines (2109 loc) · 119 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 xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>plotly.graph_objects.Treemap — 4.6.0 documentation</title>
<link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/plotly-style.css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.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.Sankey" href="plotly.graph_objects.Sankey.html" />
<link rel="prev" title="plotly.graph_objects.Sunburst" href="plotly.graph_objects.Sunburst.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.11.0.min.js "></script>
<script type="text/javascript" src="../_static/js/jquery-fix.js "></script>
<script type="text/javascript" src="../_static/bootstrap-3.3.7/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>.Treemap</a></li>
<li><a class="reference internal" href="#id1"><code class="xref py py-mod docutils literal notranslate"><span class="pre">plotly.graph_objects</span></code>.treemap</a></li>
</ul>
</ul>
</li>
<li>
<a href="plotly.graph_objects.Sunburst.html" title="Previous Chapter: plotly.graph_objects.Sunburst"><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.Sankey.html" title="Next Chapter: plotly.graph_objects.Sankey"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">plotly.graph_... »</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-treemap">
<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>.Treemap<a class="headerlink" href="#plotly-graph-objs-treemap" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="plotly.graph_objects.Treemap">
<em class="property">class </em><code class="sig-prename descclassname">plotly.graph_objects.</code><code class="sig-name descname">Treemap</code><span class="sig-paren">(</span><em class="sig-param">arg=None</em>, <em class="sig-param">branchvalues=None</em>, <em class="sig-param">count=None</em>, <em class="sig-param">customdata=None</em>, <em class="sig-param">customdatasrc=None</em>, <em class="sig-param">domain=None</em>, <em class="sig-param">hoverinfo=None</em>, <em class="sig-param">hoverinfosrc=None</em>, <em class="sig-param">hoverlabel=None</em>, <em class="sig-param">hovertemplate=None</em>, <em class="sig-param">hovertemplatesrc=None</em>, <em class="sig-param">hovertext=None</em>, <em class="sig-param">hovertextsrc=None</em>, <em class="sig-param">ids=None</em>, <em class="sig-param">idssrc=None</em>, <em class="sig-param">insidetextfont=None</em>, <em class="sig-param">labels=None</em>, <em class="sig-param">labelssrc=None</em>, <em class="sig-param">level=None</em>, <em class="sig-param">marker=None</em>, <em class="sig-param">maxdepth=None</em>, <em class="sig-param">meta=None</em>, <em class="sig-param">metasrc=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">opacity=None</em>, <em class="sig-param">outsidetextfont=None</em>, <em class="sig-param">parents=None</em>, <em class="sig-param">parentssrc=None</em>, <em class="sig-param">pathbar=None</em>, <em class="sig-param">stream=None</em>, <em class="sig-param">text=None</em>, <em class="sig-param">textfont=None</em>, <em class="sig-param">textinfo=None</em>, <em class="sig-param">textposition=None</em>, <em class="sig-param">textsrc=None</em>, <em class="sig-param">texttemplate=None</em>, <em class="sig-param">texttemplatesrc=None</em>, <em class="sig-param">tiling=None</em>, <em class="sig-param">uid=None</em>, <em class="sig-param">uirevision=None</em>, <em class="sig-param">values=None</em>, <em class="sig-param">valuessrc=None</em>, <em class="sig-param">visible=None</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#plotly.graph_objects.Treemap" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="plotly.graph_objects.Treemap.__init__">
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param">arg=None</em>, <em class="sig-param">branchvalues=None</em>, <em class="sig-param">count=None</em>, <em class="sig-param">customdata=None</em>, <em class="sig-param">customdatasrc=None</em>, <em class="sig-param">domain=None</em>, <em class="sig-param">hoverinfo=None</em>, <em class="sig-param">hoverinfosrc=None</em>, <em class="sig-param">hoverlabel=None</em>, <em class="sig-param">hovertemplate=None</em>, <em class="sig-param">hovertemplatesrc=None</em>, <em class="sig-param">hovertext=None</em>, <em class="sig-param">hovertextsrc=None</em>, <em class="sig-param">ids=None</em>, <em class="sig-param">idssrc=None</em>, <em class="sig-param">insidetextfont=None</em>, <em class="sig-param">labels=None</em>, <em class="sig-param">labelssrc=None</em>, <em class="sig-param">level=None</em>, <em class="sig-param">marker=None</em>, <em class="sig-param">maxdepth=None</em>, <em class="sig-param">meta=None</em>, <em class="sig-param">metasrc=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">opacity=None</em>, <em class="sig-param">outsidetextfont=None</em>, <em class="sig-param">parents=None</em>, <em class="sig-param">parentssrc=None</em>, <em class="sig-param">pathbar=None</em>, <em class="sig-param">stream=None</em>, <em class="sig-param">text=None</em>, <em class="sig-param">textfont=None</em>, <em class="sig-param">textinfo=None</em>, <em class="sig-param">textposition=None</em>, <em class="sig-param">textsrc=None</em>, <em class="sig-param">texttemplate=None</em>, <em class="sig-param">texttemplatesrc=None</em>, <em class="sig-param">tiling=None</em>, <em class="sig-param">uid=None</em>, <em class="sig-param">uirevision=None</em>, <em class="sig-param">values=None</em>, <em class="sig-param">valuessrc=None</em>, <em class="sig-param">visible=None</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#plotly.graph_objects.Treemap.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Construct a new Treemap object</p>
<p>Visualize hierarchal data from leaves (and/or outer branches)
towards root with rectangles. The treemap sectors are
determined by the entries in “labels” or “ids” and in
“parents”.</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.Treemap" title="plotly.graph_objects.Treemap"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.Treemap</span></code></a></p></li>
<li><p><strong>branchvalues</strong> – Determines how the items in <code class="docutils literal notranslate"><span class="pre">values</span></code> are summed. When
set to “total”, items in <code class="docutils literal notranslate"><span class="pre">values</span></code> are taken to be value
of all its descendants. When set to “remainder”, items
in <code class="docutils literal notranslate"><span class="pre">values</span></code> corresponding to the root and the branches
sectors are taken to be the extra part not part of the
sum of the values at their leaves.</p></li>
<li><p><strong>count</strong> – Determines default for <code class="docutils literal notranslate"><span class="pre">values</span></code> when it is not
provided, by inferring a 1 for each of the “leaves”
and/or “branches”, otherwise 0.</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
customdata .</p></li>
<li><p><strong>domain</strong> – <a class="reference internal" href="plotly.graph_objects.treemap.html#plotly.graph_objects.treemap.Domain" title="plotly.graph_objects.treemap.Domain"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.treemap.Domain</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
hoverinfo .</p></li>
<li><p><strong>hoverlabel</strong> – <a class="reference internal" href="plotly.graph_objects.treemap.html#plotly.graph_objects.treemap.Hoverlabel" title="plotly.graph_objects.treemap.Hoverlabel"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.treemap.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}”. Numbers are formatted using
d3-format’s syntax %{variable:d3-format}, for example
“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api-
reference/blob/master/Formatting.md#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-3.x-api-
reference/blob/master/Time-Formatting.md#format for
details on the date formatting syntax. 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, every 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. variables <code class="docutils literal notranslate"><span class="pre">currentPath</span></code>, <code class="docutils literal notranslate"><span class="pre">root</span></code>,
<code class="docutils literal notranslate"><span class="pre">entry</span></code>, <code class="docutils literal notranslate"><span class="pre">percentRoot</span></code>, <code class="docutils literal notranslate"><span class="pre">percentEntry</span></code> and
<code class="docutils literal notranslate"><span class="pre">percentParent</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
“<extra>{fullData.name}</extra>”. 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>hovertemplatesrc</strong> – Sets the source reference on Chart Studio Cloud for
hovertemplate .</p></li>
<li><p><strong>hovertext</strong> – Sets hover text elements associated with each sector.
If a single string, the same string appears for all
data points. If an array of string, the items are
mapped in order of this trace’s sectors. 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
hovertext .</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
ids .</p></li>
<li><p><strong>insidetextfont</strong> – Sets the font used for <code class="docutils literal notranslate"><span class="pre">textinfo</span></code> lying inside the
sector.</p></li>
<li><p><strong>labels</strong> – Sets the labels of each of the sectors.</p></li>
<li><p><strong>labelssrc</strong> – Sets the source reference on Chart Studio Cloud for
labels .</p></li>
<li><p><strong>level</strong> – Sets the level from which this trace hierarchy is
rendered. Set <code class="docutils literal notranslate"><span class="pre">level</span></code> to <code class="docutils literal notranslate"><span class="pre">''</span></code> to start from the root
node in the hierarchy. Must be an “id” if <code class="docutils literal notranslate"><span class="pre">ids</span></code> is
filled in, otherwise plotly attempts to find a matching
item in <code class="docutils literal notranslate"><span class="pre">labels</span></code>.</p></li>
<li><p><strong>marker</strong> – <a class="reference internal" href="plotly.graph_objects.treemap.html#plotly.graph_objects.treemap.Marker" title="plotly.graph_objects.treemap.Marker"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.treemap.Marker</span></code></a> instance
or dict with compatible properties</p></li>
<li><p><strong>maxdepth</strong> – Sets the number of rendered sectors from any given
<code class="docutils literal notranslate"><span class="pre">level</span></code>. Set <code class="docutils literal notranslate"><span class="pre">maxdepth</span></code> to “-1” to render all the
levels in the hierarchy.</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
meta .</p></li>
<li><p><strong>name</strong> – Sets the trace name. The trace name appear as the
legend item and on hover.</p></li>
<li><p><strong>opacity</strong> – Sets the opacity of the trace.</p></li>
<li><p><strong>outsidetextfont</strong> – Sets the font used for <code class="docutils literal notranslate"><span class="pre">textinfo</span></code> lying outside the
sector. This option refers to the root of the hierarchy
presented on top left corner of a treemap graph. Please
note that if a hierarchy has multiple root nodes, this
option won’t have any effect and <code class="docutils literal notranslate"><span class="pre">insidetextfont</span></code> would
be used.</p></li>
<li><p><strong>parents</strong> – Sets the parent sectors for each of the sectors. Empty
string items ‘’ are understood to reference the root
node in the hierarchy. If <code class="docutils literal notranslate"><span class="pre">ids</span></code> is filled, <code class="docutils literal notranslate"><span class="pre">parents</span></code>
items are understood to be “ids” themselves. When <code class="docutils literal notranslate"><span class="pre">ids</span></code>
is not set, plotly attempts to find matching items in
<code class="docutils literal notranslate"><span class="pre">labels</span></code>, but beware they must be unique.</p></li>
<li><p><strong>parentssrc</strong> – Sets the source reference on Chart Studio Cloud for
parents .</p></li>
<li><p><strong>pathbar</strong> – <a class="reference internal" href="plotly.graph_objects.treemap.html#plotly.graph_objects.treemap.Pathbar" title="plotly.graph_objects.treemap.Pathbar"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.treemap.Pathbar</span></code></a> instance
or dict with compatible properties</p></li>
<li><p><strong>stream</strong> – <a class="reference internal" href="plotly.graph_objects.treemap.html#plotly.graph_objects.treemap.Stream" title="plotly.graph_objects.treemap.Stream"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.treemap.Stream</span></code></a> instance
or dict with compatible properties</p></li>
<li><p><strong>text</strong> – Sets text elements associated with each sector. If
trace <code class="docutils literal notranslate"><span class="pre">textinfo</span></code> contains a “text” flag, these elements
will be seen on the chart. 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>textfont</strong> – Sets the font used for <code class="docutils literal notranslate"><span class="pre">textinfo</span></code>.</p></li>
<li><p><strong>textinfo</strong> – Determines which trace information appear on the graph.</p></li>
<li><p><strong>textposition</strong> – Sets the positions of the <code class="docutils literal notranslate"><span class="pre">text</span></code> elements.</p></li>
<li><p><strong>textsrc</strong> – Sets the source reference on Chart Studio Cloud for
text .</p></li>
<li><p><strong>texttemplate</strong> – Template string used for rendering the information text
that appear 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-3.x-api-
reference/blob/master/Formatting.md#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-3.x-api-
reference/blob/master/Time-Formatting.md#format for
details on the date formatting syntax. Every 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. variables
<code class="docutils literal notranslate"><span class="pre">currentPath</span></code>, <code class="docutils literal notranslate"><span class="pre">root</span></code>, <code class="docutils literal notranslate"><span class="pre">entry</span></code>, <code class="docutils literal notranslate"><span class="pre">percentRoot</span></code>,
<code class="docutils literal notranslate"><span class="pre">percentEntry</span></code>, <code class="docutils literal notranslate"><span class="pre">percentParent</span></code>, <code class="docutils literal notranslate"><span class="pre">label</span></code> and <code class="docutils literal notranslate"><span class="pre">value</span></code>.</p></li>
<li><p><strong>texttemplatesrc</strong> – Sets the source reference on Chart Studio Cloud for
texttemplate .</p></li>
<li><p><strong>tiling</strong> – <a class="reference internal" href="plotly.graph_objects.treemap.html#plotly.graph_objects.treemap.Tiling" title="plotly.graph_objects.treemap.Tiling"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.treemap.Tiling</span></code></a> instance
or dict with compatible properties</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>values</strong> – Sets the values associated with each of the sectors.
Use with <code class="docutils literal notranslate"><span class="pre">branchvalues</span></code> to determine how the values are
summed.</p></li>
<li><p><strong>valuessrc</strong> – Sets the source reference on Chart Studio Cloud for
values .</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>
</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.html#plotly.graph_objects.Treemap" title="plotly.graph_objects.Treemap">Treemap</a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="id1">
<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>.treemap<a class="headerlink" href="#id1" 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="#module-plotly.graph_objects.treemap" title="plotly.graph_objects.treemap"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plotly.graph_objects.treemap</span></code></a></p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
<span class="target" id="module-plotly.graph_objects.treemap"></span><dl class="class">
<dt id="plotly.graph_objects.treemap.Tiling">
<em class="property">class </em><code class="sig-prename descclassname">plotly.graph_objects.treemap.</code><code class="sig-name descname">Tiling</code><span class="sig-paren">(</span><em class="sig-param">arg=None</em>, <em class="sig-param">flip=None</em>, <em class="sig-param">packing=None</em>, <em class="sig-param">pad=None</em>, <em class="sig-param">squarifyratio=None</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#plotly.graph_objects.treemap.Tiling" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="plotly.graph_objects.treemap.Tiling.flip">
<em class="property">property </em><code class="sig-name descname">flip</code><a class="headerlink" href="#plotly.graph_objects.treemap.Tiling.flip" title="Permalink to this definition">¶</a></dt>
<dd><p>Determines if the positions obtained from solver are flipped on
each axis.</p>
<p>The ‘flip’ property is a flaglist and may be specified
as a string containing:</p>
<blockquote>
<div><ul class="simple">
<li><p>Any combination of [‘x’, ‘y’] joined with ‘+’ characters
(e.g. ‘x+y’)</p></li>
</ul>
</div></blockquote>
<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="method">
<dt id="plotly.graph_objects.treemap.Tiling.packing">
<em class="property">property </em><code class="sig-name descname">packing</code><a class="headerlink" href="#plotly.graph_objects.treemap.Tiling.packing" title="Permalink to this definition">¶</a></dt>
<dd><p>Determines d3 treemap solver. For more info please refer to
<a class="reference external" href="https://github.com/d3/d3-hierarchy#treemap-tiling">https://github.com/d3/d3-hierarchy#treemap-tiling</a></p>
<dl class="simple">
<dt>The ‘packing’ 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>[‘squarify’, ‘binary’, ‘dice’, ‘slice’, ‘slice-dice’,
‘dice-slice’]</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="method">
<dt id="plotly.graph_objects.treemap.Tiling.pad">
<em class="property">property </em><code class="sig-name descname">pad</code><a class="headerlink" href="#plotly.graph_objects.treemap.Tiling.pad" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the inner padding (in px).</p>
<dl class="simple">
<dt>The ‘pad’ 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="method">
<dt id="plotly.graph_objects.treemap.Tiling.squarifyratio">
<em class="property">property </em><code class="sig-name descname">squarifyratio</code><a class="headerlink" href="#plotly.graph_objects.treemap.Tiling.squarifyratio" title="Permalink to this definition">¶</a></dt>
<dd><p>/
/github.com/d3/d3-hierarchy/blob/master/README.md#squarify_rati
o this option specifies the desired aspect ratio of the
generated rectangles. The ratio must be specified as a number
greater than or equal to one. Note that the orientation of the
generated rectangles (tall or wide) is not implied by the
ratio; for example, a ratio of two will attempt to produce a
mixture of rectangles whose width:height ratio is either 2:1 or
1:2. When using “squarify”, unlike d3 which uses the Golden
Ratio i.e. 1.618034, Plotly applies 1 to increase squares in
treemap layouts.</p>
<dl class="simple">
<dt>The ‘squarifyratio’ property is a number and may be specified as:</dt><dd><ul class="simple">
<li><p>An int or float in the interval [1, 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>
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>When using “squarify” <code class="docutils literal notranslate"><span class="pre">packing</span></code> algorithm, according to https</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="plotly.graph_objects.treemap.Textfont">
<em class="property">class </em><code class="sig-prename descclassname">plotly.graph_objects.treemap.</code><code class="sig-name descname">Textfont</code><span class="sig-paren">(</span><em class="sig-param">arg=None</em>, <em class="sig-param">color=None</em>, <em class="sig-param">colorsrc=None</em>, <em class="sig-param">family=None</em>, <em class="sig-param">familysrc=None</em>, <em class="sig-param">size=None</em>, <em class="sig-param">sizesrc=None</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#plotly.graph_objects.treemap.Textfont" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="plotly.graph_objects.treemap.Textfont.color">
<em class="property">property </em><code class="sig-name descname">color</code><a class="headerlink" href="#plotly.graph_objects.treemap.Textfont.color" title="Permalink to this definition">¶</a></dt>
<dd><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><dl class="simple">
<dt>A named CSS color:</dt><dd><p>aliceblue, antiquewhite, aqua, aquamarine, azure,
beige, bisque, black, blanchedalmond, blue,
blueviolet, brown, burlywood, cadetblue,
chartreuse, chocolate, coral, cornflowerblue,
cornsilk, crimson, cyan, darkblue, darkcyan,
darkgoldenrod, darkgray, darkgrey, darkgreen,
darkkhaki, darkmagenta, darkolivegreen, darkorange,
darkorchid, darkred, darksalmon, darkseagreen,
darkslateblue, darkslategray, darkslategrey,
darkturquoise, darkviolet, deeppink, deepskyblue,
dimgray, dimgrey, dodgerblue, firebrick,
floralwhite, forestgreen, fuchsia, gainsboro,
ghostwhite, gold, goldenrod, gray, grey, green,
greenyellow, honeydew, hotpink, indianred, indigo,
ivory, khaki, lavender, lavenderblush, lawngreen,
lemonchiffon, lightblue, lightcoral, lightcyan,
lightgoldenrodyellow, lightgray, lightgrey,
lightgreen, lightpink, lightsalmon, lightseagreen,
lightskyblue, lightslategray, lightslategrey,
lightsteelblue, lightyellow, lime, limegreen,
linen, magenta, maroon, mediumaquamarine,
mediumblue, mediumorchid, mediumpurple,
mediumseagreen, mediumslateblue, mediumspringgreen,
mediumturquoise, mediumvioletred, midnightblue,
mintcream, mistyrose, moccasin, navajowhite, navy,
oldlace, olive, olivedrab, orange, orangered,
orchid, palegoldenrod, palegreen, paleturquoise,
palevioletred, papayawhip, peachpuff, peru, pink,
plum, powderblue, purple, red, rosybrown,
royalblue, rebeccapurple, saddlebrown, salmon,
sandybrown, seagreen, seashell, sienna, silver,
skyblue, slateblue, slategray, slategrey, snow,
springgreen, steelblue, tan, teal, thistle, tomato,
turquoise, violet, wheat, white, whitesmoke,
yellow, yellowgreen</p>
</dd>
</dl>
</li>
<li><p>A list or array of any of the above</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>str|numpy.ndarray</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="plotly.graph_objects.treemap.Textfont.colorsrc">
<em class="property">property </em><code class="sig-name descname">colorsrc</code><a class="headerlink" href="#plotly.graph_objects.treemap.Textfont.colorsrc" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the source reference on Chart Studio Cloud for color .</p>
<p>The ‘colorsrc’ 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.8)">str</a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="plotly.graph_objects.treemap.Textfont.family">
<em class="property">property </em><code class="sig-name descname">family</code><a class="headerlink" href="#plotly.graph_objects.treemap.Textfont.family" title="Permalink to this definition">¶</a></dt>
<dd><p>HTML font family - the typeface that will be applied by the web
browser. The web browser will only be able to apply a font if
it is available on the system which it operates. Provide
multiple font families, separated by commas, to indicate the
preference in which to apply fonts if they aren’t available on
the system. The Chart Studio Cloud (at <a class="reference external" href="https://chart">https://chart</a>-
studio.plotly.com or on-premise) generates images on a server,
where only a select number of fonts are installed and
supported. These include “Arial”, “Balto”, “Courier New”,
“Droid Sans”,, “Droid Serif”, “Droid Sans Mono”, “Gravitas
One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans
Narrow”, “Raleway”, “Times New Roman”.</p>
<dl class="simple">
<dt>The ‘family’ property is a string and must be specified as:</dt><dd><ul class="simple">
<li><p>A non-empty string</p></li>
<li><p>A tuple, list, or one-dimensional numpy array of the above</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>str|numpy.ndarray</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="plotly.graph_objects.treemap.Textfont.familysrc">
<em class="property">property </em><code class="sig-name descname">familysrc</code><a class="headerlink" href="#plotly.graph_objects.treemap.Textfont.familysrc" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the source reference on Chart Studio Cloud for family .</p>
<p>The ‘familysrc’ 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.8)">str</a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="plotly.graph_objects.treemap.Textfont.size">
<em class="property">property </em><code class="sig-name descname">size</code><a class="headerlink" href="#plotly.graph_objects.treemap.Textfont.size" title="Permalink to this definition">¶</a></dt>
<dd><dl class="simple">
<dt>The ‘size’ property is a number and may be specified as:</dt><dd><ul class="simple">
<li><p>An int or float in the interval [1, inf]</p></li>
<li><p>A tuple, list, or one-dimensional numpy array of the above</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|numpy.ndarray</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="plotly.graph_objects.treemap.Textfont.sizesrc">
<em class="property">property </em><code class="sig-name descname">sizesrc</code><a class="headerlink" href="#plotly.graph_objects.treemap.Textfont.sizesrc" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the source reference on Chart Studio Cloud for size .</p>
<p>The ‘sizesrc’ 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.8)">str</a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="plotly.graph_objects.treemap.Stream">
<em class="property">class </em><code class="sig-prename descclassname">plotly.graph_objects.treemap.</code><code class="sig-name descname">Stream</code><span class="sig-paren">(</span><em class="sig-param">arg=None</em>, <em class="sig-param">maxpoints=None</em>, <em class="sig-param">token=None</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#plotly.graph_objects.treemap.Stream" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="plotly.graph_objects.treemap.Stream.maxpoints">
<em class="property">property </em><code class="sig-name descname">maxpoints</code><a class="headerlink" href="#plotly.graph_objects.treemap.Stream.maxpoints" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the maximum number of points to keep on the plots from an
incoming stream. If <code class="docutils literal notranslate"><span class="pre">maxpoints</span></code> is set to 50, only the newest
50 points will be displayed on the plot.</p>
<dl class="simple">
<dt>The ‘maxpoints’ property is a number and may be specified as:</dt><dd><ul class="simple">
<li><p>An int or float in the interval [0, 10000]</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="method">
<dt id="plotly.graph_objects.treemap.Stream.token">
<em class="property">property </em><code class="sig-name descname">token</code><a class="headerlink" href="#plotly.graph_objects.treemap.Stream.token" title="Permalink to this definition">¶</a></dt>
<dd><p>The stream id number links a data trace on a plot with a
stream. See <a class="reference external" href="https://chart-studio.plotly.com/settings">https://chart-studio.plotly.com/settings</a> for more
details.</p>
<dl class="simple">
<dt>The ‘token’ property is a string and must be specified as:</dt><dd><ul class="simple">
<li><p>A non-empty string</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.8)">str</a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="plotly.graph_objects.treemap.Pathbar">
<em class="property">class </em><code class="sig-prename descclassname">plotly.graph_objects.treemap.</code><code class="sig-name descname">Pathbar</code><span class="sig-paren">(</span><em class="sig-param">arg=None</em>, <em class="sig-param">edgeshape=None</em>, <em class="sig-param">side=None</em>, <em class="sig-param">textfont=None</em>, <em class="sig-param">thickness=None</em>, <em class="sig-param">visible=None</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#plotly.graph_objects.treemap.Pathbar" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="plotly.graph_objects.treemap.Pathbar.edgeshape">
<em class="property">property </em><code class="sig-name descname">edgeshape</code><a class="headerlink" href="#plotly.graph_objects.treemap.Pathbar.edgeshape" title="Permalink to this definition">¶</a></dt>
<dd><p>Determines which shape is used for edges between <code class="docutils literal notranslate"><span class="pre">barpath</span></code>
labels.</p>
<dl class="simple">
<dt>The ‘edgeshape’ 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>[‘>’, ‘<’, ‘|’, ‘’]</p>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>A string that matches one of the following regular expressions:</dt><dd><p>[‘’]</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="method">
<dt id="plotly.graph_objects.treemap.Pathbar.side">
<em class="property">property </em><code class="sig-name descname">side</code><a class="headerlink" href="#plotly.graph_objects.treemap.Pathbar.side" title="Permalink to this definition">¶</a></dt>
<dd><p>Determines on which side of the the treemap the <code class="docutils literal notranslate"><span class="pre">pathbar</span></code>
should be presented.</p>
<dl class="simple">
<dt>The ‘side’ 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>[‘top’, ‘bottom’]</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="method">
<dt id="plotly.graph_objects.treemap.Pathbar.textfont">
<em class="property">property </em><code class="sig-name descname">textfont</code><a class="headerlink" href="#plotly.graph_objects.treemap.Pathbar.textfont" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the font used inside <code class="docutils literal notranslate"><span class="pre">pathbar</span></code>.</p>
<p>The ‘textfont’ property is an instance of Textfont
that may be specified as:</p>
<blockquote>
<div><ul>
<li><p>An instance of <a class="reference internal" href="plotly.graph_objects.treemap.pathbar.html#plotly.graph_objects.treemap.pathbar.Textfont" title="plotly.graph_objects.treemap.pathbar.Textfont"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.treemap.pathbar.Textfont</span></code></a></p></li>
<li><p>A dict of string/value properties that will be passed
to the Textfont constructor</p>
<p>Supported dict properties:</p>
<blockquote>
<div><p>color</p>
<dl class="simple">
<dt>colorsrc</dt><dd><p>Sets the source reference on Chart Studio Cloud
for color .</p>
</dd>
<dt>family</dt><dd><p>HTML font family - the typeface that will be
applied by the web browser. The web browser
will only be able to apply a font if it is
available on the system which it operates.
Provide multiple font families, separated by
commas, to indicate the preference in which to
apply fonts if they aren’t available on the
system. The Chart Studio Cloud (at
<a class="reference external" href="https://chart-studio.plotly.com">https://chart-studio.plotly.com</a> or on-premise)
generates images on a server, where only a
select number of fonts are installed and
supported. These include “Arial”, “Balto”,
“Courier New”, “Droid Sans”,, “Droid Serif”,
“Droid Sans Mono”, “Gravitas One”, “Old
Standard TT”, “Open Sans”, “Overpass”, “PT Sans
Narrow”, “Raleway”, “Times New Roman”.</p>
</dd>
<dt>familysrc</dt><dd><p>Sets the source reference on Chart Studio Cloud
for family .</p>
</dd>
</dl>
<p>size</p>
<dl class="simple">
<dt>sizesrc</dt><dd><p>Sets the source reference on Chart Studio Cloud
for size .</p>
</dd>
</dl>
</div></blockquote>
</li>
</ul>
</div></blockquote>
<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 internal" href="plotly.graph_objects.treemap.pathbar.html#plotly.graph_objects.treemap.pathbar.Textfont" title="plotly.graph_objects.treemap.pathbar.Textfont">plotly.graph_objects.treemap.pathbar.Textfont</a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="plotly.graph_objects.treemap.Pathbar.thickness">
<em class="property">property </em><code class="sig-name descname">thickness</code><a class="headerlink" href="#plotly.graph_objects.treemap.Pathbar.thickness" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the thickness of <code class="docutils literal notranslate"><span class="pre">pathbar</span></code> (in px). If not specified the
<code class="docutils literal notranslate"><span class="pre">pathbar.textfont.size</span></code> is used with 3 pixles extra padding on
each side.</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 [12, 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="method">
<dt id="plotly.graph_objects.treemap.Pathbar.visible">
<em class="property">property </em><code class="sig-name descname">visible</code><a class="headerlink" href="#plotly.graph_objects.treemap.Pathbar.visible" title="Permalink to this definition">¶</a></dt>
<dd><p>Determines if the path bar is drawn i.e. outside the trace
<code class="docutils literal notranslate"><span class="pre">domain</span></code> and with one pixel gap.</p>
<p>The ‘visible’ property must be specified as a bool
(either True, or False)</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/functions.html#bool" title="(in Python v3.8)">bool</a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="plotly.graph_objects.treemap.Outsidetextfont">
<em class="property">class </em><code class="sig-prename descclassname">plotly.graph_objects.treemap.</code><code class="sig-name descname">Outsidetextfont</code><span class="sig-paren">(</span><em class="sig-param">arg=None</em>, <em class="sig-param">color=None</em>, <em class="sig-param">colorsrc=None</em>, <em class="sig-param">family=None</em>, <em class="sig-param">familysrc=None</em>, <em class="sig-param">size=None</em>, <em class="sig-param">sizesrc=None</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#plotly.graph_objects.treemap.Outsidetextfont" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="plotly.graph_objects.treemap.Outsidetextfont.color">
<em class="property">property </em><code class="sig-name descname">color</code><a class="headerlink" href="#plotly.graph_objects.treemap.Outsidetextfont.color" title="Permalink to this definition">¶</a></dt>
<dd><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><dl class="simple">
<dt>A named CSS color:</dt><dd><p>aliceblue, antiquewhite, aqua, aquamarine, azure,
beige, bisque, black, blanchedalmond, blue,
blueviolet, brown, burlywood, cadetblue,
chartreuse, chocolate, coral, cornflowerblue,
cornsilk, crimson, cyan, darkblue, darkcyan,
darkgoldenrod, darkgray, darkgrey, darkgreen,
darkkhaki, darkmagenta, darkolivegreen, darkorange,
darkorchid, darkred, darksalmon, darkseagreen,
darkslateblue, darkslategray, darkslategrey,
darkturquoise, darkviolet, deeppink, deepskyblue,
dimgray, dimgrey, dodgerblue, firebrick,
floralwhite, forestgreen, fuchsia, gainsboro,
ghostwhite, gold, goldenrod, gray, grey, green,
greenyellow, honeydew, hotpink, indianred, indigo,
ivory, khaki, lavender, lavenderblush, lawngreen,
lemonchiffon, lightblue, lightcoral, lightcyan,
lightgoldenrodyellow, lightgray, lightgrey,
lightgreen, lightpink, lightsalmon, lightseagreen,
lightskyblue, lightslategray, lightslategrey,
lightsteelblue, lightyellow, lime, limegreen,
linen, magenta, maroon, mediumaquamarine,
mediumblue, mediumorchid, mediumpurple,
mediumseagreen, mediumslateblue, mediumspringgreen,
mediumturquoise, mediumvioletred, midnightblue,
mintcream, mistyrose, moccasin, navajowhite, navy,
oldlace, olive, olivedrab, orange, orangered,
orchid, palegoldenrod, palegreen, paleturquoise,
palevioletred, papayawhip, peachpuff, peru, pink,
plum, powderblue, purple, red, rosybrown,
royalblue, rebeccapurple, saddlebrown, salmon,
sandybrown, seagreen, seashell, sienna, silver,
skyblue, slateblue, slategray, slategrey, snow,
springgreen, steelblue, tan, teal, thistle, tomato,
turquoise, violet, wheat, white, whitesmoke,
yellow, yellowgreen</p>
</dd>
</dl>
</li>
<li><p>A list or array of any of the above</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>str|numpy.ndarray</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="plotly.graph_objects.treemap.Outsidetextfont.colorsrc">
<em class="property">property </em><code class="sig-name descname">colorsrc</code><a class="headerlink" href="#plotly.graph_objects.treemap.Outsidetextfont.colorsrc" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the source reference on Chart Studio Cloud for color .</p>
<p>The ‘colorsrc’ 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.8)">str</a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="plotly.graph_objects.treemap.Outsidetextfont.family">
<em class="property">property </em><code class="sig-name descname">family</code><a class="headerlink" href="#plotly.graph_objects.treemap.Outsidetextfont.family" title="Permalink to this definition">¶</a></dt>
<dd><p>HTML font family - the typeface that will be applied by the web
browser. The web browser will only be able to apply a font if
it is available on the system which it operates. Provide
multiple font families, separated by commas, to indicate the
preference in which to apply fonts if they aren’t available on
the system. The Chart Studio Cloud (at <a class="reference external" href="https://chart">https://chart</a>-
studio.plotly.com or on-premise) generates images on a server,
where only a select number of fonts are installed and
supported. These include “Arial”, “Balto”, “Courier New”,
“Droid Sans”,, “Droid Serif”, “Droid Sans Mono”, “Gravitas
One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans
Narrow”, “Raleway”, “Times New Roman”.</p>
<dl class="simple">
<dt>The ‘family’ property is a string and must be specified as:</dt><dd><ul class="simple">
<li><p>A non-empty string</p></li>
<li><p>A tuple, list, or one-dimensional numpy array of the above</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>str|numpy.ndarray</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="plotly.graph_objects.treemap.Outsidetextfont.familysrc">
<em class="property">property </em><code class="sig-name descname">familysrc</code><a class="headerlink" href="#plotly.graph_objects.treemap.Outsidetextfont.familysrc" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the source reference on Chart Studio Cloud for family .</p>
<p>The ‘familysrc’ 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.8)">str</a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="plotly.graph_objects.treemap.Outsidetextfont.size">
<em class="property">property </em><code class="sig-name descname">size</code><a class="headerlink" href="#plotly.graph_objects.treemap.Outsidetextfont.size" title="Permalink to this definition">¶</a></dt>
<dd><dl class="simple">
<dt>The ‘size’ property is a number and may be specified as:</dt><dd><ul class="simple">
<li><p>An int or float in the interval [1, inf]</p></li>
<li><p>A tuple, list, or one-dimensional numpy array of the above</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|numpy.ndarray</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="plotly.graph_objects.treemap.Outsidetextfont.sizesrc">
<em class="property">property </em><code class="sig-name descname">sizesrc</code><a class="headerlink" href="#plotly.graph_objects.treemap.Outsidetextfont.sizesrc" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the source reference on Chart Studio Cloud for size .</p>
<p>The ‘sizesrc’ 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.8)">str</a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="plotly.graph_objects.treemap.Marker">
<em class="property">class </em><code class="sig-prename descclassname">plotly.graph_objects.treemap.</code><code class="sig-name descname">Marker</code><span class="sig-paren">(</span><em class="sig-param">arg=None</em>, <em class="sig-param">autocolorscale=None</em>, <em class="sig-param">cauto=None</em>, <em class="sig-param">cmax=None</em>, <em class="sig-param">cmid=None</em>, <em class="sig-param">cmin=None</em>, <em class="sig-param">coloraxis=None</em>, <em class="sig-param">colorbar=None</em>, <em class="sig-param">colors=None</em>, <em class="sig-param">colorscale=None</em>, <em class="sig-param">colorssrc=None</em>, <em class="sig-param">depthfade=None</em>, <em class="sig-param">line=None</em>, <em class="sig-param">pad=None</em>, <em class="sig-param">reversescale=None</em>, <em class="sig-param">showscale=None</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#plotly.graph_objects.treemap.Marker" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="plotly.graph_objects.treemap.Marker.autocolorscale">
<em class="property">property </em><code class="sig-name descname">autocolorscale</code><a class="headerlink" href="#plotly.graph_objects.treemap.Marker.autocolorscale" title="Permalink to this definition">¶</a></dt>
<dd><p>Determines whether the colorscale is a default palette
(<code class="docutils literal notranslate"><span class="pre">autocolorscale:</span> <span class="pre">true</span></code>) or the palette determined by
<code class="docutils literal notranslate"><span class="pre">marker.colorscale</span></code>. Has an effect only if colorsis set to a
numerical array. In case <code class="docutils literal notranslate"><span class="pre">colorscale</span></code> is unspecified or
<code class="docutils literal notranslate"><span class="pre">autocolorscale</span></code> is true, the default palette will be chosen
according to whether numbers in the <code class="docutils literal notranslate"><span class="pre">color</span></code> array are all
positive, all negative or mixed.</p>
<p>The ‘autocolorscale’ property must be specified as a bool
(either True, or False)</p>