Skip to content

Commit 6df9a36

Browse files
Create documentation for the Show Symbols option (#99)
* create trellis layout documentation * update the /config folder under /dashboards * update Trellis Layout doc with metadata * fix Trellis Layout page formatting issues * create the Show Symbol documentation * update the Show Symbol doc
1 parent 18cd40a commit 6df9a36

File tree

5 files changed

+52
-2
lines changed

5 files changed

+52
-2
lines changed

docs/images/show-symbol-no.png

109 KB
Loading

docs/images/show-symbol-yes.png

127 KB
Loading
Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
nav:
22

33
- Config Overview: index.md
4-
- Trellis Layout: trellis-layout.md
4+
- Trellis Layout: trellis-layout.md
5+
- Show Symbol: show-symbol.md
6+

docs/user-guide/dashboards/config/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@ The Config tab in OpenObserve dashboards allows users to customize the behavior,
22

33
Learn more:
44

5-
- [Trellis Layout](../config/trellis-layout/)
5+
- [Trellis Layout](../config/trellis-layout/)
6+
- [Show Symbol](../config/show-symbol/)
7+
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Show Symbol Option in OpenObserve Dashboards
3+
description: Learn how to configure the Show Symbol option in supported chart types to display or hide data point markers in OpenObserve dashboards.
4+
---
5+
This guide describes how to use the **Show Symbol** option in OpenObserve dashboards to display or hide data point markers in supported chart types. This setting improves visual clarity when analyzing time-series data by highlighting values along a plotted line or area.
6+
7+
## Supported Chart Types
8+
The **Show Symbol** setting is available only for the following chart types:
9+
10+
- Line
11+
- Area
12+
- Area Stacked
13+
14+
---
15+
16+
## Configure the Show Symbol Option
17+
To configure the **Show Symbol** option:
18+
19+
1. In the **Panel Editor**, select a supported chart type.
20+
2. Expand the **Config** section on the right side of the screen.
21+
3. Locate the **Show Symbol** dropdown.
22+
4. From the **Show Symbol** dropdown, select Yes or No:
23+
24+
- When you select **Yes**, each data point is marked with a small circle for clear identification.
25+
![Show symbol](../../../images/show-symbol-yes.png)
26+
- When you select **No**, the chart renders a continuous line or area without individual point markers.
27+
![Do not show symbol](../../../images/show-symbol-no.png)
28+
29+
---
30+
31+
## Default Behavior and Environment Variable
32+
The default selection of the **Show Symbol** dropdown is determined by the following environment variable:
33+
34+
```bash
35+
ZO_DASHBOARD_SHOW_SYMBOL_ENABLED=false # default
36+
```
37+
38+
- When set to **true**, the **Show Symbol** dropdown defaults to **Yes**.
39+
- When set to **false**, the **Show Symbol** dropdown defaults to **No**.
40+
41+
> This setting only controls the default state of the **Show Symbol** dropdown. Users can manually change the setting regardless of the environment variable value.
42+
43+
---
44+
45+
## Limitations
46+
The **Show Symbol** option is supported only in **Line**, **Area**, and **Area Stacked** charts. It is not available for any other chart types in dashboard panels. If a different chart type is selected, the **Show Symbol** option will not appear in the configuration panel.

0 commit comments

Comments
 (0)