From 54300f31f7ed2e65905c404fa2b63cbd3d937cf5 Mon Sep 17 00:00:00 2001 From: Aaron Plave Date: Tue, 30 Jan 2024 12:05:33 -0800 Subject: [PATCH] Updates --- .../timeline-cursor-interpolation-off.png | 3 ++ .../timeline-cursor-interpolation-on.png | 3 ++ docs/planning/assets/timeline-icon-tray.png | 4 +- docs/planning/timeline-controls.mdx | 40 +++++++++++++------ 4 files changed, 36 insertions(+), 14 deletions(-) create mode 100644 docs/planning/assets/timeline-cursor-interpolation-off.png create mode 100644 docs/planning/assets/timeline-cursor-interpolation-on.png diff --git a/docs/planning/assets/timeline-cursor-interpolation-off.png b/docs/planning/assets/timeline-cursor-interpolation-off.png new file mode 100644 index 0000000..4d52dc5 --- /dev/null +++ b/docs/planning/assets/timeline-cursor-interpolation-off.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:26b0118f0e06719c9a35f9af9395fd89a07a991ff77a7c3f938a65756be18159 +size 16008 diff --git a/docs/planning/assets/timeline-cursor-interpolation-on.png b/docs/planning/assets/timeline-cursor-interpolation-on.png new file mode 100644 index 0000000..c04b7d5 --- /dev/null +++ b/docs/planning/assets/timeline-cursor-interpolation-on.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c4c569b8998834ab7d0bc8ce55291f684d518a873a9ff457017ead265c0c7211 +size 18078 diff --git a/docs/planning/assets/timeline-icon-tray.png b/docs/planning/assets/timeline-icon-tray.png index e94e7d5..0276997 100644 --- a/docs/planning/assets/timeline-icon-tray.png +++ b/docs/planning/assets/timeline-icon-tray.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:bcee22ac48b20d084fa3f9911303aa9d9424a9d231ecd29e29f7316a46f429c3 -size 7842 +oid sha256:e62ac7f42a171343919619594909a35e032ea5b066d7c61943bf0af862e14d2c +size 10003 diff --git a/docs/planning/timeline-controls.mdx b/docs/planning/timeline-controls.mdx index bc5a768..3e3bd2f 100644 --- a/docs/planning/timeline-controls.mdx +++ b/docs/planning/timeline-controls.mdx @@ -1,25 +1,31 @@ +import Link from '@docusaurus/Link'; import timelineIconTray from './assets/timeline-icon-tray.png'; +import timelineInterpolationOff from './assets/timeline-cursor-interpolation-off.png'; +import timelineInterpolationOn from './assets/timeline-cursor-interpolation-on.png'; # Timeline Controls -Here we describe the timeline rendering and interaction options that are not part of the Aerie UI View Above the timeline is a tray of icon buttons that can be used to control how data is rendered and interacted with on the timeline. +Here we describe the timeline rendering and interaction options that are not part of the Aerie UI View. Above the timeline is a tray of icon buttons that can be used to control how data is rendered and interacted with on the timeline.
Aerie UI - Timeline Icon Tray +
Figure 1: Aerie UI - Timeline Icon Tray
The following controls are available: -- `Auto Scroll to Offscreen Selections` - Automatically scrolls the timline to the selected activity directive or span. This can be helpful when selecting directives or spans from their associated tables. -- `Decimation` - Perform on the fly min-max decimation of line layer points for improved timeline rendering performance. Learn more about decimation below. -- `Cursor Value Interpolation` - Show interpolated value when hovering over resources. Learn more about interpolation below. -- `Limit Tooltip to Line` - When enabled, the timeline tooltip will only appear when hovering near a resource line segment. When disabled, the tooltip will appear when hovering over any part of a resource layer. -- `Timeline Tooltip Visibility` - Toggle timeline tooltip visibility. -- `Timeline Modes` - Toggle between `Pan & Zoom` and `Interaction` modes. Learn more about timeline modes below. -- `Time Step` - Slide the time view window to forwards and backwards. -- `Zoom` - Zoom in and out of the plan time window. -- `Copy URL` - Copy URL including plan, visible time window, selection, and simulation dataset to clipboard. -- `Drag Activities` - Enables dragging of activity directives in the timeline. +1. `Auto Scroll to Offscreen Selections` - Automatically scrolls the timline to the selected activity directive or span. This can be helpful when selecting directives or spans from their associated tables. +2. `Decimation` - Perform on the fly min-max decimation of line layer points for improved timeline rendering performance. Learn more about decimation below. +3. `Cursor Value Interpolation` - Show interpolated value when hovering over resources. Learn more about interpolation below. +4. `Toggle Activity Directive Visibility` - Toggles activity directive visibility on all timeline rows. +5. `Limit Tooltip to Line` - When enabled, the timeline tooltip will only appear when hovering near a resource line segment. When disabled, the tooltip will appear when hovering over any part of a resource layer. +6. `Timeline Tooltip Visibility` - Toggle timeline tooltip visibility. +7. `Timeline Modes` - Toggle between `Pan & Zoom` and `Interaction` modes. Learn more about timeline modes below. +8. `Time Step` - Slide the time view window to forwards and backwards. +9. `Zoom` - Zoom in and out of the plan time window. +10. `Copy URL` - Copy URL including plan, visible time window, selection, and simulation dataset to clipboard. +11. `Drag Activities` - Enables dragging of activity directives in the timeline. +12. `Timeline Options Menu` - Displays timeline controls with additional information. ## Line Layer Decimation @@ -27,7 +33,17 @@ Decimation can be enabled on the Aerie timeline in order to more peformantly ren ## Cursor Value Interpolation -Aerie will display a tooltip with resource values when you hover over a line plot. By default, Aerie will select the nearest point to your cursor position. If Cursor Value Interpolation is enabled, Aerie will display a linearly interpolated value in the tooltip based on the two points neigboring your cursor's time position. +Aerie will display a tooltip with resource values when you hover over a line plot. By default, Aerie will select the nearest point to your cursor position as shown in Figure 2. If Cursor Value Interpolation is enabled, Aerie will display a linearly interpolated value in the tooltip based on the two points neigboring your cursor's time position, as shown in Figure 3. The neighboring points used for the interpolation will be indicated by ghosted red triangles. + +
+ Aerie UI - Timeline Cursor Value Interpolation Off +
Figure 2: Aerie UI - Timeline Cursor Value Interpolation Off
+
+ +
+ Aerie UI - Timeline Cursor Value Interpolation On +
Figure 3: Aerie UI - Timeline Cursor Value Interpolation On
+
## Timeline Modes