From d161817ca3ec8db844df9fa2d218fe8587e7e34b Mon Sep 17 00:00:00 2001 From: Kyle Brandt Date: Sun, 13 Nov 2022 09:47:36 -0500 Subject: [PATCH 1/2] Contract Docs: (Chore) Some linting and timestamp formating for heatmap --- data/contract_docs/contract.md | 20 +++++++++--------- data/contract_docs/heatmap.md | 37 +++++++++++++++------------------- 2 files changed, 25 insertions(+), 32 deletions(-) diff --git a/data/contract_docs/contract.md b/data/contract_docs/contract.md index db7059913..f728846e6 100644 --- a/data/contract_docs/contract.md +++ b/data/contract_docs/contract.md @@ -15,19 +15,17 @@ There are logical **_kinds_** (like Time Series Data, Numeric, Histogram, etc), A **_data type_** definition or declaration in this framework includes both a kind and format. For example, "TimeSeriesWide" is: kind: "Time Series", format: "Wide". * [Time series](./timeseries.md) - * [Wide](./timeseries.md#time-series-wide-format-timeserieswide) - * [Long](./timeseries.md#time-series-long-format-timeserieslong-sql-like) - * [Multi](./timeseries.md#time-series-multi-format-timeseriesmulti) + * [Wide](./timeseries.md#time-series-wide-format-timeserieswide) + * [Long](./timeseries.md#time-series-long-format-timeserieslong-sql-like) + * [Multi](./timeseries.md#time-series-multi-format-timeseriesmulti) * [Numeric](./numeric.md) - * [Wide](./numeric.md#numeric-wide-format-numericwide) - * [Multi](./numeric.md#numeric-multi-format-numericmulti) - * [Long](./numeric.md#numeric-many-format-numericlong) + * [Wide](./numeric.md#numeric-wide-format-numericwide) + * [Multi](./numeric.md#numeric-multi-format-numericmulti) + * [Long](./numeric.md#numeric-many-format-numericlong) * [Heatmap](./heatmap.md) - * [Buckets](./heatmap.md#heatmap-buckets-heatmapbuckets) - * [Scanlines](./heatmap.md#heatmap-scanlines-heatmapscanlines) - * [Sparse](./heatmap.md#heatmap-sparse-heatmapsparse) - - + * [Buckets](./heatmap.md#heatmap-buckets-heatmapbuckets) + * [Scanlines](./heatmap.md#heatmap-scanlines-heatmapscanlines) + * [Sparse](./heatmap.md#heatmap-sparse-heatmapsparse) ## Dimensional Set Based Kinds diff --git a/data/contract_docs/heatmap.md b/data/contract_docs/heatmap.md index 8f55365db..83a053a4a 100644 --- a/data/contract_docs/heatmap.md +++ b/data/contract_docs/heatmap.md @@ -1,10 +1,8 @@ -# Heatmap +# Heatmap Status: EARLY Draft/Proposal -Heatmaps are used to show the magnitude of a phenomenon as color in two dimensions. The variation in color -may give visual cues about how the phenomenon is clustered or varies over space. - +Heatmaps are used to show the magnitude of a phenomenon as color in two dimensions. The variation in color may give visual cues about how the phenomenon is clustered or varies over space. ## Heatmap buckets (HeatmapBuckets) @@ -51,30 +49,28 @@ Example: - 1653416391000 + 2022-05-24 18:19:51 6 7 8 - 1653416391000 + 2022-05-24 18:19:51 6 7 8 - 1653416391000 + 2022-05-24 18:19:51 6 7 8 - Note: [Timeseries wide](./timeseries.md#time-series-wide-format-timeserieswide) can be used directly as heatmap-buckets, in this case each value field becomes a row in the heatmap. - ## Heatmap scanlines (HeatmapScanlines) In this format, each row in the frame indicates the value of a single cell in a heatmap. @@ -116,21 +112,21 @@ There exists a row for every cell in the heatmap. - 1653416391000 + 2022-05-24 18:19:51 100 1 1 1 - 1653416391000 + 2022-05-24 18:19:51 200 2 2 2 - 1653416391000 + 2022-05-24 18:19:51 300 3 3 @@ -138,21 +134,21 @@ There exists a row for every cell in the heatmap. - 1653416392000 + 2022-05-24 18:19:52 100 4 4 4 - 1653416392000 + 2022-05-24 18:19:52 200 5 5 5 - 1653416392000 + 2022-05-24 18:19:52 300 6 6 @@ -166,11 +162,11 @@ Note that multiple "value" fields can included to represent multiple dimensions The first value field is used in the display, unless explicilty configured The field names for yMax|yMin|y indicate the aggregation period or the supplied values. + * yMax: the values are from the bucket below * yMin: the values are from to bucket above * y: the values are in the middle of the bucket - ## Heatmap sparse (HeatmapSparse) This format is simplar to Heatmap scanlines, except that each cell is independent from its adjacent values. @@ -178,7 +174,6 @@ Unlike scanlines, this allows resolutions to change over time. Where scanline ha Example: - - - + + - - + + From 980dcb4e5d6df4d5dfee407e45eb45daa9b80fdd Mon Sep 17 00:00:00 2001 From: Kyle Brandt Date: Sun, 13 Nov 2022 10:00:41 -0500 Subject: [PATCH 2/2] Update data/contract_docs/heatmap.md oops --- data/contract_docs/heatmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/contract_docs/heatmap.md b/data/contract_docs/heatmap.md index 83a053a4a..9a4d0904d 100644 --- a/data/contract_docs/heatmap.md +++ b/data/contract_docs/heatmap.md @@ -216,7 +216,7 @@ Example: - +
@@ -213,15 +208,15 @@ Example:
165341639100016534163920002022-05-24 18:19:512022-05-24 18:19:52 100 200 1
165341639200016534163930002022-05-24 18:19:522022-05-24 18:19:52 200 400 2
2022-05-24 18:19:522022-05-24 18:19:522022-05-24 18:19:53 200 400 2