1232 lines
41 KiB
Python
1232 lines
41 KiB
Python
|
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
|
||
|
import copy as _copy
|
||
|
|
||
|
|
||
|
class Table(_BaseTraceType):
|
||
|
|
||
|
# class properties
|
||
|
# --------------------
|
||
|
_parent_path_str = ""
|
||
|
_path_str = "table"
|
||
|
_valid_props = {
|
||
|
"cells",
|
||
|
"columnorder",
|
||
|
"columnordersrc",
|
||
|
"columnwidth",
|
||
|
"columnwidthsrc",
|
||
|
"customdata",
|
||
|
"customdatasrc",
|
||
|
"domain",
|
||
|
"header",
|
||
|
"hoverinfo",
|
||
|
"hoverinfosrc",
|
||
|
"hoverlabel",
|
||
|
"ids",
|
||
|
"idssrc",
|
||
|
"legend",
|
||
|
"legendgrouptitle",
|
||
|
"legendrank",
|
||
|
"legendwidth",
|
||
|
"meta",
|
||
|
"metasrc",
|
||
|
"name",
|
||
|
"stream",
|
||
|
"type",
|
||
|
"uid",
|
||
|
"uirevision",
|
||
|
"visible",
|
||
|
}
|
||
|
|
||
|
# cells
|
||
|
# -----
|
||
|
@property
|
||
|
def cells(self):
|
||
|
"""
|
||
|
The 'cells' property is an instance of Cells
|
||
|
that may be specified as:
|
||
|
- An instance of :class:`plotly.graph_objs.table.Cells`
|
||
|
- A dict of string/value properties that will be passed
|
||
|
to the Cells constructor
|
||
|
|
||
|
Supported dict properties:
|
||
|
|
||
|
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: h
|
||
|
ttps://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
|
||
|
-------
|
||
|
plotly.graph_objs.table.Cells
|
||
|
"""
|
||
|
return self["cells"]
|
||
|
|
||
|
@cells.setter
|
||
|
def cells(self, val):
|
||
|
self["cells"] = val
|
||
|
|
||
|
# columnorder
|
||
|
# -----------
|
||
|
@property
|
||
|
def columnorder(self):
|
||
|
"""
|
||
|
Specifies the rendered order of the data columns; for example,
|
||
|
a value `2` at position `0` means that column index `0` in the
|
||
|
data will be rendered as the third column, as columns have an
|
||
|
index base of zero.
|
||
|
|
||
|
The 'columnorder' property is an array that may be specified as a tuple,
|
||
|
list, numpy array, or pandas Series
|
||
|
|
||
|
Returns
|
||
|
-------
|
||
|
numpy.ndarray
|
||
|
"""
|
||
|
return self["columnorder"]
|
||
|
|
||
|
@columnorder.setter
|
||
|
def columnorder(self, val):
|
||
|
self["columnorder"] = val
|
||
|
|
||
|
# columnordersrc
|
||
|
# --------------
|
||
|
@property
|
||
|
def columnordersrc(self):
|
||
|
"""
|
||
|
Sets the source reference on Chart Studio Cloud for
|
||
|
`columnorder`.
|
||
|
|
||
|
The 'columnordersrc' property must be specified as a string or
|
||
|
as a plotly.grid_objs.Column object
|
||
|
|
||
|
Returns
|
||
|
-------
|
||
|
str
|
||
|
"""
|
||
|
return self["columnordersrc"]
|
||
|
|
||
|
@columnordersrc.setter
|
||
|
def columnordersrc(self, val):
|
||
|
self["columnordersrc"] = val
|
||
|
|
||
|
# columnwidth
|
||
|
# -----------
|
||
|
@property
|
||
|
def columnwidth(self):
|
||
|
"""
|
||
|
The width of columns expressed as a ratio. Columns fill the
|
||
|
available width in proportion of their specified column widths.
|
||
|
|
||
|
The 'columnwidth' property is a number and may be specified as:
|
||
|
- An int or float
|
||
|
- A tuple, list, or one-dimensional numpy array of the above
|
||
|
|
||
|
Returns
|
||
|
-------
|
||
|
int|float|numpy.ndarray
|
||
|
"""
|
||
|
return self["columnwidth"]
|
||
|
|
||
|
@columnwidth.setter
|
||
|
def columnwidth(self, val):
|
||
|
self["columnwidth"] = val
|
||
|
|
||
|
# columnwidthsrc
|
||
|
# --------------
|
||
|
@property
|
||
|
def columnwidthsrc(self):
|
||
|
"""
|
||
|
Sets the source reference on Chart Studio Cloud for
|
||
|
`columnwidth`.
|
||
|
|
||
|
The 'columnwidthsrc' property must be specified as a string or
|
||
|
as a plotly.grid_objs.Column object
|
||
|
|
||
|
Returns
|
||
|
-------
|
||
|
str
|
||
|
"""
|
||
|
return self["columnwidthsrc"]
|
||
|
|
||
|
@columnwidthsrc.setter
|
||
|
def columnwidthsrc(self, val):
|
||
|
self["columnwidthsrc"] = val
|
||
|
|
||
|
# customdata
|
||
|
# ----------
|
||
|
@property
|
||
|
def customdata(self):
|
||
|
"""
|
||
|
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
|
||
|
|
||
|
The 'customdata' property is an array that may be specified as a tuple,
|
||
|
list, numpy array, or pandas Series
|
||
|
|
||
|
Returns
|
||
|
-------
|
||
|
numpy.ndarray
|
||
|
"""
|
||
|
return self["customdata"]
|
||
|
|
||
|
@customdata.setter
|
||
|
def customdata(self, val):
|
||
|
self["customdata"] = val
|
||
|
|
||
|
# customdatasrc
|
||
|
# -------------
|
||
|
@property
|
||
|
def customdatasrc(self):
|
||
|
"""
|
||
|
Sets the source reference on Chart Studio Cloud for
|
||
|
`customdata`.
|
||
|
|
||
|
The 'customdatasrc' property must be specified as a string or
|
||
|
as a plotly.grid_objs.Column object
|
||
|
|
||
|
Returns
|
||
|
-------
|
||
|
str
|
||
|
"""
|
||
|
return self["customdatasrc"]
|
||
|
|
||
|
@customdatasrc.setter
|
||
|
def customdatasrc(self, val):
|
||
|
self["customdatasrc"] = val
|
||
|
|
||
|
# domain
|
||
|
# ------
|
||
|
@property
|
||
|
def domain(self):
|
||
|
"""
|
||
|
The 'domain' property is an instance of Domain
|
||
|
that may be specified as:
|
||
|
- An instance of :class:`plotly.graph_objs.table.Domain`
|
||
|
- A dict of string/value properties that will be passed
|
||
|
to the Domain constructor
|
||
|
|
||
|
Supported dict properties:
|
||
|
|
||
|
column
|
||
|
If there is a layout grid, use the domain for
|
||
|
this column in the grid for this table trace .
|
||
|
row
|
||
|
If there is a layout grid, use the domain for
|
||
|
this row in the grid for this table trace .
|
||
|
x
|
||
|
Sets the horizontal domain of this table trace
|
||
|
(in plot fraction).
|
||
|
y
|
||
|
Sets the vertical domain of this table trace
|
||
|
(in plot fraction).
|
||
|
|
||
|
Returns
|
||
|
-------
|
||
|
plotly.graph_objs.table.Domain
|
||
|
"""
|
||
|
return self["domain"]
|
||
|
|
||
|
@domain.setter
|
||
|
def domain(self, val):
|
||
|
self["domain"] = val
|
||
|
|
||
|
# header
|
||
|
# ------
|
||
|
@property
|
||
|
def header(self):
|
||
|
"""
|
||
|
The 'header' property is an instance of Header
|
||
|
that may be specified as:
|
||
|
- An instance of :class:`plotly.graph_objs.table.Header`
|
||
|
- A dict of string/value properties that will be passed
|
||
|
to the Header constructor
|
||
|
|
||
|
Supported dict properties:
|
||
|
|
||
|
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.header.Fill`
|
||
|
instance or dict with compatible properties
|
||
|
font
|
||
|
:class:`plotly.graph_objects.table.header.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: h
|
||
|
ttps://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.header.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
|
||
|
Header 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
|
||
|
-------
|
||
|
plotly.graph_objs.table.Header
|
||
|
"""
|
||
|
return self["header"]
|
||
|
|
||
|
@header.setter
|
||
|
def header(self, val):
|
||
|
self["header"] = val
|
||
|
|
||
|
# hoverinfo
|
||
|
# ---------
|
||
|
@property
|
||
|
def hoverinfo(self):
|
||
|
"""
|
||
|
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.
|
||
|
|
||
|
The 'hoverinfo' property is a flaglist and may be specified
|
||
|
as a string containing:
|
||
|
- Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
|
||
|
(e.g. 'x+y')
|
||
|
OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
|
||
|
- A list or array of the above
|
||
|
|
||
|
Returns
|
||
|
-------
|
||
|
Any|numpy.ndarray
|
||
|
"""
|
||
|
return self["hoverinfo"]
|
||
|
|
||
|
@hoverinfo.setter
|
||
|
def hoverinfo(self, val):
|
||
|
self["hoverinfo"] = val
|
||
|
|
||
|
# hoverinfosrc
|
||
|
# ------------
|
||
|
@property
|
||
|
def hoverinfosrc(self):
|
||
|
"""
|
||
|
Sets the source reference on Chart Studio Cloud for
|
||
|
`hoverinfo`.
|
||
|
|
||
|
The 'hoverinfosrc' property must be specified as a string or
|
||
|
as a plotly.grid_objs.Column object
|
||
|
|
||
|
Returns
|
||
|
-------
|
||
|
str
|
||
|
"""
|
||
|
return self["hoverinfosrc"]
|
||
|
|
||
|
@hoverinfosrc.setter
|
||
|
def hoverinfosrc(self, val):
|
||
|
self["hoverinfosrc"] = val
|
||
|
|
||
|
# hoverlabel
|
||
|
# ----------
|
||
|
@property
|
||
|
def hoverlabel(self):
|
||
|
"""
|
||
|
The 'hoverlabel' property is an instance of Hoverlabel
|
||
|
that may be specified as:
|
||
|
- An instance of :class:`plotly.graph_objs.table.Hoverlabel`
|
||
|
- A dict of string/value properties that will be passed
|
||
|
to the Hoverlabel constructor
|
||
|
|
||
|
Supported dict properties:
|
||
|
|
||
|
align
|
||
|
Sets the horizontal alignment of the text
|
||
|
content within hover label box. Has an effect
|
||
|
only if the hover label text spans more two or
|
||
|
more lines
|
||
|
alignsrc
|
||
|
Sets the source reference on Chart Studio Cloud
|
||
|
for `align`.
|
||
|
bgcolor
|
||
|
Sets the background color of the hover labels
|
||
|
for this trace
|
||
|
bgcolorsrc
|
||
|
Sets the source reference on Chart Studio Cloud
|
||
|
for `bgcolor`.
|
||
|
bordercolor
|
||
|
Sets the border color of the hover labels for
|
||
|
this trace.
|
||
|
bordercolorsrc
|
||
|
Sets the source reference on Chart Studio Cloud
|
||
|
for `bordercolor`.
|
||
|
font
|
||
|
Sets the font used in hover labels.
|
||
|
namelength
|
||
|
Sets the default length (in number of
|
||
|
characters) of the trace name in the hover
|
||
|
labels for all traces. -1 shows the whole name
|
||
|
regardless of length. 0-3 shows the first 0-3
|
||
|
characters, and an integer >3 will show the
|
||
|
whole name if it is less than that many
|
||
|
characters, but if it is longer, will truncate
|
||
|
to `namelength - 3` characters and add an
|
||
|
ellipsis.
|
||
|
namelengthsrc
|
||
|
Sets the source reference on Chart Studio Cloud
|
||
|
for `namelength`.
|
||
|
|
||
|
Returns
|
||
|
-------
|
||
|
plotly.graph_objs.table.Hoverlabel
|
||
|
"""
|
||
|
return self["hoverlabel"]
|
||
|
|
||
|
@hoverlabel.setter
|
||
|
def hoverlabel(self, val):
|
||
|
self["hoverlabel"] = val
|
||
|
|
||
|
# ids
|
||
|
# ---
|
||
|
@property
|
||
|
def ids(self):
|
||
|
"""
|
||
|
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.
|
||
|
|
||
|
The 'ids' property is an array that may be specified as a tuple,
|
||
|
list, numpy array, or pandas Series
|
||
|
|
||
|
Returns
|
||
|
-------
|
||
|
numpy.ndarray
|
||
|
"""
|
||
|
return self["ids"]
|
||
|
|
||
|
@ids.setter
|
||
|
def ids(self, val):
|
||
|
self["ids"] = val
|
||
|
|
||
|
# idssrc
|
||
|
# ------
|
||
|
@property
|
||
|
def idssrc(self):
|
||
|
"""
|
||
|
Sets the source reference on Chart Studio Cloud for `ids`.
|
||
|
|
||
|
The 'idssrc' property must be specified as a string or
|
||
|
as a plotly.grid_objs.Column object
|
||
|
|
||
|
Returns
|
||
|
-------
|
||
|
str
|
||
|
"""
|
||
|
return self["idssrc"]
|
||
|
|
||
|
@idssrc.setter
|
||
|
def idssrc(self, val):
|
||
|
self["idssrc"] = val
|
||
|
|
||
|
# legend
|
||
|
# ------
|
||
|
@property
|
||
|
def legend(self):
|
||
|
"""
|
||
|
Sets the reference to a legend to show this trace in.
|
||
|
References to these legends are "legend", "legend2", "legend3",
|
||
|
etc. Settings for these legends are set in the layout, under
|
||
|
`layout.legend`, `layout.legend2`, etc.
|
||
|
|
||
|
The 'legend' property is an identifier of a particular
|
||
|
subplot, of type 'legend', that may be specified as the string 'legend'
|
||
|
optionally followed by an integer >= 1
|
||
|
(e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
||
|
|
||
|
Returns
|
||
|
-------
|
||
|
str
|
||
|
"""
|
||
|
return self["legend"]
|
||
|
|
||
|
@legend.setter
|
||
|
def legend(self, val):
|
||
|
self["legend"] = val
|
||
|
|
||
|
# legendgrouptitle
|
||
|
# ----------------
|
||
|
@property
|
||
|
def legendgrouptitle(self):
|
||
|
"""
|
||
|
The 'legendgrouptitle' property is an instance of Legendgrouptitle
|
||
|
that may be specified as:
|
||
|
- An instance of :class:`plotly.graph_objs.table.Legendgrouptitle`
|
||
|
- A dict of string/value properties that will be passed
|
||
|
to the Legendgrouptitle constructor
|
||
|
|
||
|
Supported dict properties:
|
||
|
|
||
|
font
|
||
|
Sets this legend group's title font.
|
||
|
text
|
||
|
Sets the title of the legend group.
|
||
|
|
||
|
Returns
|
||
|
-------
|
||
|
plotly.graph_objs.table.Legendgrouptitle
|
||
|
"""
|
||
|
return self["legendgrouptitle"]
|
||
|
|
||
|
@legendgrouptitle.setter
|
||
|
def legendgrouptitle(self, val):
|
||
|
self["legendgrouptitle"] = val
|
||
|
|
||
|
# legendrank
|
||
|
# ----------
|
||
|
@property
|
||
|
def legendrank(self):
|
||
|
"""
|
||
|
Sets the legend rank for this trace. Items and groups with
|
||
|
smaller ranks are presented on top/left side while with
|
||
|
"reversed" `legend.traceorder` they are on bottom/right side.
|
||
|
The default legendrank is 1000, so that you can use ranks less
|
||
|
than 1000 to place certain items before all unranked items, and
|
||
|
ranks greater than 1000 to go after all unranked items. When
|
||
|
having unranked or equal rank items shapes would be displayed
|
||
|
after traces i.e. according to their order in data and layout.
|
||
|
|
||
|
The 'legendrank' property is a number and may be specified as:
|
||
|
- An int or float
|
||
|
|
||
|
Returns
|
||
|
-------
|
||
|
int|float
|
||
|
"""
|
||
|
return self["legendrank"]
|
||
|
|
||
|
@legendrank.setter
|
||
|
def legendrank(self, val):
|
||
|
self["legendrank"] = val
|
||
|
|
||
|
# legendwidth
|
||
|
# -----------
|
||
|
@property
|
||
|
def legendwidth(self):
|
||
|
"""
|
||
|
Sets the width (in px or fraction) of the legend for this
|
||
|
trace.
|
||
|
|
||
|
The 'legendwidth' property is a number and may be specified as:
|
||
|
- An int or float in the interval [0, inf]
|
||
|
|
||
|
Returns
|
||
|
-------
|
||
|
int|float
|
||
|
"""
|
||
|
return self["legendwidth"]
|
||
|
|
||
|
@legendwidth.setter
|
||
|
def legendwidth(self, val):
|
||
|
self["legendwidth"] = val
|
||
|
|
||
|
# meta
|
||
|
# ----
|
||
|
@property
|
||
|
def meta(self):
|
||
|
"""
|
||
|
Assigns extra meta information associated with this trace that
|
||
|
can be used in various text attributes. Attributes such as
|
||
|
trace `name`, graph, axis and colorbar `title.text`, annotation
|
||
|
`text` `rangeselector`, `updatemenues` and `sliders` `label`
|
||
|
text all support `meta`. To access the trace `meta` values in
|
||
|
an attribute in the same trace, simply use `%{meta[i]}` where
|
||
|
`i` is the index or key of the `meta` item in question. To
|
||
|
access trace `meta` in layout attributes, use
|
||
|
`%{data[n[.meta[i]}` where `i` is the index or key of the
|
||
|
`meta` and `n` is the trace index.
|
||
|
|
||
|
The 'meta' property accepts values of any type
|
||
|
|
||
|
Returns
|
||
|
-------
|
||
|
Any|numpy.ndarray
|
||
|
"""
|
||
|
return self["meta"]
|
||
|
|
||
|
@meta.setter
|
||
|
def meta(self, val):
|
||
|
self["meta"] = val
|
||
|
|
||
|
# metasrc
|
||
|
# -------
|
||
|
@property
|
||
|
def metasrc(self):
|
||
|
"""
|
||
|
Sets the source reference on Chart Studio Cloud for `meta`.
|
||
|
|
||
|
The 'metasrc' property must be specified as a string or
|
||
|
as a plotly.grid_objs.Column object
|
||
|
|
||
|
Returns
|
||
|
-------
|
||
|
str
|
||
|
"""
|
||
|
return self["metasrc"]
|
||
|
|
||
|
@metasrc.setter
|
||
|
def metasrc(self, val):
|
||
|
self["metasrc"] = val
|
||
|
|
||
|
# name
|
||
|
# ----
|
||
|
@property
|
||
|
def name(self):
|
||
|
"""
|
||
|
Sets the trace name. The trace name appears as the legend item
|
||
|
and on hover.
|
||
|
|
||
|
The 'name' property is a string and must be specified as:
|
||
|
- A string
|
||
|
- A number that will be converted to a string
|
||
|
|
||
|
Returns
|
||
|
-------
|
||
|
str
|
||
|
"""
|
||
|
return self["name"]
|
||
|
|
||
|
@name.setter
|
||
|
def name(self, val):
|
||
|
self["name"] = val
|
||
|
|
||
|
# stream
|
||
|
# ------
|
||
|
@property
|
||
|
def stream(self):
|
||
|
"""
|
||
|
The 'stream' property is an instance of Stream
|
||
|
that may be specified as:
|
||
|
- An instance of :class:`plotly.graph_objs.table.Stream`
|
||
|
- A dict of string/value properties that will be passed
|
||
|
to the Stream constructor
|
||
|
|
||
|
Supported dict properties:
|
||
|
|
||
|
maxpoints
|
||
|
Sets the maximum number of points to keep on
|
||
|
the plots from an incoming stream. If
|
||
|
`maxpoints` is set to 50, only the newest 50
|
||
|
points will be displayed on the plot.
|
||
|
token
|
||
|
The stream id number links a data trace on a
|
||
|
plot with a stream. See https://chart-
|
||
|
studio.plotly.com/settings for more details.
|
||
|
|
||
|
Returns
|
||
|
-------
|
||
|
plotly.graph_objs.table.Stream
|
||
|
"""
|
||
|
return self["stream"]
|
||
|
|
||
|
@stream.setter
|
||
|
def stream(self, val):
|
||
|
self["stream"] = val
|
||
|
|
||
|
# uid
|
||
|
# ---
|
||
|
@property
|
||
|
def uid(self):
|
||
|
"""
|
||
|
Assign an id to this trace, Use this to provide object
|
||
|
constancy between traces during animations and transitions.
|
||
|
|
||
|
The 'uid' property is a string and must be specified as:
|
||
|
- A string
|
||
|
- A number that will be converted to a string
|
||
|
|
||
|
Returns
|
||
|
-------
|
||
|
str
|
||
|
"""
|
||
|
return self["uid"]
|
||
|
|
||
|
@uid.setter
|
||
|
def uid(self, val):
|
||
|
self["uid"] = val
|
||
|
|
||
|
# uirevision
|
||
|
# ----------
|
||
|
@property
|
||
|
def uirevision(self):
|
||
|
"""
|
||
|
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.
|
||
|
|
||
|
The 'uirevision' property accepts values of any type
|
||
|
|
||
|
Returns
|
||
|
-------
|
||
|
Any
|
||
|
"""
|
||
|
return self["uirevision"]
|
||
|
|
||
|
@uirevision.setter
|
||
|
def uirevision(self, val):
|
||
|
self["uirevision"] = val
|
||
|
|
||
|
# visible
|
||
|
# -------
|
||
|
@property
|
||
|
def visible(self):
|
||
|
"""
|
||
|
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).
|
||
|
|
||
|
The 'visible' property is an enumeration that may be specified as:
|
||
|
- One of the following enumeration values:
|
||
|
[True, False, 'legendonly']
|
||
|
|
||
|
Returns
|
||
|
-------
|
||
|
Any
|
||
|
"""
|
||
|
return self["visible"]
|
||
|
|
||
|
@visible.setter
|
||
|
def visible(self, val):
|
||
|
self["visible"] = val
|
||
|
|
||
|
# type
|
||
|
# ----
|
||
|
@property
|
||
|
def type(self):
|
||
|
return self._props["type"]
|
||
|
|
||
|
# Self properties description
|
||
|
# ---------------------------
|
||
|
@property
|
||
|
def _prop_descriptions(self):
|
||
|
return """\
|
||
|
cells
|
||
|
:class:`plotly.graph_objects.table.Cells` instance or
|
||
|
dict with compatible properties
|
||
|
columnorder
|
||
|
Specifies the rendered order of the data columns; for
|
||
|
example, a value `2` at position `0` means that column
|
||
|
index `0` in the data will be rendered as the third
|
||
|
column, as columns have an index base of zero.
|
||
|
columnordersrc
|
||
|
Sets the source reference on Chart Studio Cloud for
|
||
|
`columnorder`.
|
||
|
columnwidth
|
||
|
The width of columns expressed as a ratio. Columns fill
|
||
|
the available width in proportion of their specified
|
||
|
column widths.
|
||
|
columnwidthsrc
|
||
|
Sets the source reference on Chart Studio Cloud for
|
||
|
`columnwidth`.
|
||
|
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 Chart Studio Cloud for
|
||
|
`customdata`.
|
||
|
domain
|
||
|
:class:`plotly.graph_objects.table.Domain` instance or
|
||
|
dict with compatible properties
|
||
|
header
|
||
|
:class:`plotly.graph_objects.table.Header` instance or
|
||
|
dict with compatible properties
|
||
|
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 Chart Studio Cloud for
|
||
|
`hoverinfo`.
|
||
|
hoverlabel
|
||
|
:class:`plotly.graph_objects.table.Hoverlabel` instance
|
||
|
or dict with compatible properties
|
||
|
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 Chart Studio Cloud for
|
||
|
`ids`.
|
||
|
legend
|
||
|
Sets the reference to a legend to show this trace in.
|
||
|
References to these legends are "legend", "legend2",
|
||
|
"legend3", etc. Settings for these legends are set in
|
||
|
the layout, under `layout.legend`, `layout.legend2`,
|
||
|
etc.
|
||
|
legendgrouptitle
|
||
|
:class:`plotly.graph_objects.table.Legendgrouptitle`
|
||
|
instance or dict with compatible properties
|
||
|
legendrank
|
||
|
Sets the legend rank for this trace. Items and groups
|
||
|
with smaller ranks are presented on top/left side while
|
||
|
with "reversed" `legend.traceorder` they are on
|
||
|
bottom/right side. The default legendrank is 1000, so
|
||
|
that you can use ranks less than 1000 to place certain
|
||
|
items before all unranked items, and ranks greater than
|
||
|
1000 to go after all unranked items. When having
|
||
|
unranked or equal rank items shapes would be displayed
|
||
|
after traces i.e. according to their order in data and
|
||
|
layout.
|
||
|
legendwidth
|
||
|
Sets the width (in px or fraction) of the legend for
|
||
|
this trace.
|
||
|
meta
|
||
|
Assigns extra meta information associated with this
|
||
|
trace that can be used in various text attributes.
|
||
|
Attributes such as trace `name`, graph, axis and
|
||
|
colorbar `title.text`, annotation `text`
|
||
|
`rangeselector`, `updatemenues` and `sliders` `label`
|
||
|
text all support `meta`. To access the trace `meta`
|
||
|
values in an attribute in the same trace, simply use
|
||
|
`%{meta[i]}` where `i` is the index or key of the
|
||
|
`meta` item in question. To access trace `meta` in
|
||
|
layout attributes, use `%{data[n[.meta[i]}` where `i`
|
||
|
is the index or key of the `meta` and `n` is the trace
|
||
|
index.
|
||
|
metasrc
|
||
|
Sets the source reference on Chart Studio Cloud for
|
||
|
`meta`.
|
||
|
name
|
||
|
Sets the trace name. The trace name appears as the
|
||
|
legend item and on hover.
|
||
|
stream
|
||
|
:class:`plotly.graph_objects.table.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).
|
||
|
"""
|
||
|
|
||
|
def __init__(
|
||
|
self,
|
||
|
arg=None,
|
||
|
cells=None,
|
||
|
columnorder=None,
|
||
|
columnordersrc=None,
|
||
|
columnwidth=None,
|
||
|
columnwidthsrc=None,
|
||
|
customdata=None,
|
||
|
customdatasrc=None,
|
||
|
domain=None,
|
||
|
header=None,
|
||
|
hoverinfo=None,
|
||
|
hoverinfosrc=None,
|
||
|
hoverlabel=None,
|
||
|
ids=None,
|
||
|
idssrc=None,
|
||
|
legend=None,
|
||
|
legendgrouptitle=None,
|
||
|
legendrank=None,
|
||
|
legendwidth=None,
|
||
|
meta=None,
|
||
|
metasrc=None,
|
||
|
name=None,
|
||
|
stream=None,
|
||
|
uid=None,
|
||
|
uirevision=None,
|
||
|
visible=None,
|
||
|
**kwargs,
|
||
|
):
|
||
|
"""
|
||
|
Construct a new Table object
|
||
|
|
||
|
Table view for detailed data viewing. The data are arranged in
|
||
|
a grid of rows and columns. Most styling can be specified for
|
||
|
columns, rows or individual cells. Table is using a column-
|
||
|
major order, ie. the grid is represented as a vector of column
|
||
|
vectors.
|
||
|
|
||
|
Parameters
|
||
|
----------
|
||
|
arg
|
||
|
dict of properties compatible with this constructor or
|
||
|
an instance of :class:`plotly.graph_objs.Table`
|
||
|
cells
|
||
|
:class:`plotly.graph_objects.table.Cells` instance or
|
||
|
dict with compatible properties
|
||
|
columnorder
|
||
|
Specifies the rendered order of the data columns; for
|
||
|
example, a value `2` at position `0` means that column
|
||
|
index `0` in the data will be rendered as the third
|
||
|
column, as columns have an index base of zero.
|
||
|
columnordersrc
|
||
|
Sets the source reference on Chart Studio Cloud for
|
||
|
`columnorder`.
|
||
|
columnwidth
|
||
|
The width of columns expressed as a ratio. Columns fill
|
||
|
the available width in proportion of their specified
|
||
|
column widths.
|
||
|
columnwidthsrc
|
||
|
Sets the source reference on Chart Studio Cloud for
|
||
|
`columnwidth`.
|
||
|
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 Chart Studio Cloud for
|
||
|
`customdata`.
|
||
|
domain
|
||
|
:class:`plotly.graph_objects.table.Domain` instance or
|
||
|
dict with compatible properties
|
||
|
header
|
||
|
:class:`plotly.graph_objects.table.Header` instance or
|
||
|
dict with compatible properties
|
||
|
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 Chart Studio Cloud for
|
||
|
`hoverinfo`.
|
||
|
hoverlabel
|
||
|
:class:`plotly.graph_objects.table.Hoverlabel` instance
|
||
|
or dict with compatible properties
|
||
|
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 Chart Studio Cloud for
|
||
|
`ids`.
|
||
|
legend
|
||
|
Sets the reference to a legend to show this trace in.
|
||
|
References to these legends are "legend", "legend2",
|
||
|
"legend3", etc. Settings for these legends are set in
|
||
|
the layout, under `layout.legend`, `layout.legend2`,
|
||
|
etc.
|
||
|
legendgrouptitle
|
||
|
:class:`plotly.graph_objects.table.Legendgrouptitle`
|
||
|
instance or dict with compatible properties
|
||
|
legendrank
|
||
|
Sets the legend rank for this trace. Items and groups
|
||
|
with smaller ranks are presented on top/left side while
|
||
|
with "reversed" `legend.traceorder` they are on
|
||
|
bottom/right side. The default legendrank is 1000, so
|
||
|
that you can use ranks less than 1000 to place certain
|
||
|
items before all unranked items, and ranks greater than
|
||
|
1000 to go after all unranked items. When having
|
||
|
unranked or equal rank items shapes would be displayed
|
||
|
after traces i.e. according to their order in data and
|
||
|
layout.
|
||
|
legendwidth
|
||
|
Sets the width (in px or fraction) of the legend for
|
||
|
this trace.
|
||
|
meta
|
||
|
Assigns extra meta information associated with this
|
||
|
trace that can be used in various text attributes.
|
||
|
Attributes such as trace `name`, graph, axis and
|
||
|
colorbar `title.text`, annotation `text`
|
||
|
`rangeselector`, `updatemenues` and `sliders` `label`
|
||
|
text all support `meta`. To access the trace `meta`
|
||
|
values in an attribute in the same trace, simply use
|
||
|
`%{meta[i]}` where `i` is the index or key of the
|
||
|
`meta` item in question. To access trace `meta` in
|
||
|
layout attributes, use `%{data[n[.meta[i]}` where `i`
|
||
|
is the index or key of the `meta` and `n` is the trace
|
||
|
index.
|
||
|
metasrc
|
||
|
Sets the source reference on Chart Studio Cloud for
|
||
|
`meta`.
|
||
|
name
|
||
|
Sets the trace name. The trace name appears as the
|
||
|
legend item and on hover.
|
||
|
stream
|
||
|
:class:`plotly.graph_objects.table.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).
|
||
|
|
||
|
Returns
|
||
|
-------
|
||
|
Table
|
||
|
"""
|
||
|
super(Table, self).__init__("table")
|
||
|
|
||
|
if "_parent" in kwargs:
|
||
|
self._parent = kwargs["_parent"]
|
||
|
return
|
||
|
|
||
|
# Validate arg
|
||
|
# ------------
|
||
|
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
|
||
|
constructor must be a dict or
|
||
|
an instance of :class:`plotly.graph_objs.Table`"""
|
||
|
)
|
||
|
|
||
|
# Handle skip_invalid
|
||
|
# -------------------
|
||
|
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||
|
self._validate = kwargs.pop("_validate", True)
|
||
|
|
||
|
# Populate data dict with properties
|
||
|
# ----------------------------------
|
||
|
_v = arg.pop("cells", None)
|
||
|
_v = cells if cells is not None else _v
|
||
|
if _v is not None:
|
||
|
self["cells"] = _v
|
||
|
_v = arg.pop("columnorder", None)
|
||
|
_v = columnorder if columnorder is not None else _v
|
||
|
if _v is not None:
|
||
|
self["columnorder"] = _v
|
||
|
_v = arg.pop("columnordersrc", None)
|
||
|
_v = columnordersrc if columnordersrc is not None else _v
|
||
|
if _v is not None:
|
||
|
self["columnordersrc"] = _v
|
||
|
_v = arg.pop("columnwidth", None)
|
||
|
_v = columnwidth if columnwidth is not None else _v
|
||
|
if _v is not None:
|
||
|
self["columnwidth"] = _v
|
||
|
_v = arg.pop("columnwidthsrc", None)
|
||
|
_v = columnwidthsrc if columnwidthsrc is not None else _v
|
||
|
if _v is not None:
|
||
|
self["columnwidthsrc"] = _v
|
||
|
_v = arg.pop("customdata", None)
|
||
|
_v = customdata if customdata is not None else _v
|
||
|
if _v is not None:
|
||
|
self["customdata"] = _v
|
||
|
_v = arg.pop("customdatasrc", None)
|
||
|
_v = customdatasrc if customdatasrc is not None else _v
|
||
|
if _v is not None:
|
||
|
self["customdatasrc"] = _v
|
||
|
_v = arg.pop("domain", None)
|
||
|
_v = domain if domain is not None else _v
|
||
|
if _v is not None:
|
||
|
self["domain"] = _v
|
||
|
_v = arg.pop("header", None)
|
||
|
_v = header if header is not None else _v
|
||
|
if _v is not None:
|
||
|
self["header"] = _v
|
||
|
_v = arg.pop("hoverinfo", None)
|
||
|
_v = hoverinfo if hoverinfo is not None else _v
|
||
|
if _v is not None:
|
||
|
self["hoverinfo"] = _v
|
||
|
_v = arg.pop("hoverinfosrc", None)
|
||
|
_v = hoverinfosrc if hoverinfosrc is not None else _v
|
||
|
if _v is not None:
|
||
|
self["hoverinfosrc"] = _v
|
||
|
_v = arg.pop("hoverlabel", None)
|
||
|
_v = hoverlabel if hoverlabel is not None else _v
|
||
|
if _v is not None:
|
||
|
self["hoverlabel"] = _v
|
||
|
_v = arg.pop("ids", None)
|
||
|
_v = ids if ids is not None else _v
|
||
|
if _v is not None:
|
||
|
self["ids"] = _v
|
||
|
_v = arg.pop("idssrc", None)
|
||
|
_v = idssrc if idssrc is not None else _v
|
||
|
if _v is not None:
|
||
|
self["idssrc"] = _v
|
||
|
_v = arg.pop("legend", None)
|
||
|
_v = legend if legend is not None else _v
|
||
|
if _v is not None:
|
||
|
self["legend"] = _v
|
||
|
_v = arg.pop("legendgrouptitle", None)
|
||
|
_v = legendgrouptitle if legendgrouptitle is not None else _v
|
||
|
if _v is not None:
|
||
|
self["legendgrouptitle"] = _v
|
||
|
_v = arg.pop("legendrank", None)
|
||
|
_v = legendrank if legendrank is not None else _v
|
||
|
if _v is not None:
|
||
|
self["legendrank"] = _v
|
||
|
_v = arg.pop("legendwidth", None)
|
||
|
_v = legendwidth if legendwidth is not None else _v
|
||
|
if _v is not None:
|
||
|
self["legendwidth"] = _v
|
||
|
_v = arg.pop("meta", None)
|
||
|
_v = meta if meta is not None else _v
|
||
|
if _v is not None:
|
||
|
self["meta"] = _v
|
||
|
_v = arg.pop("metasrc", None)
|
||
|
_v = metasrc if metasrc is not None else _v
|
||
|
if _v is not None:
|
||
|
self["metasrc"] = _v
|
||
|
_v = arg.pop("name", None)
|
||
|
_v = name if name is not None else _v
|
||
|
if _v is not None:
|
||
|
self["name"] = _v
|
||
|
_v = arg.pop("stream", None)
|
||
|
_v = stream if stream is not None else _v
|
||
|
if _v is not None:
|
||
|
self["stream"] = _v
|
||
|
_v = arg.pop("uid", None)
|
||
|
_v = uid if uid is not None else _v
|
||
|
if _v is not None:
|
||
|
self["uid"] = _v
|
||
|
_v = arg.pop("uirevision", None)
|
||
|
_v = uirevision if uirevision is not None else _v
|
||
|
if _v is not None:
|
||
|
self["uirevision"] = _v
|
||
|
_v = arg.pop("visible", None)
|
||
|
_v = visible if visible is not None else _v
|
||
|
if _v is not None:
|
||
|
self["visible"] = _v
|
||
|
|
||
|
# Read-only literals
|
||
|
# ------------------
|
||
|
|
||
|
self._props["type"] = "table"
|
||
|
arg.pop("type", None)
|
||
|
|
||
|
# Process unknown kwargs
|
||
|
# ----------------------
|
||
|
self._process_kwargs(**dict(arg, **kwargs))
|
||
|
|
||
|
# Reset skip_invalid
|
||
|
# ------------------
|
||
|
self._skip_invalid = False
|