plotly.graph_objects.table package¶

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)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

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)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

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)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

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)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

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)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

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