Skip to content

Commit 236d64d

Browse files
authored
Add Note element (#104)
1 parent d9470ce commit 236d64d

File tree

4 files changed

+34
-0
lines changed

4 files changed

+34
-0
lines changed

dashboard-elements/note.mdx

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: 'Note'
3+
description: 'This section explains how to create note dashboard elements and add them to your dashboard.'
4+
sidebarTitle: Note
5+
tags:
6+
['axiom documentation', 'documentation', 'axiom', 'dashboards', 'collaboration', 'queries', 'visualizations', 'filters', 'charts', 'simple query builder', 'advanced query builder']
7+
---
8+
9+
import Prerequisites from "/snippets/dashboard-minimal-prerequisites.mdx"
10+
11+
The note dashboard element adds a textbox to your dashboard that you can customise to your needs. For example, you can provide context in a note about the other dashboard elements.
12+
13+
<Prerequisites />
14+
15+
## Create note
16+
17+
1. Go to the Dashboards tab and open the dashboard where you want to add the {elementName}.
18+
1. Click <img src="/doc-assets/icons/plus.svg" className="inline-icon" alt="Add chart" /> **Add chart** in the top right corner.
19+
1. Click **Note** from the list.
20+
1. Enter your text on the left in [GitHub Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) format. You see the preview of the note dashboard element on the right.
21+
1. Click **Save**.
22+
23+
The new element appears in your dashboard. In the bottom, click **Save** to save your changes to the dashboard.

dashboard-elements/overview.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@ Choose one of the following to learn more about a dashboard element:
2222
href="/dashboard-elements/log-stream"
2323
>
2424
</Card>
25+
<Card
26+
title="Note"
27+
icon="note-sticky"
28+
href="/dashboard-elements/note"
29+
>
30+
</Card>
2531
<Card
2632
title="Pie chart"
2733
icon="chart-pie"

mint.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,7 @@
187187
"dashboard-elements/configure",
188188
"query-data/filters",
189189
"dashboard-elements/log-stream",
190+
"dashboard-elements/note",
190191
"dashboard-elements/pie-chart",
191192
"dashboard-elements/scatter-plot",
192193
"dashboard-elements/statistic",
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
## Prerequisites
2+
3+
- [Create an Axiom account](https://app.axiom.co/register).
4+
- [Create an empty dashboard](/dashboards/create).

0 commit comments

Comments
 (0)