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