-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathplotly.graph_objects.Histogram2d.html
More file actions
417 lines (385 loc) · 36.8 KB
/
plotly.graph_objects.Histogram2d.html
File metadata and controls
417 lines (385 loc) · 36.8 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
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>plotly.graph_objects.Histogram2d — 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.Histogram2dContour" href="plotly.graph_objects.Histogram2dContour.html" />
<link rel="prev" title="plotly.graph_objects.Histogram" href="plotly.graph_objects.Histogram.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>.Histogram2d</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>.histogram2d</a></li>
</ul>
</ul>
</li>
<li>
<a href="plotly.graph_objects.Histogram.html" title="Previous Chapter: plotly.graph_objects.Histogram"><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.Histogram2dContour.html" title="Next Chapter: plotly.graph_objects.Histogram2dContour"><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-histogram2d">
<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>.Histogram2d<a class="headerlink" href="#plotly-graph-objs-histogram2d" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="plotly.graph_objects.Histogram2d">
<em class="property">class </em><code class="sig-prename descclassname">plotly.graph_objects.</code><code class="sig-name descname">Histogram2d</code><span class="sig-paren">(</span><em class="sig-param">arg=None</em>, <em class="sig-param">autobinx=None</em>, <em class="sig-param">autobiny=None</em>, <em class="sig-param">autocolorscale=None</em>, <em class="sig-param">bingroup=None</em>, <em class="sig-param">coloraxis=None</em>, <em class="sig-param">colorbar=None</em>, <em class="sig-param">colorscale=None</em>, <em class="sig-param">customdata=None</em>, <em class="sig-param">customdatasrc=None</em>, <em class="sig-param">histfunc=None</em>, <em class="sig-param">histnorm=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">ids=None</em>, <em class="sig-param">idssrc=None</em>, <em class="sig-param">legendgroup=None</em>, <em class="sig-param">marker=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">nbinsx=None</em>, <em class="sig-param">nbinsy=None</em>, <em class="sig-param">opacity=None</em>, <em class="sig-param">reversescale=None</em>, <em class="sig-param">showlegend=None</em>, <em class="sig-param">showscale=None</em>, <em class="sig-param">stream=None</em>, <em class="sig-param">uid=None</em>, <em class="sig-param">uirevision=None</em>, <em class="sig-param">visible=None</em>, <em class="sig-param">x=None</em>, <em class="sig-param">xaxis=None</em>, <em class="sig-param">xbingroup=None</em>, <em class="sig-param">xbins=None</em>, <em class="sig-param">xcalendar=None</em>, <em class="sig-param">xgap=None</em>, <em class="sig-param">xsrc=None</em>, <em class="sig-param">y=None</em>, <em class="sig-param">yaxis=None</em>, <em class="sig-param">ybingroup=None</em>, <em class="sig-param">ybins=None</em>, <em class="sig-param">ycalendar=None</em>, <em class="sig-param">ygap=None</em>, <em class="sig-param">ysrc=None</em>, <em class="sig-param">z=None</em>, <em class="sig-param">zauto=None</em>, <em class="sig-param">zhoverformat=None</em>, <em class="sig-param">zmax=None</em>, <em class="sig-param">zmid=None</em>, <em class="sig-param">zmin=None</em>, <em class="sig-param">zsmooth=None</em>, <em class="sig-param">zsrc=None</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#plotly.graph_objects.Histogram2d" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="plotly.graph_objects.Histogram2d.__init__">
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param">arg=None</em>, <em class="sig-param">autobinx=None</em>, <em class="sig-param">autobiny=None</em>, <em class="sig-param">autocolorscale=None</em>, <em class="sig-param">bingroup=None</em>, <em class="sig-param">coloraxis=None</em>, <em class="sig-param">colorbar=None</em>, <em class="sig-param">colorscale=None</em>, <em class="sig-param">customdata=None</em>, <em class="sig-param">customdatasrc=None</em>, <em class="sig-param">histfunc=None</em>, <em class="sig-param">histnorm=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">ids=None</em>, <em class="sig-param">idssrc=None</em>, <em class="sig-param">legendgroup=None</em>, <em class="sig-param">marker=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">nbinsx=None</em>, <em class="sig-param">nbinsy=None</em>, <em class="sig-param">opacity=None</em>, <em class="sig-param">reversescale=None</em>, <em class="sig-param">showlegend=None</em>, <em class="sig-param">showscale=None</em>, <em class="sig-param">stream=None</em>, <em class="sig-param">uid=None</em>, <em class="sig-param">uirevision=None</em>, <em class="sig-param">visible=None</em>, <em class="sig-param">x=None</em>, <em class="sig-param">xaxis=None</em>, <em class="sig-param">xbingroup=None</em>, <em class="sig-param">xbins=None</em>, <em class="sig-param">xcalendar=None</em>, <em class="sig-param">xgap=None</em>, <em class="sig-param">xsrc=None</em>, <em class="sig-param">y=None</em>, <em class="sig-param">yaxis=None</em>, <em class="sig-param">ybingroup=None</em>, <em class="sig-param">ybins=None</em>, <em class="sig-param">ycalendar=None</em>, <em class="sig-param">ygap=None</em>, <em class="sig-param">ysrc=None</em>, <em class="sig-param">z=None</em>, <em class="sig-param">zauto=None</em>, <em class="sig-param">zhoverformat=None</em>, <em class="sig-param">zmax=None</em>, <em class="sig-param">zmid=None</em>, <em class="sig-param">zmin=None</em>, <em class="sig-param">zsmooth=None</em>, <em class="sig-param">zsrc=None</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#plotly.graph_objects.Histogram2d.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Construct a new Histogram2d object</p>
<p>The sample data from which statistics are computed is set in
<code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">y</span></code> (where <code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">y</span></code> represent marginal
distributions, binning is set in <code class="docutils literal notranslate"><span class="pre">xbins</span></code> and <code class="docutils literal notranslate"><span class="pre">ybins</span></code> in this
case) or <code class="docutils literal notranslate"><span class="pre">z</span></code> (where <code class="docutils literal notranslate"><span class="pre">z</span></code> represent the 2D distribution and
binning set, binning is set by <code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">y</span></code> in this case). The
resulting distribution is visualized as a heatmap.</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.Histogram2d" title="plotly.graph_objects.Histogram2d"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.Histogram2d</span></code></a></p></li>
<li><p><strong>autobinx</strong> – Obsolete: since v1.42 each bin attribute is auto-
determined separately and <code class="docutils literal notranslate"><span class="pre">autobinx</span></code> is not needed.
However, we accept <code class="docutils literal notranslate"><span class="pre">autobinx:</span> <span class="pre">true</span></code> or <code class="docutils literal notranslate"><span class="pre">false</span></code> and will
update <code class="docutils literal notranslate"><span class="pre">xbins</span></code> accordingly before deleting <code class="docutils literal notranslate"><span class="pre">autobinx</span></code>
from the trace.</p></li>
<li><p><strong>autobiny</strong> – Obsolete: since v1.42 each bin attribute is auto-
determined separately and <code class="docutils literal notranslate"><span class="pre">autobiny</span></code> is not needed.
However, we accept <code class="docutils literal notranslate"><span class="pre">autobiny:</span> <span class="pre">true</span></code> or <code class="docutils literal notranslate"><span class="pre">false</span></code> and will
update <code class="docutils literal notranslate"><span class="pre">ybins</span></code> accordingly before deleting <code class="docutils literal notranslate"><span class="pre">autobiny</span></code>
from the trace.</p></li>
<li><p><strong>autocolorscale</strong> – 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">colorscale</span></code>. 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></li>
<li><p><strong>bingroup</strong> – Set the <code class="docutils literal notranslate"><span class="pre">xbingroup</span></code> and <code class="docutils literal notranslate"><span class="pre">ybingroup</span></code> default prefix For
example, setting a <code class="docutils literal notranslate"><span class="pre">bingroup</span></code> of 1 on two histogram2d
traces will make them their x-bins and y-bins match
separately.</p></li>
<li><p><strong>coloraxis</strong> – Sets a reference to a shared color axis. References to
these shared color axes are “coloraxis”, “coloraxis2”,
“coloraxis3”, etc. Settings for these shared color axes
are set in the layout, under <code class="docutils literal notranslate"><span class="pre">layout.coloraxis</span></code>,
<code class="docutils literal notranslate"><span class="pre">layout.coloraxis2</span></code>, etc. Note that multiple color
scales can be linked to the same color axis.</p></li>
<li><p><strong>colorbar</strong> – <a class="reference internal" href="plotly.graph_objects.histogram2d.html#plotly.graph_objects.histogram2d.ColorBar" title="plotly.graph_objects.histogram2d.ColorBar"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.histogram2d.ColorBar</span></code></a>
instance or dict with compatible properties</p></li>
<li><p><strong>colorscale</strong> – Sets the colorscale. The colorscale must be an array
containing arrays mapping a normalized value to an rgb,
rgba, hex, hsl, hsv, or named color string. At minimum,
a mapping for the lowest (0) and highest (1) values are
required. For example, <code class="docutils literal notranslate"><span class="pre">[[0,</span> <span class="pre">'rgb(0,0,255)'],</span> <span class="pre">[1,</span>
<span class="pre">'rgb(255,0,0)']]</span></code>. To control the bounds of the
colorscale in color space, use`zmin` and <code class="docutils literal notranslate"><span class="pre">zmax</span></code>.
Alternatively, <code class="docutils literal notranslate"><span class="pre">colorscale</span></code> may be a palette name
string of the following list: Greys,YlGnBu,Greens,YlOrR
d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H
ot,Blackbody,Earth,Electric,Viridis,Cividis.</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>histfunc</strong> – Specifies the binning function used for this histogram
trace. If “count”, the histogram values are computed by
counting the number of values lying inside each bin. If
“sum”, “avg”, “min”, “max”, the histogram values are
computed using the sum, the average, the minimum or the
maximum of the values lying inside each bin
respectively.</p></li>
<li><p><strong>histnorm</strong> – Specifies the type of normalization used for this
histogram trace. If “”, the span of each bar
corresponds to the number of occurrences (i.e. the
number of data points lying inside the bins). If
“percent” / “probability”, the span of each bar
corresponds to the percentage / fraction of occurrences
with respect to the total number of sample points
(here, the sum of all bin HEIGHTS equals 100% / 1). If
“density”, the span of each bar corresponds to the
number of occurrences in a bin divided by the size of
the bin interval (here, the sum of all bin AREAS equals
the total number of sample points). If <em>probability
density</em>, the area of each bar corresponds to the
probability that an event will fall into the
corresponding bin (here, the sum of all bin AREAS
equals 1).</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.histogram2d.html#plotly.graph_objects.histogram2d.Hoverlabel" title="plotly.graph_objects.histogram2d.Hoverlabel"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.histogram2d.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. variable <code class="docutils literal notranslate"><span class="pre">z</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>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>legendgroup</strong> – Sets the legend group for this trace. Traces part of
the same legend group hide/show at the same time when
toggling legend items.</p></li>
<li><p><strong>marker</strong> – <a class="reference internal" href="plotly.graph_objects.histogram2d.html#plotly.graph_objects.histogram2d.Marker" title="plotly.graph_objects.histogram2d.Marker"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.histogram2d.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
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>nbinsx</strong> – Specifies the maximum number of desired bins. This
value will be used in an algorithm that will decide the
optimal bin size such that the histogram best
visualizes the distribution of the data. Ignored if
<code class="docutils literal notranslate"><span class="pre">xbins.size</span></code> is provided.</p></li>
<li><p><strong>nbinsy</strong> – Specifies the maximum number of desired bins. This
value will be used in an algorithm that will decide the
optimal bin size such that the histogram best
visualizes the distribution of the data. Ignored if
<code class="docutils literal notranslate"><span class="pre">ybins.size</span></code> is provided.</p></li>
<li><p><strong>opacity</strong> – Sets the opacity of the trace.</p></li>
<li><p><strong>reversescale</strong> – Reverses the color mapping if true. If true, <code class="docutils literal notranslate"><span class="pre">zmin</span></code>
will correspond to the last color in the array and
<code class="docutils literal notranslate"><span class="pre">zmax</span></code> will correspond to the first color.</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>showscale</strong> – Determines whether or not a colorbar is displayed for
this trace.</p></li>
<li><p><strong>stream</strong> – <a class="reference internal" href="plotly.graph_objects.histogram2d.html#plotly.graph_objects.histogram2d.Stream" title="plotly.graph_objects.histogram2d.Stream"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.histogram2d.Stream</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>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>x</strong> – Sets the sample data to be binned on the x axis.</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>xbingroup</strong> – Set a group of histogram traces which will have
compatible x-bin settings. Using <code class="docutils literal notranslate"><span class="pre">xbingroup</span></code>,
histogram2d and histogram2dcontour traces (on axes of
the same axis type) can have compatible x-bin settings.
Note that the same <code class="docutils literal notranslate"><span class="pre">xbingroup</span></code> value can be used to set
(1D) histogram <code class="docutils literal notranslate"><span class="pre">bingroup</span></code></p></li>
<li><p><strong>xbins</strong> – <a class="reference internal" href="plotly.graph_objects.histogram2d.html#plotly.graph_objects.histogram2d.XBins" title="plotly.graph_objects.histogram2d.XBins"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.histogram2d.XBins</span></code></a>
instance or dict with compatible properties</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>xgap</strong> – Sets the horizontal gap (in pixels) between bricks.</p></li>
<li><p><strong>xsrc</strong> – Sets the source reference on Chart Studio Cloud for x
.</p></li>
<li><p><strong>y</strong> – Sets the sample data to be binned on the y axis.</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>ybingroup</strong> – Set a group of histogram traces which will have
compatible y-bin settings. Using <code class="docutils literal notranslate"><span class="pre">ybingroup</span></code>,
histogram2d and histogram2dcontour traces (on axes of
the same axis type) can have compatible y-bin settings.
Note that the same <code class="docutils literal notranslate"><span class="pre">ybingroup</span></code> value can be used to set
(1D) histogram <code class="docutils literal notranslate"><span class="pre">bingroup</span></code></p></li>
<li><p><strong>ybins</strong> – <a class="reference internal" href="plotly.graph_objects.histogram2d.html#plotly.graph_objects.histogram2d.YBins" title="plotly.graph_objects.histogram2d.YBins"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.histogram2d.YBins</span></code></a>
instance or dict with compatible properties</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>ygap</strong> – Sets the vertical gap (in pixels) between bricks.</p></li>
<li><p><strong>ysrc</strong> – Sets the source reference on Chart Studio Cloud for y
.</p></li>
<li><p><strong>z</strong> – Sets the aggregation data.</p></li>
<li><p><strong>zauto</strong> – Determines whether or not the color domain is computed
with respect to the input data (here in <code class="docutils literal notranslate"><span class="pre">z</span></code>) or the
bounds set in <code class="docutils literal notranslate"><span class="pre">zmin</span></code> and <code class="docutils literal notranslate"><span class="pre">zmax</span></code> Defaults to <code class="docutils literal notranslate"><span class="pre">false</span></code>
when <code class="docutils literal notranslate"><span class="pre">zmin</span></code> and <code class="docutils literal notranslate"><span class="pre">zmax</span></code> are set by the user.</p></li>
<li><p><strong>zhoverformat</strong> – Sets the hover text formatting rule using d3 formatting
mini-languages which are very similar to those in
Python. See: <a class="reference external" href="https://github.com/d3/d3-3.x-api">https://github.com/d3/d3-3.x-api</a>-
reference/blob/master/Formatting.md#d3_format</p></li>
<li><p><strong>zmax</strong> – Sets the upper bound of the color domain. Value should
have the same units as in <code class="docutils literal notranslate"><span class="pre">z</span></code> and if set, <code class="docutils literal notranslate"><span class="pre">zmin</span></code> must
be set as well.</p></li>
<li><p><strong>zmid</strong> – Sets the mid-point of the color domain by scaling
<code class="docutils literal notranslate"><span class="pre">zmin</span></code> and/or <code class="docutils literal notranslate"><span class="pre">zmax</span></code> to be equidistant to this point.
Value should have the same units as in <code class="docutils literal notranslate"><span class="pre">z</span></code>. Has no
effect when <code class="docutils literal notranslate"><span class="pre">zauto</span></code> is <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p></li>
<li><p><strong>zmin</strong> – Sets the lower bound of the color domain. Value should
have the same units as in <code class="docutils literal notranslate"><span class="pre">z</span></code> and if set, <code class="docutils literal notranslate"><span class="pre">zmax</span></code> must
be set as well.</p></li>
<li><p><strong>zsmooth</strong> – Picks a smoothing algorithm use to smooth <code class="docutils literal notranslate"><span class="pre">z</span></code> data.</p></li>
<li><p><strong>zsrc</strong> – Sets the source reference on Chart Studio Cloud for z
.</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.Histogram2d" title="plotly.graph_objects.Histogram2d">Histogram2d</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>.histogram2d<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.histogram2d" title="plotly.graph_objects.histogram2d"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plotly.graph_objects.histogram2d</span></code></a></p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
<span class="target" id="module-plotly.graph_objects.histogram2d"></span><div class="clearer"></div></div>
</div>
</div>
</div>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-39373211-1']);
_gaq.push(['_setDomainName', 'none']);
_gaq.push(['_setAllowLinker', true]);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</body>
</html>