docs(api): add specTraversed to API documentation #83
Conversation
This file contains 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
sehilyi
reviewed
Oct 10, 2023
docs/js-api.md
Outdated
| @@ -159,7 +159,7 @@ One of `"mouseOver"`, `"rangeSelect"`, `"click"`, `"rawData"`, `"onNewTrack"`, ` | |||
| id: string | |||
| } | |||
| ``` | |||
| - For `"rawData"`, the `eventData` stores columnar data that has been used internally in Gosling to display the view: | |||
| - For `"rawData"` and `"specTraversed"`, the `eventData` stores columnar data that has been used internally in Gosling to display the view: | |||
There was a problem hiding this comment.
I think a separate sentence or a paragraph to describe the new API will be helpful for users. To clarify, rawData gives users the data that is shown in the visualization and not the user specification.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add documentation for api added with gosling-lang/gosling.js#978