plotly.graph_objects.Table

class plotly.graph_objects.Table(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, meta=None, metasrc=None, name=None, stream=None, uid=None, uirevision=None, visible=None, **kwargs)
__init__(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, 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 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.

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

  • 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 appear as the legend item and on hover.

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

Return type

Table

plotly.graph_objects.table

plotly.graph_objects.table

class plotly.graph_objects.table.Cells(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)
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 alignsrc

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

Return type

str

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

    Supported dict properties:

    color

    Sets the cell fill color. It accepts either a specific color or an array of colors or a 2D array of colors.

    colorsrc

    Sets the source reference on Chart Studio Cloud for color .

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

    Supported dict properties:

    color

    colorsrc

    Sets the source reference on Chart Studio Cloud for color .

    family

    HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”,, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.

    familysrc

    Sets the source reference on Chart Studio Cloud for family .

    size

    sizesrc

    Sets the source reference on Chart Studio Cloud for size .

Returns

Return type

plotly.graph_objects.table.cells.Font

property format

Sets the cell value formatting rule using d3 formatting mini- language which is similar to those of Python. See https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#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 formatsrc

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

Return type

str

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

    Supported dict properties:

    color

    colorsrc

    Sets the source reference on Chart Studio Cloud for color .

    width

    widthsrc

    Sets the source reference on Chart Studio Cloud for width .

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 prefixsrc

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

Return type

str

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 suffixsrc

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

Return type

str

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

property valuessrc

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

Return type

str

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 a 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 a 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:

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

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

  2. 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:

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

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

  2. 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, 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)
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 alignsrc

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

Return type

str

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

    Supported dict properties:

    color

    Sets the cell fill color. It accepts either a specific color or an array of colors or a 2D array of colors.

    colorsrc

    Sets the source reference on Chart Studio Cloud for color .

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

    Supported dict properties:

    color

    colorsrc

    Sets the source reference on Chart Studio Cloud for color .

    family

    HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”,, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.

    familysrc

    Sets the source reference on Chart Studio Cloud for family .

    size

    sizesrc

    Sets the source reference on Chart Studio Cloud for size .

Returns

Return type

plotly.graph_objects.table.header.Font

property format

Sets the cell value formatting rule using d3 formatting mini- language which is similar to those of Python. See https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#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 formatsrc

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

Return type

str

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

    Supported dict properties:

    color

    colorsrc

    Sets the source reference on Chart Studio Cloud for color .

    width

    widthsrc

    Sets the source reference on Chart Studio Cloud for width .

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 prefixsrc

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

Return type

str

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 suffixsrc

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

Return type

str

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

property valuessrc

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

Return type

str

class plotly.graph_objects.table.Hoverlabel(arg=None, align=None, alignsrc=None, bgcolor=None, bgcolorsrc=None, bordercolor=None, bordercolorsrc=None, font=None, namelength=None, namelengthsrc=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 alignsrc

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

Return type

str

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 hex string (e.g. ‘#ff0000’)

  • An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

  • An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

  • An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

  • A named CSS color:

    aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

  • A list or array of any of the above

Returns

Return type

str|numpy.ndarray

property bgcolorsrc

Sets the source reference on Chart Studio Cloud for bgcolor .

The ‘bgcolorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

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 hex string (e.g. ‘#ff0000’)

  • An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

  • An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

  • An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

  • A named CSS color:

    aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

  • A list or array of any of the above

Returns

Return type

str|numpy.ndarray

property bordercolorsrc

Sets the source reference on Chart Studio Cloud for bordercolor .

The ‘bordercolorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

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

    Supported dict properties:

    color

    colorsrc

    Sets the source reference on Chart Studio Cloud for color .

    family

    HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”,, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.

    familysrc

    Sets the source reference on Chart Studio Cloud for family .

    size

    sizesrc

    Sets the source reference on Chart Studio Cloud for size .

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 a 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 namelengthsrc

Sets the source reference on Chart Studio Cloud for namelength .

The ‘namelengthsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

class plotly.graph_objects.table.Stream(arg=None, maxpoints=None, token=None, **kwargs)
property 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.

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

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

Returns

Return type

int|float

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

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

  • A non-empty string

Returns

Return type

str