forked from plotly/plotly.py
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_box.py
231 lines (228 loc) · 10.3 KB
/
_box.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
import _plotly_utils.basevalidators
class BoxValidator(_plotly_utils.basevalidators.CompoundValidator):
def __init__(self, plotly_name='box', parent_name='', **kwargs):
super(BoxValidator, self).__init__(
plotly_name=plotly_name,
parent_name=parent_name,
data_class_str=kwargs.pop('data_class_str', 'Box'),
data_docs=kwargs.pop(
'data_docs', """
alignmentgroup
Set several traces linked to the same position
axis or matching axes to the same
alignmentgroup. This controls whether bars
compute their positional range dependently or
independently.
boxmean
If True, the mean of the box(es)' underlying
distribution is drawn as a dashed line inside
the box(es). If "sd" the standard deviation is
also drawn.
boxpoints
If "outliers", only the sample points lying
outside the whiskers are shown If
"suspectedoutliers", the outlier points are
shown and points either less than 4*Q1-3*Q3 or
greater than 4*Q3-3*Q1 are highlighted (see
`outliercolor`) If "all", all sample points are
shown If False, only the box(es) are shown with
no sample points
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 .
fillcolor
Sets the fill color. Defaults to a half-
transparent variant of the line color, marker
color, or marker line color, whichever is
available.
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.box.Hoverlabel instance or
dict with compatible properties
hoveron
Do the hover effects highlight individual boxes
or sample points or both?
hovertext
Same as `text`.
hovertextsrc
Sets the source reference on plot.ly for
hovertext .
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 .
jitter
Sets the amount of jitter in the sample points
drawn. If 0, the sample points align along the
distribution axis. If 1, the sample points are
drawn in a random jitter of width equal to the
width of the box(es).
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.box.Line instance or dict
with compatible properties
marker
plotly.graph_objs.box.Marker instance or dict
with compatible properties
name
Sets the trace name. The trace name appear as
the legend item and on hover. For box traces,
the name will also be used for the position
coordinate, if `x` and `x0` (`y` and `y0` if
horizontal) are missing and the position axis
is categorical
notched
Determines whether or not notches should be
drawn.
notchwidth
Sets the width of the notches relative to the
box' width. For example, with 0, the notches
are as wide as the box(es).
offsetgroup
Set several traces linked to the same position
axis or matching axes to the same offsetgroup
where bars of the same position coordinate will
line up.
opacity
Sets the opacity of the trace.
orientation
Sets the orientation of the box(es). If "v"
("h"), the distribution is visualized along the
vertical (horizontal).
pointpos
Sets the position of the sample points in
relation to the box(es). If 0, the sample
points are places over the center of the
box(es). Positive (negative) values correspond
to positions to the right (left) for vertical
boxes and above (below) for horizontal boxes
selected
plotly.graph_objs.box.Selected instance or dict
with compatible properties
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.
stream
plotly.graph_objs.box.Stream instance or dict
with compatible properties
text
Sets the text elements associated with each
sample value. If a single string, the same
string appears over all the data points. If an
array of string, the items are mapped in order
to the this trace's (x,y) coordinates. To be
seen, trace `hoverinfo` must contain a "text"
flag.
textsrc
Sets the source reference on plot.ly for text
.
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.
unselected
plotly.graph_objs.box.Unselected instance or
dict with compatible properties
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).
whiskerwidth
Sets the width of the whiskers relative to the
box' width. For example, with 1, the whiskers
are as wide as the box(es).
width
Sets the width of the box in data coordinate If
0 (default value) the width is automatically
selected based on the positions of other box
traces in the same subplot.
x
Sets the x sample data or coordinates. See
overview for more info.
x0
Sets the x coordinate of the box. See overview
for more info.
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.
xcalendar
Sets the calendar system to use with `x` date
data.
xsrc
Sets the source reference on plot.ly for x .
y
Sets the y sample data or coordinates. See
overview for more info.
y0
Sets the y coordinate of the box. See overview
for more info.
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.
ycalendar
Sets the calendar system to use with `y` date
data.
ysrc
Sets the source reference on plot.ly for y .
"""
),
**kwargs
)