33 KiB
| aliases | description | keywords | labels | title | weight | refs | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Configure options for Grafana's table visualization |
|
|
Table | 100 |
|
Table
Tables are a highly flexible visualization designed to display data in columns and rows. The table visualization can take multiple datasets and provide the option to switch between them. With this versatility, it's the preferred visualization for viewing multiple data types, aiding in your data analysis needs.
You can use a table visualization to show datasets such as:
- Common database queries like logs, traces, metrics
- Financial reports
- Customer lists
- Product catalogs
Any information you might want to put in a spreadsheet can often be best visualized in a table.
Tables also provide different styles to visualize data inside the table cells, such as colored text and cell backgrounds, gauges, sparklines, data links, JSON code, and images.
{{< admonition type="note" >}} Annotations and alerts are not currently supported for tables. {{< /admonition >}}
Configure a table visualization
The following video provides a visual walkthrough of the options you can set in a table visualization. If you want to see a configuration in action, check out the video:
{{< youtube id="PCY7O8EJeJY" >}}
{{< docs/play title="Table Visualizations in Grafana" url="https://play.grafana.org/d/OhR1ID6Mk/" >}}
Supported data formats
The table visualization supports any data that has a column-row structure.
{{< admonition type="note" >}} If you’re using a cell type such as sparkline or JSON, the data requirements may differ in a way that’s specific to that type. For more info refer to Cell type. {{< /admonition >}}
Example
This example shows a basic dataset in which there's data for every table cell:
Column1, Column2, Column3
value1 , value2 , value3
value4 , value5 , value6
value7 , value8 , value9
If a cell is missing or the table column-row structure is not complete, as in the following example, the table visualization won’t display any of the data:
Column1, Column2, Column3
value1 , value2 , value3
gap1 , gap2
value4 , value5 , value6
If you need to hide columns, you can do so using data transformations, field overrides, or by building a query that returns only the needed columns.
Column filtering
You can temporarily change how column data is displayed using column filtering. For example, you can show or hide specific values.
Turn on column filtering
To turn on column filtering, follow these steps:
- In Grafana, navigate to the dashboard with the table with the columns that you want to filter.
- Hover over any part of the panel to which you want to add the link to display the actions menu on the top right corner.
- Click the menu and select Edit.
- In the panel editor pane, expand the Table options section.
- Toggle on the Column filter switch.
A filter icon (funnel) appears next to each column title.
{{< figure src="/static/img/docs/tables/column-filter-with-icon.png" max-width="350px" alt="Column filtering turned on" class="docs-image--no-shadow" >}}
Filter column values
To filter column values, follow these steps:
-
Click the filter icon (funnel) next to a column title.
Grafana displays the filter options for that column.
{{< figure src="/media/docs/grafana/panels-visualizations/filter-column-values_12.2.png" max-width="300px" alt="Filter column values" >}}
-
Click the checkbox next to the values that you want to display or click Select all.
-
Enter text in the search field at the top to show those values in the display so that you can select them rather than scroll to find them.
-
Choose from several operators to display column values:
- Contains - Matches a regex pattern (operator by default).
- Expression - Evaluates a boolean expression. The character
$represents the column value in the expression (for example, ">= 10 &&<= 12"). - The typical comparison operators:
=,!=,<,<=,>,>=.
-
Click the checkbox above the Ok and Cancel buttons to add or remove all displayed values to and from the filter.
Clear column filters
Columns with filters applied have a blue filter displayed next to the title.
{{< figure src="/static/img/docs/tables/filtered-column.png" max-width="100px" alt="Filtered column" class="docs-image--no-shadow" >}}
To remove the filter, click the blue filter icon and then click Clear filter.
Sort columns
Click a column title to change the sort order from default to descending to ascending.
Each time you click, the sort order changes to the next option in the cycle.
You can sort multiple columns by holding the Cmd or Ctrl key
and clicking the column name.
{{< figure src="/static/img/docs/tables/sort-descending.png" max-width="350px" alt="Sort descending" class="docs-image--no-shadow" >}}
Dataset selector
If the data queried contains multiple datasets, a table displays a drop-down list at the bottom, so you can select the dataset you want to visualize. This option is only available when you're editing the panel.
{{< figure src="/media/docs/grafana/panels-visualizations/screenshot-table-multi-dataset-v11.3.png" max-width="650px" alt="Table visualization with multiple datasets" >}}
Configuration options
Panel options
{{< docs/shared lookup="visualizations/panel-options.md" source="grafana" version="<GRAFANA_VERSION>" >}}
Table options
| Option | Description |
|---|---|
| Show table header | Show or hide column names imported from your data source. |
| Frozen columns | Freeze columns starting from the left side of the table. Enter a value to set how many columns are frozen. |
| Cell height | Set the height of the cell. Choose from Small, Medium, or Large. |
| Enable pagination | Toggle the switch to control how many table rows are visible at once. When switched on, the page size automatically adjusts to the height of the table. This option doesn't affect queries. |
| Minimum column width | Define the lower limit of the column width, in pixels. By default, the minimum width of the table column is 150 pixels. For small-screen devices, such as mobile phones or tablets, reduce the value to 50 to allow table-based panels to render correctly in dashboards. |
| Column width | Define a column width, in pixels, rather than allowing the width to be set automatically. By default, Grafana calculates the column width based on the table size and the minimum column width. |
| Column alignment | Set how Grafana should align cell contents. Choose from: Auto (default), Left, Center, or Right. |
| Column filter | Temporarily change how column data is displayed. For example, show or hide specific values. For more information, refer to Column filtering. |
| Wrap header text | Enables text wrapping for column headers. |
Table footer options
Toggle the Show table footer switch on and off to control the display of the footer. When the toggle is switched on, you can use the table footer to show calculations on fields.
After you activate the table footer, make selections for the following options:
- Calculation - The calculation that you want to apply.
- Count rows - This option is displayed if you select the Count calculation. If you want to show the number of rows in the dataset instead of the number of values in the selected fields, toggle on the Count rows switch.
- Fields - The fields to which you want to apply the calculation. Grafana applies the calculation to all numeric fields if you don't select a field.
Cell options
Cell options allow you to control how data is displayed in a table. The options are differ based on the cell type that you select and are outlined within the descriptions of each cell type. The following table provides short descriptions for each cell type and links to a longer description and the cell type options.
Cell type
By default, Grafana automatically chooses display settings. You can override these settings by choosing one of the following cell types to control the default display for all fields. Additional configuration is available for some cell types.
If you want to apply a cell type to only some fields instead of all fields, you can do so using the Cell options > Cell type field override.
| Cell type | Description |
|---|---|
| Auto | A basic text and number cell. |
| Colored text | If thresholds, value mappings, or color schemes are set, then the cell text is displayed in the appropriate color. |
| Colored background | If thresholds, value mappings, or color schemes are set, then the cell background is displayed in the appropriate color. |
| Data links | The cell text reflects the titles of the configured data links. |
| Gauge | Values are displayed as a horizontal bar gauge. You can set the Gauge display mode and the Value display options. |
| Sparkline | Shows values rendered as a sparkline. |
| JSON View | Shows values formatted as code. |
| Pill | Displays each item in a comma-separated string in a colored block. |
| Markdown + HTML | Displays rich markdown or HTML content. |
| Image | Displays an image when the value is a URL or a base64 encoded image. |
| Actions | The cell displays a button that triggers a basic, unauthenticated API call when clicked. |
Auto
This is a basic text and number cell.
It has the following cell options:
{{< docs/shared lookup="visualizations/cell-options.md" source="grafana" version="<GRAFANA_VERSION>" >}}
Colored text
If thresholds, value mappings, or color schemes are set, the cell text is displayed in the appropriate color.
The colored text cell type has the following options:
{{< docs/shared lookup="visualizations/cell-options.md" source="grafana" version="<GRAFANA_VERSION>" >}}
Colored background
If thresholds, value mappings, or color schemes are set, the cell background is displayed in the appropriate color.
You can also set background cell color by row:
The colored background cell type has the following options:
| Option | Description |
|---|---|
| Background display mode | Choose between Basic and Gradient. |
| Apply to entire row | Toggle the switch on to apply the background color that's configured for the cell to the whole row. |
| Wrap text | Toggle the Wrap text switch to wrap text in the cell that contains the longest content in your table. To wrap the text in a specific column only, use a Fields with name field override, select the Cell options > Cell type override property, and toggle on the Wrap text switch. |
| Cell value inspect | Enables value inspection from table cells. When the switch is toggled on, clicking the inspect icon in a cell opens the Inspect value drawer which contains two tabs: Plain text and Code editor. Grafana attempts to automatically detect the type of data in the cell and opens the drawer with the associated tab showing. However, you can switch back and forth between tabs. |
| Tooltip from field | Toggle on the Tooltip from field switch to use the values from another field (or column) in a tooltip. For more information, refer to the Tooltip from field. |
Data links
If you've configured data links, when the cell type is Auto, the cell text becomes clickable. If you change the cell type to Data links, the cell text reflects the titles of the configured data links. To control the application of data link text more granularly, use a Cell option > Cell type > Data links field override.
Data links cells also support text wrapping. Toggle the Wrap text switch to wrap text in the cell that contains the longest content in your table. To wrap the text in a specific column only, use a Fields with name field override, select the Cell options > Cell type override property, and toggle on the Wrap text switch.
Gauge
With this cell type, cells can be displayed as a graphical gauge, with several different presentation types.
The gauge cell type has the following options:
| Option | Description |
|---|---|
| Gauge display mode | Controls the type of gauge used. For more information, refer to the Gauge display mode. |
| Value display | Controls how the value is displayed. For more information, refer to the Value display. |
| Tooltip from field | Toggle on the Tooltip from field switch to use the values from another field (or column) in a tooltip. For more information, refer to Tooltip from field. |
{{< admonition type="note" >}} The maximum and minimum values of the gauges are configured automatically from the smallest and largest values in your whole dataset. If you don't want the max/min values to be pulled from the whole dataset, you can configure them for each column using field overrides. {{< /admonition >}}
Gauge display mode
You can set three gauge display modes.
| Option | Description |
|---|---|
| Basic | Shows a simple gauge with the threshold levels defining the color of gauge. {{< figure src="/media/docs/grafana/panels-visualizations/screenshot-gauge-mode-basic-v11.3.png" alt="Table cell with basic gauge mode" >}} |
| Gradient | The threshold levels define a gradient. {{< figure src="/media/docs/grafana/panels-visualizations/screenshot-gauge-mode-gradient-v11.3.png" alt="Table cell with gradient gauge mode" >}} |
| Retro LCD | The gauge is split up in small cells that are lit or unlit. {{< figure src="/media/docs/grafana/panels-visualizations/screenshot-gauge-mode-retro-v11.3.png" alt="Table cell with retro LCD gauge mode" >}} |
Value display
Labels displayed alongside of the gauges can be set to be colored by value, match the theme text color, or be hidden.
| Option | Description |
|---|---|
| Value color | Labels are colored by value. {{< figure src="/media/docs/grafana/panels-visualizations/screenshot-labels-value-color-v11.3.png" alt="Table with labels in value color" >}} |
| Text color | Labels match the theme text color. {{< figure src="/media/docs/grafana/panels-visualizations/screenshot-labels-text-color-v11.3.png" alt="Table with labels in theme color" >}} |
| Hidden | Labels are hidden. {{< figure src="/media/docs/grafana/panels-visualizations/screenshot-labels-hidden-v11.3.png" alt="Table with labels hidden" >}} |
Sparkline
This cell type shows values rendered as a sparkline. To show sparklines on data with multiple time series, use the Time series to table transformation to process it into a format the table can show.
The sparkline cell type options are described in the following table. For more detailed information about all of the sparkline styling options (except Hide value), refer to the time series graph styles documentation.
| Option | Description |
|---|---|
| Hide value | Toggle the switch on or off to display or hide the cell value on the sparkline. |
| Style | Choose whether to display your time-series data as Lines, Bars, or Points. You can use overrides to combine multiple styles in the same graph. |
| Line interpolation | How the graph interpolates the series line. Choose from:
|
| Line width | The thickness of the series lines or the outline for bars using the Line width slider. |
| Fill opacity | The series area fill color using the Fill opacity slider. |
| Gradient mode | Gradient mode controls the gradient fill, which is based on the series color. Gradient appearance is influenced by the Fill opacity setting. To change the color, use the standard color scheme field option. For more information, refer to Color scheme. Choose from:
|
| Line style | Choose from:
|
| Connect null values | How null values, which are gaps in the data, appear on the graph. Null values can be connected to form a continuous line or set to a threshold above which gaps in the data are no longer connected. Choose from:
|
| Show points | Whether to show data points to lines or bars. Choose from:
|
| Point size | Set the size of the points, from 1 to 40 pixels in diameter. |
| Bar alignment | Set the position of the bar relative to a data point. |
| Tooltip from field | Toggle on the Tooltip from field switch to use the values from another field (or column) in a tooltip. For more information, refer to Tooltip from field. |
JSON View
This cell type shows values formatted as code. If a value is an object the JSON view allowing browsing the JSON object will appear on hover.
{{< figure src="/static/img/docs/tables/json-view.png" max-width="350px" alt="JSON view" class="docs-image--no-shadow" >}}
For the JSON view cell type, you can set enable Cell value inspect. This enables value inspection from table cells. When the switch is toggled on, clicking the inspect icon in a cell opens the Inspect value drawer which contains two tabs: Plain text and Code editor.
Toggle on the Tooltip from field switch to use the values from another field (or column) in a tooltip. For more information, refer to Tooltip from field.
Grafana attempts to automatically detect the type of data in the cell and opens the drawer with the associated tab showing. However, you can switch back and forth between tabs.
Pill
The Pill cell type displays each item in a comma-separated string in a colored block.
{{< figure src="/media/docs/grafana/panels-visualizations/screenshot-table-pills-v12.1.png" max-width="750px" alt="Table using the pill cell type" >}}
The colors applied to each piece of text are maintained throughout the table. For example, if the word "test" is first displayed in a red pill, it will always be displayed in a red pill.
Pill cells also support text wrapping. Toggle the Wrap text switch to wrap text in the cell that contains the longest content in your table. To wrap the text in a specific column only, use a Fields with name field override, select the Cell options > Cell type override property, and toggle on the Wrap text switch.
The following data formats are supported for the pill cell type:
- Comma-separated values (
cows,chickens,goats) - JSON arrays of uniform (
(["cows","chickens","goats"])) or mixed ([1,2,3,"foo",42,"bar"]) types
Toggle on the Tooltip from field switch to use the values from another field (or column) in a tooltip. For more information, refer to Tooltip from field.
Markdown + HTML
The Markdown + HTML cell type displays rich Markdown or HTML content, rendered using the GitHub-Flavored Markdown spec. This is useful if you need to display customized, pre-formatted information alongside tabular data, such as formatted strings, lists of links, or other dynamic cases.
For this cell type, you can toggle the Dynamic height switch, which allows the cell to resize dynamically based on the cell content. If you use dynamic height, we strongly recommend that you also toggle on Pagination to avoid performance issues in larger tables, since enabling Dynamic height disables table {{< term "virtualization" >}}virtualization{{< /term >}}.
By default, the HTML rendered is sanitized, and un-sanitized HTML can only be rendered
in these cells if the disable_sanitize_html option is set to true for your Grafana instance.
Toggle on the Tooltip from field switch to use the values from another field (or column) in a tooltip. For more information, refer to Tooltip from field.
Image
If you have a field value that is an image URL or a base64 encoded image, this cell type displays it as an image.
It has the following options:
| Option | Description |
|---|---|
| Alt text | Set the alternative text of an image. The text will be available for screen readers and in cases when images can't be loaded. |
| Title text | Set the text that's displayed when the image is hovered over with a cursor. |
| Tooltip from field | Toggle on the Tooltip from field switch to use the values from another field (or column) in a tooltip. For more information, refer to Tooltip from field. |
Actions
The cell displays a button that triggers a basic, unauthenticated API call when clicked. Configure the API call with the following options:
| Option | Description |
|---|---|
| Endpoint | Enter the endpoint URL. |
| Method | Choose from GET, POST, and PUT. |
| Content-Type | Select an option in the drop-down list. Choose from: JSON, Text, JavaScript, HTML, XML, and x-www-form-urlencoded. |
| Query parameters | Enter as many Key, Value pairs as you need. |
| Header parameters | Enter as many Key, Value pairs as you need. |
| Payload | Enter the body of the API call. |
| Tooltip from field | Toggle on the Tooltip from field switch to use the values from another field (or column) in a tooltip. For more information, refer to Tooltip from field. |
Tooltip from field
Toggle on the Tooltip from field switch to use the values from another field (or column) in a tooltip.
When you toggle the switch on, you can select from a drop-down list any of the fields in the table to be used as the source of the tooltip content. All table fields are included in the drop-down list, whether visible or hidden.
When a tooltip from a field has been added to a cell, a chip is displayed in the top-right or top-left corner of the cell:
{{< figure src="/media/docs/grafana/panels-visualizations/screenshot-tooltip-chip-1-v12.2.png" max-width="500px" alt="Tooltip chip" >}}
Hover your mouse over the chip to display the tooltip.
When you toggle on the switch, the Tooltip placement option, which controls where the tooltip box opens upon hover, is also displayed. Select one of the following options: Auto, Top, Right, Bottom, and Left.
The content of the tooltip is determined by the values of the source field and can't be directly edited. However, you can affect the display of the value using overrides like value mappings, as shown in the Example: Tooltip from field with value mappings section.
While you can turn on this option under Cell options, and have it applied to all cells in the table, it's typically used as an override on a sub-set of cells instead. This is demonstrated in the example in the following section.
Example: Tooltip from field using overrides
The following table has five visible fields (columns) as well as a hidden field called "Info":
{{< figure src="/media/docs/grafana/panels-visualizations/screenshot-tooltip-table-1-v12.2.png" max-width="750px" alt="Table that includes a hidden column" >}}
- The "Info" field is hidden using the Table > Hide in table override property.
- The following overrides have been applied to the "Short text" field:
- The values from the "Info" field are used as tooltip text for the "Short text" cells using the Cell options > Tooltip from field override property.
- The Cell options > Tooltip placement override property is set to control the placement of the tooltip.
{{< figure src="/media/docs/grafana/panels-visualizations/screenshot-tooltip-override-2-v12.2.png" max-width="300px" alt="Override to use the Info field values as tooltips for the Short text column" >}}
Now, when you hover the cursor over the chip in the "Short text" column, the corresponding values from the "Info" column appear in the tooltip:
{{< figure src="/media/docs/grafana/panels-visualizations/screenshot-tooltip-on-hover-v12.2.png" max-width="750px" alt="Info field value in the tooltip of the Short text cell upon hover" >}}
Example: Tooltip from field with value mappings
While the content of the tooltip is determined by the values of the source field and can't be directly edited, you can use field overrides on the source field to manipulate the display of that value.
For example, if the "Info" column is being used as the source field for the tooltip values, you could set up a value mapping. In this case, the value "up" is mapped to the word "Good":
{{< figure src="/media/docs/grafana/panels-visualizations/screenshot-tooltip-value-map-v12.2.png" max-width="750px" alt="Info field value up being mapped to the value Good in an override" >}}
Now, when you hover the cursor over the chip in the "Short text" cell, the mapped value appears in the tooltip:
{{< figure src="/media/docs/grafana/panels-visualizations/screenshot-tooltip-on-hover-2-v12.2.png" max-width="750px" alt="Info field mapped to a new value in the tooltip of the Short text cell upon hover" >}}
You can use all field overrides to affect the display of the tooltip. For example, the Table > Column width or Cell options > Cell type overrides can change the cell width or visual display of the data.
Standard options
{{< docs/shared lookup="visualizations/standard-options.md" source="grafana" version="<GRAFANA_VERSION>" >}}
Data links and actions
{{< docs/shared lookup="visualizations/datalink-options-3.md" source="grafana" version="<GRAFANA_VERSION>" >}}
Value mappings
{{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="<GRAFANA_VERSION>" >}}
Thresholds
{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="<GRAFANA_VERSION>" >}}
Field overrides
{{< docs/shared lookup="visualizations/overrides-options.md" source="grafana" version="<GRAFANA_VERSION>" >}}