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
|
# --- THIS FILE IS AUTO-GENERATED ---
# Modifications will be overwitten the next time code generation run.
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
import copy as _copy
class Cells(_BaseTraceHierarchyType):
_parent_path_str = "table"
_path_str = "table.cells"
_valid_props = {
"align",
"alignsrc",
"fill",
"font",
"format",
"formatsrc",
"height",
"line",
"prefix",
"prefixsrc",
"suffix",
"suffixsrc",
"values",
"valuessrc",
}
@property
def align(self):
"""
Sets the horizontal alignment of the `text` within the box. Has
an effect only if `text` spans two or more lines (i.e. `text`
contains one or more <br> HTML tags) or if an explicit width is
set to override the text width.
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
- A tuple, list, or one-dimensional numpy array of the above
Returns
-------
Any|numpy.ndarray
"""
return self["align"]
@align.setter
def align(self, val):
self["align"] = val
@property
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for `align`.
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["alignsrc"]
@alignsrc.setter
def alignsrc(self, val):
self["alignsrc"] = val
@property
def fill(self):
"""
The 'fill' property is an instance of Fill
that may be specified as:
- An instance of :class:`plotly.graph_objs.table.cells.Fill`
- A dict of string/value properties that will be passed
to the Fill constructor
Returns
-------
plotly.graph_objs.table.cells.Fill
"""
return self["fill"]
@fill.setter
def fill(self, val):
self["fill"] = val
@property
def font(self):
"""
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.table.cells.Font`
- A dict of string/value properties that will be passed
to the Font constructor
Returns
-------
plotly.graph_objs.table.cells.Font
"""
return self["font"]
@font.setter
def font(self, val):
self["font"] = val
@property
def format(self):
"""
Sets the cell value formatting rule using d3 formatting mini-
languages which are very similar to those in Python. For
numbers, see:
https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
The 'format' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
Returns
-------
numpy.ndarray
"""
return self["format"]
@format.setter
def format(self, val):
self["format"] = val
@property
def formatsrc(self):
"""
Sets the source reference on Chart Studio Cloud for `format`.
The 'formatsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["formatsrc"]
@formatsrc.setter
def formatsrc(self, val):
self["formatsrc"] = val
@property
def height(self):
"""
The height of cells.
The 'height' property is a number and may be specified as:
- An int or float
Returns
-------
int|float
"""
return self["height"]
@height.setter
def height(self, val):
self["height"] = val
@property
def line(self):
"""
The 'line' property is an instance of Line
that may be specified as:
- An instance of :class:`plotly.graph_objs.table.cells.Line`
- A dict of string/value properties that will be passed
to the Line constructor
Returns
-------
plotly.graph_objs.table.cells.Line
"""
return self["line"]
@line.setter
def line(self, val):
self["line"] = val
@property
def prefix(self):
"""
Prefix for cell values.
The 'prefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
- A tuple, list, or one-dimensional numpy array of the above
Returns
-------
str|numpy.ndarray
"""
return self["prefix"]
@prefix.setter
def prefix(self, val):
self["prefix"] = val
@property
def prefixsrc(self):
"""
Sets the source reference on Chart Studio Cloud for `prefix`.
The 'prefixsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["prefixsrc"]
@prefixsrc.setter
def prefixsrc(self, val):
self["prefixsrc"] = val
@property
def suffix(self):
"""
Suffix for cell values.
The 'suffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
- A tuple, list, or one-dimensional numpy array of the above
Returns
-------
str|numpy.ndarray
"""
return self["suffix"]
@suffix.setter
def suffix(self, val):
self["suffix"] = val
@property
def suffixsrc(self):
"""
Sets the source reference on Chart Studio Cloud for `suffix`.
The 'suffixsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["suffixsrc"]
@suffixsrc.setter
def suffixsrc(self, val):
self["suffixsrc"] = val
@property
def values(self):
"""
Cell values. `values[m][n]` represents the value of the `n`th
point in column `m`, therefore the `values[m]` vector length
for all columns must be the same (longer vectors will be
truncated). Each value must be a finite number or a string.
The 'values' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
Returns
-------
numpy.ndarray
"""
return self["values"]
@values.setter
def values(self, val):
self["values"] = val
@property
def valuessrc(self):
"""
Sets the source reference on Chart Studio Cloud for `values`.
The 'valuessrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["valuessrc"]
@valuessrc.setter
def valuessrc(self, val):
self["valuessrc"] = val
@property
def _prop_descriptions(self):
return """\
align
Sets the horizontal alignment of the `text` within the
box. Has an effect only if `text` spans two or more
lines (i.e. `text` contains one or more <br> HTML tags)
or if an explicit width is set to override the text
width.
alignsrc
Sets the source reference on Chart Studio Cloud for
`align`.
fill
:class:`plotly.graph_objects.table.cells.Fill` instance
or dict with compatible properties
font
:class:`plotly.graph_objects.table.cells.Font` instance
or dict with compatible properties
format
Sets the cell value formatting rule using d3 formatting
mini-languages which are very similar to those in
Python. For numbers, see:
https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
formatsrc
Sets the source reference on Chart Studio Cloud for
`format`.
height
The height of cells.
line
:class:`plotly.graph_objects.table.cells.Line` instance
or dict with compatible properties
prefix
Prefix for cell values.
prefixsrc
Sets the source reference on Chart Studio Cloud for
`prefix`.
suffix
Suffix for cell values.
suffixsrc
Sets the source reference on Chart Studio Cloud for
`suffix`.
values
Cell values. `values[m][n]` represents the value of the
`n`th point in column `m`, therefore the `values[m]`
vector length for all columns must be the same (longer
vectors will be truncated). Each value must be a finite
number or a string.
valuessrc
Sets the source reference on Chart Studio Cloud for
`values`.
"""
def __init__(
self,
arg=None,
align=None,
alignsrc=None,
fill=None,
font=None,
format=None,
formatsrc=None,
height=None,
line=None,
prefix=None,
prefixsrc=None,
suffix=None,
suffixsrc=None,
values=None,
valuessrc=None,
**kwargs,
):
"""
Construct a new Cells object
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of :class:`plotly.graph_objs.table.Cells`
align
Sets the horizontal alignment of the `text` within the
box. Has an effect only if `text` spans two or more
lines (i.e. `text` contains one or more <br> HTML tags)
or if an explicit width is set to override the text
width.
alignsrc
Sets the source reference on Chart Studio Cloud for
`align`.
fill
:class:`plotly.graph_objects.table.cells.Fill` instance
or dict with compatible properties
font
:class:`plotly.graph_objects.table.cells.Font` instance
or dict with compatible properties
format
Sets the cell value formatting rule using d3 formatting
mini-languages which are very similar to those in
Python. For numbers, see:
https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
formatsrc
Sets the source reference on Chart Studio Cloud for
`format`.
height
The height of cells.
line
:class:`plotly.graph_objects.table.cells.Line` instance
or dict with compatible properties
prefix
Prefix for cell values.
prefixsrc
Sets the source reference on Chart Studio Cloud for
`prefix`.
suffix
Suffix for cell values.
suffixsrc
Sets the source reference on Chart Studio Cloud for
`suffix`.
values
Cell values. `values[m][n]` represents the value of the
`n`th point in column `m`, therefore the `values[m]`
vector length for all columns must be the same (longer
vectors will be truncated). Each value must be a finite
number or a string.
valuessrc
Sets the source reference on Chart Studio Cloud for
`values`.
Returns
-------
Cells
"""
super().__init__("cells")
if "_parent" in kwargs:
self._parent = kwargs["_parent"]
return
if arg is None:
arg = {}
elif isinstance(arg, self.__class__):
arg = arg.to_plotly_json()
elif isinstance(arg, dict):
arg = _copy.copy(arg)
else:
raise ValueError("""\
The first argument to the plotly.graph_objs.table.Cells
constructor must be a dict or
an instance of :class:`plotly.graph_objs.table.Cells`""")
self._skip_invalid = kwargs.pop("skip_invalid", False)
self._validate = kwargs.pop("_validate", True)
self._set_property("align", arg, align)
self._set_property("alignsrc", arg, alignsrc)
self._set_property("fill", arg, fill)
self._set_property("font", arg, font)
self._set_property("format", arg, format)
self._set_property("formatsrc", arg, formatsrc)
self._set_property("height", arg, height)
self._set_property("line", arg, line)
self._set_property("prefix", arg, prefix)
self._set_property("prefixsrc", arg, prefixsrc)
self._set_property("suffix", arg, suffix)
self._set_property("suffixsrc", arg, suffixsrc)
self._set_property("values", arg, values)
self._set_property("valuessrc", arg, valuessrc)
self._process_kwargs(**dict(arg, **kwargs))
self._skip_invalid = False
|
