docs: add JSDoc comments to E&A embed mode implementation#1931
Closed
saikumarvasa100-hash wants to merge 5 commits intoNASA-IMPACT:mainfrom
Closed
docs: add JSDoc comments to E&A embed mode implementation#1931saikumarvasa100-hash wants to merge 5 commits intoNASA-IMPACT:mainfrom
saikumarvasa100-hash wants to merge 5 commits intoNASA-IMPACT:mainfrom
Conversation
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.
👷 Deploy request for veda-ui pending review.Visit the deploys page to approve it
|
6 tasks
Contributor
|
@saikumarvasa100-hash thanks for adding this documentation. Your branch has diverged from main, can you please merge branch pd-1931 into it so we can merge to main? |
vgeorge
added a commit
that referenced
this pull request
Dec 9, 2025
Add JSDoc documentation to public API exports for the new view mode system, following existing patterns in the codebase. Documents: - viewModeAtom and ViewMode type - ExplorationAndAnalysisSimpleView and ExplorationAndAnalysisDefaultView - TimelineSimpleView component - Container routing logic Supersedes JSDoc work from #1931 after file restructuring.
Contributor
|
Closing this PR as we moved files around and pulled JSDocs into this follow on PR to the E&A embed: #1950 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
atoms/embed.ts - Added file-level documentation and JSDoc comments for:
hydrateBooleanfunctiondehydrateBooleanfunctionisEmbeddedAtomexportatoms/center.ts - Added file-level documentation and JSDoc comments for:
DEFAULT_CENTERconstanthydrateCenterfunctiondehydrateCenterfunctioncenterAtomexportatoms/zoom.ts - Added file-level documentation and JSDoc comments for:
DEFAULT_ZOOMconstanthydrateZoomfunctiondehydrateZoomfunctionzoomAtomexportembed-exploration.tsx - Added file-level documentation and JSDoc comments for:
Cartostyled componentBaseTimelineContainerstyled componentCompareTimelineContainerstyled componentEmbeddedExplorationPropsinterfaceEmbeddedExplorationcomponentEmbeddedLayersExplorationPropsinterfacegetDataLayerhelper functionEmbeddedLayersExplorationcomponentcomponents/embed-exploration/embed-timeline.tsx - Added file-level documentation and JSDoc comments for:
TimelineWrapperstyled componentEmbedTimelinePropsinterfacegetCalendarViewhelper functionEmbedTimelinecomponentNotes & Questions About Changes
@fileoverview,@module,@param,@returns,@component, and@exampletags where appropriateValidation / Testing