Skip to content

Commit

Permalink
Time Range Data ADR
Browse files Browse the repository at this point in the history
Outlines a design plan for creating a Time Range Data widget.
This will display view range and selection range,
and allow the user to edit the selection range using
exact nanosecond timestamps.

Signed-off-by: Will Yang<william.yang@ericsson.com>
  • Loading branch information
williamsyang-work authored and hoangphamEclipse committed Feb 24, 2023
1 parent 6fb9d7d commit 7893c4e
Show file tree
Hide file tree
Showing 5 changed files with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions doc/adr/0008-TimeRangeData-widget.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# 8. Time Range Data Widget

Date: 2023-1-10

## Status

ACCEPTED


## Context

There has been a request for the ability for users to be able to select part of a trace by copy/pasting timestamp data. An attempt was made to implement this feature, but a consensus could not be reached on the UI/UX. Design needs to be agreed upon before any further implementation.

The proposed design is subject to change based on feedback.

### Proposed UX Design

#### UX Flow

A "Time Range Data" widget will be added to the left panel.

![LEFT_PANNEL](./0008/LeftPanel.jpg)

The widget will display: View Start, View End, Selection Start, Selection End.

![WIREFRAME_1](./0008/TRDW_1.png)


Clicking on the Selection Start / End input box displays a Submit and Cancel button. Only the selection start/end will be editable.

![WIREFRAME_2](./0008/TRDW_2.png)

If the selected time is invalid, the user will be notified onSubmit with a red asterisk and warning message at the top. Submit and Cancel buttons will remain visible.

![WIREFRAME_3](./0008/TRDW_3.png)

If the selected time is valid, the selection range will be set and the widget will return to it's initial state.

#### UX Miscellaneous Behaviors
* The view range will not change when the selection range is changed. This includes panning and zooming.
* The time will be displayed in absolute time as nanoseconds, since that is the format users timestamp data will be.

### Architecture Design

In a recent PR the "Item Properties Widget" was refactored to be more compatible with future VSCode implementations. The design of this widget should follow the new architecture.

[Created a widget for properties view in react-components #892](https://github.com/eclipse-cdt-cloud/theia-trace-extension/pull/892/files)

## Decision

This has been approved as outlined above.

## Consequences

Use of left-side panel real estate.
Binary file added doc/adr/0008/LeftPanel.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/adr/0008/TRDW_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/adr/0008/TRDW_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/adr/0008/TRDW_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7893c4e

Please sign in to comment.