From 3ae9a76ac7c845cea7127e834ef5ca3e21a06fd4 Mon Sep 17 00:00:00 2001 From: Christine Belzie Date: Sat, 16 Sep 2023 22:44:34 -0400 Subject: [PATCH] feat: add documentation about timezone feature --- .../src/components/TimeSeries/README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/packages/ui-kit/src/components/TimeSeries/README.md b/packages/ui-kit/src/components/TimeSeries/README.md index 2272d218..2c6f1553 100644 --- a/packages/ui-kit/src/components/TimeSeries/README.md +++ b/packages/ui-kit/src/components/TimeSeries/README.md @@ -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