Add Annotation and Comment Features for Collaborative Analysis

[cliftonc]

Summary

Enable users to add annotations to specific data points, time periods, or chart elements, and collaborate through threaded comments on dashboards and visualizations.

Current State

No annotation or comment functionality. Users cannot add context or collaborate within the analytics interface.

Proposed Features

Point Annotations

<ChartWithAnnotations
  annotations={[
    {
      type: 'point',
      dimension: 'Sales.date',
      value: '2024-03-15',
      label: 'Marketing campaign launched',
      icon: 'rocket'
    }
  ]}
/>

Types:

• Point Annotation: Mark specific data points
• Range Annotation: Highlight time periods or value ranges
• Threshold Lines: Show target/goal lines
• Text Notes: Free-form notes on charts

Dashboard Comments

<CommentThread
  targetId="portlet-123"
  targetType="portlet"
  allowMentions={true}
  notifyOnReply={true}
/>

Features:

• Threaded discussions on dashboards and portlets
• @Mentions to tag team members
• Resolve/unresolve comment threads
• Email notifications for mentions/replies

Visibility Controls

• Show/hide annotations per user preference
• Public vs. private annotations
• Role-based visibility (admin-only annotations)

Export Integration

• Include annotations in PDF/image exports
• Export comments as report appendix

Competitor Reference

• Pyramid Analytics: "Comments and annotations within analytic reports serve as a powerful, ubiquitous collaboration tool"
• Sigma Computing: "Add comments and annotations directly within reports"
• Luzmo: "Fuel collaboration with alerts, comments, dashboard sharing"

Technical Approach

1. Create Annotation and Comment data models
2. Build AnnotationOverlay component for chart integration
3. Add CommentThread component for discussions
4. Implement notification system for mentions
5. Store annotations/comments in server with REST API

Data Models

interface Annotation {
  id: string
  dashboardId: string
  portletId?: string
  type: 'point' | 'range' | 'threshold' | 'text'
  target: { dimension: string; value: any }
  content: string
  createdBy: string
  createdAt: Date
}

interface Comment {
  id: string
  parentId?: string // For threading
  targetType: 'dashboard' | 'portlet' | 'annotation'
  targetId: string
  content: string
  mentions: string[]
  resolved: boolean
  createdBy: string
  createdAt: Date
}

Labels

enhancement feature-request client collaboration

[last-light]

This issue has had no activity for 95 days. If it's still relevant, a comment confirming priority would help. Otherwise it will be closed in 30 days.

[last-light]

This issue has been open since January with no recent activity. If it's still on the roadmap, a brief status update or prioritization note would help. If it's been superseded or deferred, feel free to close it.

I'm a bot. This is an automated stale check.