forked from plotly/plotly.py
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_histogram2dcontour.py
295 lines (292 loc) · 14.1 KB
/
_histogram2dcontour.py
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
import _plotly_utils.basevalidators
class Histogram2dContourValidator(
_plotly_utils.basevalidators.CompoundValidator
):
def __init__(
self, plotly_name='histogram2dcontour', parent_name='', **kwargs
):
super(Histogram2dContourValidator, self).__init__(
plotly_name=plotly_name,
parent_name=parent_name,
data_class_str=kwargs.pop('data_class_str', 'Histogram2dContour'),
data_docs=kwargs.pop(
'data_docs', """
autobinx
Obsolete: since v1.42 each bin attribute is
auto-determined separately and `autobinx` is
not needed. However, we accept `autobinx: true`
or `false` and will update `xbins` accordingly
before deleting `autobinx` from the trace.
autobiny
Obsolete: since v1.42 each bin attribute is
auto-determined separately and `autobiny` is
not needed. However, we accept `autobiny: true`
or `false` and will update `ybins` accordingly
before deleting `autobiny` from the trace.
autocolorscale
Determines whether the colorscale is a default
palette (`autocolorscale: true`) or the palette
determined by `colorscale`. In case
`colorscale` is unspecified or `autocolorscale`
is true, the default palette will be chosen
according to whether numbers in the `color`
array are all positive, all negative or mixed.
autocontour
Determines whether or not the contour level
attributes are picked by an algorithm. If True,
the number of contour levels can be set in
`ncontours`. If False, set the contour level
attributes in `contours`.
colorbar
plotly.graph_objs.histogram2dcontour.ColorBar
instance or dict with compatible properties
colorscale
Sets the colorscale. The colorscale must be an
array containing arrays mapping a normalized
value to an rgb, rgba, hex, hsl, hsv, or named
color string. At minimum, a mapping for the
lowest (0) and highest (1) values are required.
For example, `[[0, 'rgb(0,0,255)', [1,
'rgb(255,0,0)']]`. To control the bounds of the
colorscale in color space, use`zmin` and
`zmax`. Alternatively, `colorscale` may be a
palette name string of the following list: Grey
s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,
Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth
,Electric,Viridis,Cividis.
contours
plotly.graph_objs.histogram2dcontour.Contours
instance or dict with compatible properties
customdata
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
customdatasrc
Sets the source reference on plot.ly for
customdata .
histfunc
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.
histnorm
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 *probability density*, 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).
hoverinfo
Determines which trace information appear on
hover. If `none` or `skip` are set, no
information is displayed upon hovering. But, if
`none` is set, click and hover events are still
fired.
hoverinfosrc
Sets the source reference on plot.ly for
hoverinfo .
hoverlabel
plotly.graph_objs.histogram2dcontour.Hoverlabel
instance or dict with compatible properties
hovertemplate
Template string used for rendering the
information that appear on hover box. Note that
this will override `hoverinfo`. 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}". See https://github.com/d3/d
3-format/blob/master/README.md#locale_format
for details on the formatting syntax. The
variables available in `hovertemplate` are the
ones emitted as event data described at this
link https://plot.ly/javascript/plotlyjs-
events/#event-data. Additionally, every
attributes that can be specified per-point (the
ones that are `arrayOk: true`) are available.
variable `z` Anything contained in tag
`<extra>` is displayed in the secondary box,
for example "<extra>{fullData.name}</extra>".
hovertemplatesrc
Sets the source reference on plot.ly for
hovertemplate .
ids
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.
idssrc
Sets the source reference on plot.ly for ids .
legendgroup
Sets the legend group for this trace. Traces
part of the same legend group hide/show at the
same time when toggling legend items.
line
plotly.graph_objs.histogram2dcontour.Line
instance or dict with compatible properties
marker
plotly.graph_objs.histogram2dcontour.Marker
instance or dict with compatible properties
name
Sets the trace name. The trace name appear as
the legend item and on hover.
nbinsx
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 `xbins.size` is provided.
nbinsy
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 `ybins.size` is provided.
ncontours
Sets the maximum number of contour levels. The
actual number of contours will be chosen
automatically to be less than or equal to the
value of `ncontours`. Has an effect only if
`autocontour` is True or if `contours.size` is
missing.
opacity
Sets the opacity of the trace.
reversescale
Reverses the color mapping if true. If true,
`zmin` will correspond to the last color in the
array and `zmax` will correspond to the first
color.
selectedpoints
Array containing integer indices of selected
points. Has an effect only for traces that
support selections. Note that an empty array
means an empty selection where the `unselected`
are turned on for all points, whereas, any
other non-array values means no selection all
where the `selected` and `unselected` styles
have no effect.
showlegend
Determines whether or not an item corresponding
to this trace is shown in the legend.
showscale
Determines whether or not a colorbar is
displayed for this trace.
stream
plotly.graph_objs.histogram2dcontour.Stream
instance or dict with compatible properties
uid
Assign an id to this trace, Use this to provide
object constancy between traces during
animations and transitions.
uirevision
Controls persistence of some user-driven
changes to the trace: `constraintrange` in
`parcoords` traces, as well as some `editable:
true` modifications such as `name` and
`colorbar.title`. Defaults to
`layout.uirevision`. Note that other user-
driven trace attribute changes are controlled
by `layout` attributes: `trace.visible` is
controlled by `layout.legend.uirevision`,
`selectedpoints` is controlled by
`layout.selectionrevision`, and
`colorbar.(x|y)` (accessible with `config:
{editable: true}`) is controlled by
`layout.editrevision`. Trace changes are
tracked by `uid`, which only falls back on
trace index if no `uid` is provided. So if your
app can add/remove traces before the end of the
`data` array, such that the same trace has a
different index, you can still preserve user-
driven changes if you give each trace a `uid`
that stays with it as it moves.
visible
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).
x
Sets the sample data to be binned on the x
axis.
xaxis
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
`layout.xaxis`. If "x2", the x coordinates
refer to `layout.xaxis2`, and so on.
xbins
plotly.graph_objs.histogram2dcontour.XBins
instance or dict with compatible properties
xcalendar
Sets the calendar system to use with `x` date
data.
xsrc
Sets the source reference on plot.ly for x .
y
Sets the sample data to be binned on the y
axis.
yaxis
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
`layout.yaxis`. If "y2", the y coordinates
refer to `layout.yaxis2`, and so on.
ybins
plotly.graph_objs.histogram2dcontour.YBins
instance or dict with compatible properties
ycalendar
Sets the calendar system to use with `y` date
data.
ysrc
Sets the source reference on plot.ly for y .
z
Sets the aggregation data.
zauto
Determines whether or not the color domain is
computed with respect to the input data (here
in `z`) or the bounds set in `zmin` and `zmax`
Defaults to `false` when `zmin` and `zmax` are
set by the user.
zhoverformat
Sets the hover text formatting rule using d3
formatting mini-languages which are very
similar to those in Python. See: https://github
.com/d3/d3-format/blob/master/README.md#locale_
format
zmax
Sets the upper bound of the color domain. Value
should have the same units as in `z` and if
set, `zmin` must be set as well.
zmid
Sets the mid-point of the color domain by
scaling `zmin` and/or `zmax` to be equidistant
to this point. Value should have the same units
as in `z`. Has no effect when `zauto` is
`false`.
zmin
Sets the lower bound of the color domain. Value
should have the same units as in `z` and if
set, `zmax` must be set as well.
zsrc
Sets the source reference on plot.ly for z .
"""
),
**kwargs
)