Skip to content

Conversation

@saikumarvasa100-hash
Copy link

Related Ticket: #1929

Description of Changes

This PR adds comprehensive JSDoc documentation to the E&A (Explore and Analyze) embed mode implementation, as requested in issue #1929.

Files Updated:

  1. atoms/embed.ts - Added file-level documentation and JSDoc comments for:

    • hydrateBoolean function
    • dehydrateBoolean function
    • isEmbeddedAtom export
  2. atoms/center.ts - Added file-level documentation and JSDoc comments for:

    • DEFAULT_CENTER constant
    • hydrateCenter function
    • dehydrateCenter function
    • centerAtom export
  3. atoms/zoom.ts - Added file-level documentation and JSDoc comments for:

    • DEFAULT_ZOOM constant
    • hydrateZoom function
    • dehydrateZoom function
    • zoomAtom export
  4. embed-exploration.tsx - Added file-level documentation and JSDoc comments for:

    • Carto styled component
    • BaseTimelineContainer styled component
    • CompareTimelineContainer styled component
    • EmbeddedExplorationProps interface
    • EmbeddedExploration component
    • EmbeddedLayersExplorationProps interface
    • getDataLayer helper function
    • EmbeddedLayersExploration component
  5. components/embed-exploration/embed-timeline.tsx - Added file-level documentation and JSDoc comments for:

    • TimelineWrapper styled component
    • EmbedTimelineProps interface
    • getCalendarView helper function
    • EmbedTimeline component

Notes & Questions About Changes

  • All JSDoc comments follow standard JSDoc format with @fileoverview, @module, @param, @returns, @component, and @example tags where appropriate
  • Interface properties are documented with inline JSDoc comments
  • The documentation explains the purpose and functionality of each module in the context of the embed mode feature

Validation / Testing

  • Documentation changes only - no functional changes to the code
  • JSDoc comments can be verified by viewing the files in the diff

This module manages the embed mode feature for URL parameter synchronization, allowing the exploration view to render a minimal interface for embedding.
Updated the center atom to improve URL parameter synchronization and added detailed documentation for functions.
This module manages the map zoom level in the E&A exploration view, syncing it with URL parameters for deep linking and sharing.
Added detailed JSDoc comments for the EmbeddedExploration and EmbeddedLayersExploration components, including descriptions for props and functionality.
Added documentation and styled wrapper for the EmbedTimeline component.
@netlify
Copy link

netlify bot commented Nov 26, 2025

👷 Deploy request for veda-ui pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit d4b4a69

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant