Skip to content

Commit 9fef8f2

Browse files
github-actions[bot]prabhatsharma
authored andcommitted
docs: dashboard-table-column-formatting — openobserve PR #12531
docgen-source: openobserve/openobserve#12531
1 parent 5bcbb65 commit 9fef8f2

7 files changed

Lines changed: 130 additions & 0 deletions
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
nav:
22

33
- Panels Overview: index.md
4+
- Table Chart: table-chart.md
45
- Manage Panels: panel-management.md
56
- Troubleshooting: troubleshooting.md
165 KB
Loading
89.3 KB
Loading
97 KB
Loading
112 KB
Loading
89.8 KB
Loading
Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
# Table Chart
2+
3+
Table chart panels display query results as a tabular view, with support for per-column formatting, Excel-style column filtering, and pagination.
4+
5+
## Configure column formatting
6+
7+
Column formatting lets you override the appearance of individual columns in a table panel — change value units, set text and background colors, control alignment, and define conditional styling rules.
8+
9+
To open the Column Formatting dialog:
10+
11+
1. Open a dashboard panel with type **Table**.
12+
2. In the panel **Config** sidebar, locate the **Field Overrides** section.
13+
3. Click the **Configure column formatting** button.
14+
15+
![Config panel showing the Configure column formatting button in Field Overrides section](images/dashboard-table-column-formatting-1.png)
16+
17+
### Add a field
18+
19+
On first open, the dialog shows an empty state with an **Add field** button. Click it to see a dropdown of the panel's columns, each marked with a **NUM** or **TEXT** badge to indicate its detected data type.
20+
21+
![Column Formatting dialog empty state with Add field dropdown](images/dashboard-table-column-formatting-2.png)
22+
23+
Select a column to add it to the formatting list. The dialog switches to a three-pane layout:
24+
25+
- **Left pane** — list of all fields you have added, with type badges and a hover-to-remove **X** button. Click a field to select it.
26+
- **Middle pane** — formatting controls for the selected field.
27+
- **Right pane** — a live preview of the column rendered with your current settings.
28+
29+
![Column Formatting dialog with a field selected, showing the three-pane layout](images/dashboard-table-column-formatting-3.png)
30+
31+
### Formatting controls
32+
33+
The controls available for each field depend on its field type.
34+
35+
#### Field Type
36+
37+
Choose how the column's data type is interpreted:
38+
39+
- **Auto** — detect from the data (columns from Y-axis fields are numeric; X-axis and breakdown fields are text).
40+
- **Num** — force numeric interpretation, enabling value formatting and conditional styling.
41+
- **Text** — force text interpretation; value formatting and conditional styling are hidden.
42+
43+
#### Value Formatting
44+
45+
Available when the field type is numeric. Select a unit from the dropdown:
46+
47+
- **Default** — inherit the panel-level unit.
48+
- **Numbers** — display raw numbers.
49+
- **Locale Format** — use locale-aware number formatting.
50+
- **Bytes**, **Kilobytes**, **Megabytes** — data size units.
51+
- **Bytes per Second** — throughput.
52+
- **Seconds**, **Milliseconds**, **Microseconds**, **Nanoseconds** — duration units.
53+
- **Percent (0-1)**, **Percent (0-100)** — percentage units.
54+
- **Currency (Dollar)**, **Currency (Euro)**, **Currency (Pound)**, **Currency (Yen)**, **Currency (Rupees)** — currency units.
55+
- **Custom** — enter a custom unit suffix.
56+
57+
When **Custom** is selected, a text input appears for the custom unit label.
58+
59+
#### Alignment
60+
61+
Set the column's text alignment:
62+
63+
- **Auto** — default alignment based on type (right for numeric, left for text).
64+
- **Left**, **Center**, **Right** — explicit alignment.
65+
66+
#### Styling
67+
68+
- **Text color** — pick a color from the preset swatches, or use the rainbow picker for a custom color. The **X** button resets to no override.
69+
- **Background color** — same swatch-based picker for the cell background.
70+
- **Unique value color** — when enabled, each distinct value in the column gets a unique color from the chart palette, applied as the cell background.
71+
72+
#### Conditional Styling
73+
74+
Available when the field type is numeric. Define threshold rules that change cell colors based on the value.
75+
76+
Each rule reads as a sentence:
77+
78+
**If value** `[operator]` `[threshold]` **then** text color / background color.
79+
80+
Supported operators: `<`, `>`, `<=`, `>=`, `=`, `!=`.
81+
82+
Rules are evaluated in order; when multiple rules match a value, the **last matching rule** wins. This lets you layer conditions — for example, a rule for values `> 400` (amber) followed by one for `> 1000` (red) means values above 1000 will show red, not amber.
83+
84+
![conditional styling section with multiple rules defined](images/dashboard-table-column-formatting-4.png)
85+
86+
Click **Add rule** to create a new condition, or the **X** button on a rule to remove it.
87+
88+
### Save or cancel
89+
90+
The dialog footer shows a count of configured fields. Click **Save** to apply the formatting or **Cancel** to discard changes.
91+
92+
Formatting settings are persisted with the dashboard and survive page reloads.
93+
94+
## Column filtering
95+
96+
Column filtering provides Excel-style dropdowns in table column headers, letting you filter the visible rows by one or more distinct column values.
97+
98+
![a table panel with column filter dropdown open showing checkbox list](images/dashboard-table-column-formatting-5.png)
99+
100+
### Enable column filtering
101+
102+
1. Open a dashboard panel with type **Table**.
103+
2. In the panel **Config** sidebar, under the **Table** section, toggle **Table Filtering**.
104+
105+
Once enabled, a filter icon appears in each column header. Click it to open the filter panel for that column.
106+
107+
### Use column filtering
108+
109+
The filter panel contains:
110+
111+
- **Search** — filter the list of unique values shown in the panel.
112+
- **Checkbox list** — each distinct value in the column is listed as a checkbox. Check values to include in the table; only rows matching at least one checked value are shown.
113+
- **Clear filter** — resets the selection and shows all rows.
114+
115+
When a column has an active filter, its filter icon turns blue to indicate the column is filtered. Filters are applied client-side and do not trigger a new query.
116+
117+
## Configuration reference
118+
119+
The following panel config fields control table chart behavior:
120+
121+
| Field | Type | Default | Description |
122+
|-------|------|---------|-------------|
123+
| `table_filtering` | boolean | `false` | Enables per-column filter dropdowns. |
124+
| `table_pagination` | boolean | `false` | Enables paginated mode (turns off virtual scroll). |
125+
| `table_pagination_rows_per_page` | number || Rows per page when pagination is enabled. |
126+
| `wrap_table_cells` | boolean | `false` | Wraps long text in cells instead of truncating. |
127+
| `table_transpose` | boolean | `false` | Transposes the table (swap rows and columns). |
128+
| `table_dynamic_columns` | boolean | `false` | Shows only columns present in the data. |
129+
| `override_config` | array | `[]` | Per-column formatting rules (set via the Column Formatting dialog). |

0 commit comments

Comments
 (0)