influxdata / influxdata/giraffe

Annotations: Render an annotation range [optionally: with note]

Open
#346 1 comment 0 reactions 0 assignees View on GitHub
team/ui
Dominant language
TypeScript
Stars
189
Forks
33
Avg merge
3d 15h
Merged PRs (30d)
4

Description

### Background
See #377 - the first part of this.

#### The product requirements of the UI are:
- Annotations inherit their display color from the stream they are a part of
- Annotations should be drawn on top of the visualization to ensure mouse interactions with them are not interrupted
- Tooltip should contain timestamp (of that line), the summary text, (if it exists) the message text, and an edit button

### Acceptance Criteria
- Ranges should be shaded/colored in
- Shade the area between the lines with the same color as the lines in low opacity (10%? TBD)
- ~~Hovering over the range displays a tooltip aligned to the mouse~~ <---- covered by a separate issue
- Clicking the edit button opens the edit overlay (this part might not need to exist in giraffe specifically)
- The tooltip should be rendered by giraffe, but the content might need to be injectable by the application (in the case of the ui providing an edit button)
- Annotations layers should accept a single color

Contributor guide

Open the contributing guide

Research direction

Start by reviewing issue #377 and the existing annotation-layer and tooltip behavior in Giraffe; the payload names no specific files or tests. Confirm how stream colors and annotation ranges are represented, then implement shaded ranges and injectable tooltip content with edit-button support. Done means ranges render above the visualization with the stream color and the listed tooltip and edit behavior works.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
data-visualization
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.