R Figure Reference: table
Traces
table
trace is initialized with plot_ly
or add_trace
:plot_ly(df, type="table"[, ...])
add_trace(p, type="table"[, ...])
A table trace accepts any of the keys listed below.
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.
- type
Parent:data[type=table]
Type: "table" - name
Parent:data[type=table]
Type: stringSets the trace name. The trace name appears as the legend item and on hover.
- visible
Parent:data[type=table]
Type: enumerated , one of (TRUE
|FALSE
|"legendonly"
)
Default:TRUE
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).
- legend
Parent:data[type=table]
Type: subplotid
Default: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.
- legendrank
Parent:data[type=table]
Type: number
Default:1000
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.
- legendgrouptitle
Parent:data[type=table]
Type: named list containing one or more of the keys listed below.- font
Parent:data[type=table].legendgrouptitle
Type: named list containing one or more of the keys listed below.Sets this legend group's title font.
- color
Parent:data[type=table].legendgrouptitle.font
Type: color - family
Parent:data[type=table].legendgrouptitle.font
Type: stringHTML 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".
- lineposition
Parent:data[type=table].legendgrouptitle.font
Type: flaglist string. Any combination of"under"
,"over"
,"through"
joined with a"+"
OR"none"
.
Examples:"under"
,"over"
,"under+over"
,"under+over+through"
,"none"
Default:"none"
Sets the kind of decoration line(s) with text, such as an "under", "over" or "through" as well as combinations e.g. "under+over", etc.
- shadow
Parent:data[type=table].legendgrouptitle.font
Type: string
Default:"none"
Sets the shape and color of the shadow behind text. "auto" places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.
- size
Parent:data[type=table].legendgrouptitle.font
Type: number greater than or equal to 1 - style
Parent:data[type=table].legendgrouptitle.font
Type: enumerated , one of ("normal"
|"italic"
)
Default:"normal"
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=table].legendgrouptitle.font
Type: enumerated , one of ("normal"
|"word caps"
|"upper"
|"lower"
)
Default:"normal"
Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=table].legendgrouptitle.font
Type: enumerated , one of ("normal"
|"small-caps"
|"all-small-caps"
|"all-petite-caps"
|"petite-caps"
|"unicase"
)
Default:"normal"
Sets the variant of the font.
- weight
Parent:data[type=table].legendgrouptitle.font
Type: integer between or equal to 1 and 1000
Default:normal
Sets the weight (or boldness) of the font.
- color
- text
Parent:data[type=table].legendgrouptitle
Type: string
Default:""
Sets the title of the legend group.
- font
- legendwidth
Parent:data[type=table]
Type: number greater than or equal to 0Sets the width (in px or fraction) of the legend for this trace.
- ids
Parent:data[type=table]
Type: dataframe column, list, vectorAssigns 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.
- columnorder
Parent:data[type=table]
Type: dataframe column, list, vectorSpecifies 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
Parent:data[type=table]
Type: number or array of numbersThe width of columns expressed as a ratio. Columns fill the available width in proportion of their specified column widths.
- hoverinfo
Parent:data[type=table]
Type: flaglist string. Any combination of"x"
,"y"
,"z"
,"text"
,"name"
joined with a"+"
OR"all"
or"none"
or"skip"
.
Examples:"x"
,"y"
,"x+y"
,"x+y+z"
,"all"
Default:"all"
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.
- meta
Parent:data[type=table]
Type: number or categorical coordinate stringAssigns 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.
- customdata
Parent:data[type=table]
Type: dataframe column, list, vectorAssigns 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
Parent:data[type=table]
Type: named list containing one or more of the keys listed below.- column
Parent:data[type=table].domain
Type: integer greater than or equal to 0
Default:0
If there is a layout grid, use the domain for this column in the grid for this table trace .
- row
Parent:data[type=table].domain
Type: integer greater than or equal to 0
Default:0
If there is a layout grid, use the domain for this row in the grid for this table trace .
- x
Parent:data[type=table].domain
Type: list
Default:[0, 1]
Sets the horizontal domain of this table trace (in plot fraction).
- y
Parent:data[type=table].domain
Type: list
Default:[0, 1]
Sets the vertical domain of this table trace (in plot fraction).
- column
- cells
Parent:data[type=table]
Type: named list containing one or more of the keys listed below.- align
Parent:data[type=table].cells
Type: enumerated or array of enumerateds , one of ("left"
|"center"
|"right"
)
Default:"center"
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.
- fill
Parent:data[type=table].cells
Type: named list containing one or more of the keys listed below.- color
Parent:data[type=table].cells.fill
Type: color or array of colors
Default:"white"
Sets the cell fill color. It accepts either a specific color or an array of colors or a 2D array of colors.
- color
- font
Parent:data[type=table].cells
Type: named list containing one or more of the keys listed below.- color
Parent:data[type=table].cells.font
Type: color or array of colors - family
Parent:data[type=table].cells.font
Type: string or array of stringsHTML 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".
- lineposition
Parent:data[type=table].cells.font
Type: flaglist string. Any combination of"under"
,"over"
,"through"
joined with a"+"
OR"none"
.
Examples:"under"
,"over"
,"under+over"
,"under+over+through"
,"none"
Default:"none"
Sets the kind of decoration line(s) with text, such as an "under", "over" or "through" as well as combinations e.g. "under+over", etc.
- shadow
Parent:data[type=table].cells.font
Type: string or array of strings
Default:"none"
Sets the shape and color of the shadow behind text. "auto" places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.
- size
Parent:data[type=table].cells.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=table].cells.font
Type: enumerated or array of enumerateds , one of ("normal"
|"italic"
)
Default:"normal"
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=table].cells.font
Type: enumerated or array of enumerateds , one of ("normal"
|"word caps"
|"upper"
|"lower"
)
Default:"normal"
Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=table].cells.font
Type: enumerated or array of enumerateds , one of ("normal"
|"small-caps"
|"all-small-caps"
|"all-petite-caps"
|"petite-caps"
|"unicase"
)
Default:"normal"
Sets the variant of the font.
- weight
Parent:data[type=table].cells.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normal
Sets the weight (or boldness) of the font.
- color
- format
Parent:data[type=table].cells
Type: dataframe column, list, vector
Default: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.
- height
Parent:data[type=table].cells
Type: number
Default:20
The height of cells.
- line
Parent:data[type=table].cells
Type: named list containing one or more of the keys listed below. - prefix
Parent:data[type=table].cells
Type: string or array of stringsPrefix for cell values.
- suffix
Parent:data[type=table].cells
Type: string or array of stringsSuffix for cell values.
- values
Parent:data[type=table].cells
Type: dataframe column, list, vector
Default: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.
- align
- header
Parent:data[type=table]
Type: named list containing one or more of the keys listed below.- align
Parent:data[type=table].header
Type: enumerated or array of enumerateds , one of ("left"
|"center"
|"right"
)
Default:"center"
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.
- fill
Parent:data[type=table].header
Type: named list containing one or more of the keys listed below.- color
Parent:data[type=table].header.fill
Type: color or array of colors
Default:"white"
Sets the cell fill color. It accepts either a specific color or an array of colors or a 2D array of colors.
- color
- font
Parent:data[type=table].header
Type: named list containing one or more of the keys listed below.- color
Parent:data[type=table].header.font
Type: color or array of colors - family
Parent:data[type=table].header.font
Type: string or array of stringsHTML 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".
- lineposition
Parent:data[type=table].header.font
Type: flaglist string. Any combination of"under"
,"over"
,"through"
joined with a"+"
OR"none"
.
Examples:"under"
,"over"
,"under+over"
,"under+over+through"
,"none"
Default:"none"
Sets the kind of decoration line(s) with text, such as an "under", "over" or "through" as well as combinations e.g. "under+over", etc.
- shadow
Parent:data[type=table].header.font
Type: string or array of strings
Default:"none"
Sets the shape and color of the shadow behind text. "auto" places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.
- size
Parent:data[type=table].header.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=table].header.font
Type: enumerated or array of enumerateds , one of ("normal"
|"italic"
)
Default:"normal"
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=table].header.font
Type: enumerated or array of enumerateds , one of ("normal"
|"word caps"
|"upper"
|"lower"
)
Default:"normal"
Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=table].header.font
Type: enumerated or array of enumerateds , one of ("normal"
|"small-caps"
|"all-small-caps"
|"all-petite-caps"
|"petite-caps"
|"unicase"
)
Default:"normal"
Sets the variant of the font.
- weight
Parent:data[type=table].header.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normal
Sets the weight (or boldness) of the font.
- color
- format
Parent:data[type=table].header
Type: dataframe column, list, vector
Default: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.
- height
Parent:data[type=table].header
Type: number
Default:28
The height of cells.
- line
Parent:data[type=table].header
Type: named list containing one or more of the keys listed below. - prefix
Parent:data[type=table].header
Type: string or array of stringsPrefix for cell values.
- suffix
Parent:data[type=table].header
Type: string or array of stringsSuffix for cell values.
- values
Parent:data[type=table].header
Type: dataframe column, list, vector
Default: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.
- align
- hoverlabel
Parent:data[type=table]
Type: named list containing one or more of the keys listed below.- align
Parent:data[type=table].hoverlabel
Type: enumerated or array of enumerateds , one of ("left"
|"right"
|"auto"
)
Default:"auto"
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
- bgcolor
Parent:data[type=table].hoverlabel
Type: color or array of colorsSets the background color of the hover labels for this trace
- bordercolor
Parent:data[type=table].hoverlabel
Type: color or array of colorsSets the border color of the hover labels for this trace.
- font
Parent:data[type=table].hoverlabel
Type: named list containing one or more of the keys listed below.Sets the font used in hover labels.
- color
Parent:data[type=table].hoverlabel.font
Type: color or array of colors - family
Parent:data[type=table].hoverlabel.font
Type: string or array of stringsHTML 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".
- lineposition
Parent:data[type=table].hoverlabel.font
Type: flaglist string. Any combination of"under"
,"over"
,"through"
joined with a"+"
OR"none"
.
Examples:"under"
,"over"
,"under+over"
,"under+over+through"
,"none"
Default:"none"
Sets the kind of decoration line(s) with text, such as an "under", "over" or "through" as well as combinations e.g. "under+over", etc.
- shadow
Parent:data[type=table].hoverlabel.font
Type: string or array of strings
Default:"none"
Sets the shape and color of the shadow behind text. "auto" places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.
- size
Parent:data[type=table].hoverlabel.font
Type: number or array of numbers greater than or equal to 1 - style
Parent:data[type=table].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"
|"italic"
)
Default:"normal"
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Parent:data[type=table].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"
|"word caps"
|"upper"
|"lower"
)
Default:"normal"
Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- variant
Parent:data[type=table].hoverlabel.font
Type: enumerated or array of enumerateds , one of ("normal"
|"small-caps"
|"all-small-caps"
|"all-petite-caps"
|"petite-caps"
|"unicase"
)
Default:"normal"
Sets the variant of the font.
- weight
Parent:data[type=table].hoverlabel.font
Type: integer or array of integers between or equal to 1 and 1000
Default:normal
Sets the weight (or boldness) of the font.
- color
- namelength
Parent:data[type=table].hoverlabel
Type: integer or array of integers greater than or equal to -1
Default:15
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.
- align
- uirevision
Parent:data[type=table]
Type: number or categorical coordinate stringControls 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.