Skip to content

feat: add documentation about timezone feature #120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
CBID2 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat: add documentation about timezone feature #120

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions packages/ui-kit/src/components/TimeSeries/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,15 +93,16 @@ The following table describes the props available for the Time Series component:

### `query` sub props

| **Name** | **Type** | **Required** | **Default** | **Description** |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------ | ----------- | --------------------------------------------------------------------------------------------------- |
| accessToken | `string` | **Yes** | `undefined` | You account's access token |
| metric | `string` | **Yes** | `undefined` | Metric unique name |
| timeRange | [TimeRangeInput](https://studio.apollographql.com/graph/Propel-API/schema/reference/inputs/TimeRangeInput?variant=production) | **Yes** | `undefined` | Time range that the chart will respond to |
| granularity | `string` | **No** | `undefined` | Granularity that the chart will respond to |
| filters | Array<[FilterInput](https://studio.apollographql.com/graph/Propel-API/schema/reference/inputs/FilterInput?variant=production)> | **No** | `undefined` | Filters that the chart will respond to |
| propeller | [Propeller](https://studio.apollographql.com/graph/Propel-API/schema/reference/enums/Propeller?variant=production) | **No** | `undefined` | Propeller that the chart will respond to |
| timestampFormat | `ISO 8601` | **No** | `"MM/dd"` | A string representing the format of the timestamps in the data. Default value is ISO 8601 timestamp |
| **Name** | **Type** | **Required** | **Default** | **Description** |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------ | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| accessToken | `string` | **Yes** | `undefined` | You account's access token |
| metric | `string` | **Yes** | `undefined` | Metric unique name |
| timeRange | [TimeRangeInput](https://studio.apollographql.com/graph/Propel-API/schema/reference/inputs/TimeRangeInput?variant=production) | **Yes** | `undefined` | Time range that the chart will respond to |
| granularity | `string` | **No** | `undefined` | Granularity that the chart will respond to |
| filters | Array<[FilterInput](https://studio.apollographql.com/graph/Propel-API/schema/reference/inputs/FilterInput?variant=production)> | **No** | `undefined` | Filters that the chart will respond to |
| propeller | [Propeller](https://studio.apollographql.com/graph/Propel-API/schema/reference/enums/Propeller?variant=production) | **No** | `undefined` | Propeller that the chart will respond to |
| timestampFormat | `ISO 8601` | **No** | `"MM/dd"` | A string representing the format of the timestamps in the data. Default value is ISO 8601 timestamp |
| timeZone | `ISO 8601` | **No** | `"UTC"` or user's timezone | A string representing the format of of the data's timezone. Default value is local timezone or `UTC` if the local timezone can't be determined. |

## Styles API

Expand Down