Skip to content

Commit

Permalink
chore: update docs dashboard
Browse files Browse the repository at this point in the history
  • Loading branch information
corteggiano committed May 29, 2024
1 parent 0c3f3ef commit ac7b42c
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions packages/doc-site/stories/components/dashboard/Docs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,21 @@ Type: Object

The `dashboardConfiguration` contains the following properties:

---
#### - `defaultViewport` (optional, object):

Specifies the time interval that the dashboard will initially visualize. If not provided, the dashboard will utilize the viewport specified by its ViewportManager. If there is no ViewportManager and no viewport defined, the default viewport will be set to `last 5 minutes`

[Learn more about the viewport](/docs/core-viewport--docs).

---

#### - `viewport` (optional, object) (⛔️ Deprecated)

Specifies the time interval that the dashboard will visualize. If not provided, the dashboard will utilize the viewport specified by its ViewportManager. If there is no ViewportManager and no viewport defined, the default viewport will be calculated based on the minimum and maximum dates in the data.

[Learn more about the viewport](/docs/core-viewport--docs).

---

#### - `displaySettings`
Expand All @@ -84,15 +99,11 @@ The `displaySettings` contains the following properties:

Type: number

---

- `numColumns`
The number of columns that make up the grid. Each column will have a width as specified by `cellSize`.

Type: number

---

- `cellSize`
(Optional) The size which cell represents in pixels. i.e. if the cell size is 20, then each "cell" in the grid is 20px by 20px.
Defaults to 10.
Expand Down

0 comments on commit ac7b42c

Please sign in to comment.