|
4 | 4 | [](LICENSE) |
5 | 5 |
|
6 | 6 | ## Overview / Introduction |
| 7 | + |
7 | 8 | **Compass** is a Grafana visualization plugin for displaying heading or orientation data on a compass dial. |
8 | 9 | It is especially useful for ship navigation, robotics, UAVs, or any time-series data representing direction in degrees (0–360). |
9 | 10 | Optionally the panel can display true and/or apparent wind angle. |
@@ -42,56 +43,61 @@ Optionally the panel can display true and/or apparent wind angle. |
42 | 43 | ## Options |
43 | 44 |
|
44 | 45 | ### Data Options |
| 46 | + |
45 | 47 | - **Heading Field**: Select the numeric field in your series that represents heading in degrees. |
46 | 48 |
|
47 | 49 | ### Display Options |
| 50 | + |
48 | 51 | - **Show Labels**: Toggle cardinal direction labels (N/E/S/W). |
49 | 52 | - **Show Numeric Heading**: Display a numeric degree readout below the compass. |
50 | 53 |
|
51 | 54 | ### Needle Options |
52 | | -- **Needle Type** |
53 | | - - `Default` – red-tipped classic compass needle |
54 | | - - `Arrow` – stylized arrow needle |
55 | | - - `Ship` – simplified vessel silhouette (points to heading) |
56 | | - - `SVG` – load a custom vector (provide URL or relative path) |
| 55 | + |
| 56 | +- **Needle Type** |
| 57 | + |
| 58 | + - `Default` – red-tipped classic compass needle |
| 59 | + - `Arrow` – stylized arrow needle |
| 60 | + - `Ship` – simplified vessel silhouette (points to heading) |
| 61 | + - `SVG` – load a custom vector (provide URL or relative path) |
57 | 62 | - `PNG` – load a custom image (provide URL or relative path) |
58 | 63 |
|
59 | | -- **Needle Color**: Color of the primary needle. |
60 | | -- **Tail Color**: Color of the tail (for default needle). |
61 | | -- **Custom SVG**: Path/URL to your own SVG asset. |
62 | | -- **Custom PNG**: Path/URL to your own PNG asset. |
| 64 | +- **Needle Color**: Color of the primary needle. |
| 65 | +- **Tail Color**: Color of the tail (for default needle). |
| 66 | +- **Custom SVG**: Path/URL to your own SVG asset. |
| 67 | +- **Custom PNG**: Path/URL to your own PNG asset. |
63 | 68 |
|
64 | 69 | ### Colors |
65 | | -- **Dial Color** – background of compass dial. |
66 | | -- **Bezel Color** – outer rim. |
67 | | -- **Text Color** – labels, ticks, numeric heading. |
68 | | -- **True Wind Color**: Color of the true wind indicator. |
69 | | -- **Apparent Wind Color**: Color of the apparent wind indicator. |
70 | 70 |
|
| 71 | +- **Dial Color** – background of compass dial. |
| 72 | +- **Bezel Color** – outer rim. |
| 73 | +- **Text Color** – labels, ticks, numeric heading. |
| 74 | +- **True Wind Color**: Color of the true wind indicator. |
| 75 | +- **Apparent Wind Color**: Color of the apparent wind indicator. |
71 | 76 |
|
72 | 77 | --- |
73 | 78 |
|
74 | 79 | ## Screenshots |
| 80 | + |
75 | 81 |  |
76 | 82 |
|
77 | | -*Arrow needle with labels and numeric heading enabled* |
| 83 | +_Arrow needle with labels and numeric heading enabled_ |
78 | 84 |
|
79 | 85 |  |
80 | 86 |
|
81 | | -*Arrow needle with labels and numeric heading enabled* |
| 87 | +_Arrow needle with labels and numeric heading enabled_ |
82 | 88 |
|
83 | 89 |  |
84 | 90 |
|
85 | | -*Ship silhouette needle for vessel heading visualization* |
| 91 | +_Ship silhouette needle for vessel heading visualization_ |
86 | 92 |
|
87 | 93 |  |
88 | 94 |
|
89 | | -*Standard needle compass with custom styling* |
| 95 | +_Standard needle compass with custom styling_ |
90 | 96 |
|
91 | 97 |  |
92 | 98 |
|
93 | | -*North up orientation for wind dial visualization* |
| 99 | +_North up orientation for wind dial visualization_ |
94 | 100 |
|
95 | 101 |  |
96 | 102 |
|
97 | | -*Bow up orientation for wind dial visualization* |
| 103 | +_Bow up orientation for wind dial visualization_ |
0 commit comments