plotly.graph_objects.Table¶

class plotly.graph_objects.Table(arg=None, cells=None, columnorder=None, columnwidth=None, customdata=None, domain=None, header=None, hoverinfo=None, hoverlabel=None, ids=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, name=None, uid=None, uirevision=None, visible=None, **kwargs)¶

__init__(arg=None, cells=None, columnorder=None, columnwidth=None, customdata=None, domain=None, header=None, hoverinfo=None, hoverlabel=None, ids=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, meta=None, name=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 plotly.graph_objects.Table

• cells – 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.

• columnwidth – The width of columns expressed as a ratio. Columns fill the available width in proportion of their specified column widths.

• 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

• domain – plotly.graph_objects.table.Domain instance or dict with compatible properties

• header – plotly.graph_objects.table.Header instance or dict with compatible properties

• hoverinfo – Determines what trace information appears 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.

• hoverlabel – 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.

• 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 – 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.

• name – Sets the trace name. The trace name appears as the legend item and on hover.

• 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

Return type

Table

plotly.graph_objects.table¶

class plotly.graph_objects.table.Cells(arg=None, align=None, fill=None, font=None, format=None, height=None, line=None, prefix=None, suffix=None, values=None, **kwargs)¶

property 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.

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

Return type

Any|numpy.ndarray

property fill¶

The ‘fill’ property is an instance of Fill that may be specified as:

• An instance of plotly.graph_objects.table.cells.Fill

• A dict of string/value properties that will be passed to the Fill constructor

Returns

Return type

plotly.graph_objects.table.cells.Fill

property font¶

The ‘font’ property is an instance of Font that may be specified as:

• An instance of plotly.graph_objects.table.cells.Font

• A dict of string/value properties that will be passed to the Font constructor

Returns

Return type

plotly.graph_objects.table.cells.Font

property 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.

The ‘format’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

property height¶

The height of cells.

The ‘height’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property line¶

The ‘line’ property is an instance of Line that may be specified as:

• An instance of plotly.graph_objects.table.cells.Line

• A dict of string/value properties that will be passed to the Line constructor

Returns

Return type

plotly.graph_objects.table.cells.Line

property prefix¶

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

Return type

str|numpy.ndarray

property suffix¶

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

Return type

str|numpy.ndarray

property 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.

The ‘values’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

class plotly.graph_objects.table.Domain(arg=None, column=None, row=None, x=None, y=None, **kwargs)¶

property column¶

If there is a layout grid, use the domain for this column in the grid for this table trace.

The ‘column’ property is an integer and may be specified as:

• An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns

Return type

int

property row¶

If there is a layout grid, use the domain for this row in the grid for this table trace.

The ‘row’ property is an integer and may be specified as:

• An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns

Return type

int

property x¶

Sets the horizontal domain of this table trace (in plot

fraction).

The ‘x’ property is an info array that may be specified as:

• a list or tuple of 2 elements where:

0. The ‘x[0]’ property is a number and may be specified as:

   • An int or float in the interval [0, 1]

1. The ‘x[1]’ property is a number and may be specified as:

   • An int or float in the interval [0, 1]

   list

property y¶

Sets the vertical domain of this table trace (in plot

fraction).

The ‘y’ property is an info array that may be specified as:

• a list or tuple of 2 elements where:

0. The ‘y[0]’ property is a number and may be specified as:

   • An int or float in the interval [0, 1]

1. The ‘y[1]’ property is a number and may be specified as:

   • An int or float in the interval [0, 1]

   list

class plotly.graph_objects.table.Header(arg=None, align=None, fill=None, font=None, format=None, height=None, line=None, prefix=None, suffix=None, values=None, **kwargs)¶

property 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.

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

Return type

Any|numpy.ndarray

property fill¶

The ‘fill’ property is an instance of Fill that may be specified as:

• An instance of plotly.graph_objects.table.header.Fill

• A dict of string/value properties that will be passed to the Fill constructor

Returns

Return type

plotly.graph_objects.table.header.Fill

property font¶

The ‘font’ property is an instance of Font that may be specified as:

• An instance of plotly.graph_objects.table.header.Font

• A dict of string/value properties that will be passed to the Font constructor

Returns

Return type

plotly.graph_objects.table.header.Font

property 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.

The ‘format’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

property height¶

The height of cells.

The ‘height’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property line¶

The ‘line’ property is an instance of Line that may be specified as:

• An instance of plotly.graph_objects.table.header.Line

• A dict of string/value properties that will be passed to the Line constructor

Returns

Return type

plotly.graph_objects.table.header.Line

property prefix¶

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

Return type

str|numpy.ndarray

property suffix¶

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

Return type

str|numpy.ndarray

property 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.

The ‘values’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

class plotly.graph_objects.table.Hoverlabel(arg=None, align=None, bgcolor=None, bordercolor=None, font=None, namelength=None, showarrow=None, **kwargs)¶

property 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

The ‘align’ property is an enumeration that may be specified as:

• One of the following enumeration values:

  [‘left’, ‘right’, ‘auto’]

• A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

Any|numpy.ndarray

property bgcolor¶

Sets the background color of the hover labels for this trace

The ‘bgcolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

• A list or array of any of the above

Returns

Return type

str|numpy.ndarray

property bordercolor¶

Sets the border color of the hover labels for this trace.

The ‘bordercolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

• A list or array of any of the above

Returns

Return type

str|numpy.ndarray

property font¶

Sets the font used in hover labels.

The ‘font’ property is an instance of Font that may be specified as:

• An instance of plotly.graph_objects.table.hoverlabel.Font

• A dict of string/value properties that will be passed to the Font constructor

Returns

Return type

plotly.graph_objects.table.hoverlabel.Font

property 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.

The ‘namelength’ property is an integer and may be specified as:

• An int (or float that will be cast to an int) in the interval [-1, 9223372036854775807]

• A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

int|numpy.ndarray

property showarrow¶

Sets whether or not to show the hover label arrow/triangle pointing to the data point.

The ‘showarrow’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

class plotly.graph_objects.table.Legendgrouptitle(arg=None, font=None, text=None, **kwargs)¶

property font¶

Sets this legend group’s title font.

The ‘font’ property is an instance of Font that may be specified as:

• An instance of plotly.graph_objects.table.legendgrouptitle.Font

• A dict of string/value properties that will be passed to the Font constructor

Returns

Return type

plotly.graph_objects.table.legendgrouptitle.Font

property text¶

Sets the title of the legend group.

The ‘text’ property is a string and must be specified as:

• A string

• A number that will be converted to a string

Returns

Return type

str